Skip to content

Commit 5b93595

Browse files
committed
docs/using: rewrite mark-good/mark-bad user chapter
* Change title to include "marking" (also less passive) * "preserve a slot as being the preferred one to boot" is hard to read and understand * use terms 'good' and 'bad' in the description and refer to what it actually means * add note and link on D-Bus methods * be more explicit about what 'mark-good' typically does and remove passive wording * do the same for 'mark-bad' Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
1 parent cfe8ad8 commit 5b93595

1 file changed

Lines changed: 17 additions & 14 deletions

File tree

docs/using.rst

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -139,31 +139,34 @@ points to the correct directory.
139139
That way, installed artifacts can be found by following
140140
``/run/rauc/artifacts/<repository-name>/<artifact-name>``.
141141

142-
React to a Successfully Booted System/Failed Boot
143-
-------------------------------------------------
142+
Marking a Boot as Successful or Failed
143+
--------------------------------------
144144

145-
Normally, the full system update chain is not complete before being sure that
146-
the newly installed system runs without any errors.
147-
As the definition and detection of a `successful` operation is really
148-
system-dependent, RAUC provides commands to preserve a slot as being the
149-
preferred one to boot or to discard a slot from being bootable.
145+
A system update is only considered complete once the newly installed system has
146+
been confirmed to be running correctly.
147+
Since the definition and detection of a successful boot is system-dependent,
148+
RAUC provides explicit commands and a :ref:`D-Bus Method
149+
<gdbus-method-de-pengutronix-rauc-Installer.Mark>` to mark the booted slot
150+
group as either good (confirmed working) or bad (non-working).
150151

151152
.. code-block:: console
152153
153154
# rauc status mark-good
154155
155-
After verifying that the currently booted system is fully operational, one
156-
wants to signal this information to the underlying bootloader implementation
157-
which then, for example, resets a boot attempt counter.
156+
Once the currently booted system is verified as fully operational, run this
157+
command to signal success to the bootloader.
158+
Depending on the bootloader backend, this typically resets a boot attempt
159+
counter and confirms the current slot as the active one.
160+
158161

159162
.. code-block:: console
160163
161164
# rauc status mark-bad
162165
163-
If the current boot failed in some way, this command can be used to communicate
164-
that to the underlying bootloader implementation.
165-
In most cases this will disable the currently booted slot or at least switch to
166-
a different one.
166+
If the current boot has failed, run this command to signal failure to the
167+
bootloader.
168+
Depending on the bootloader backend, this will either disable the currently
169+
booted slot or switch to a different one.
167170

168171
To maintain consistency with ``rauc status mark-active``, both commands accept
169172
an optional slot argument:

0 commit comments

Comments
 (0)