Skip to content

Commit

Permalink
docs/reference: document slot status file's 'status' information
Browse files Browse the repository at this point in the history
Signed-off-by: Enrico Joerns <[email protected]>
  • Loading branch information
ejoerns committed Dec 2, 2024
1 parent ec6ef3d commit 18dbe84
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1231,6 +1231,13 @@ and ``bundle.build`` are copies of the respective manifest properties.
More information can be found in this :ref:`subsection <sec-manifest-update>` of
section :ref:`Manifest <sec_ref_manifest>`.

The ``status`` field records the status of each slot.
It can have the following values:

:ok: The latest updated for this slot succeeded. Its content should be valid.
:failed: The latest update for this slot failed. There is no valid content on it.
:pending: The slot is currently being updated. There is no valid content on it, yet.

For a description of ``sha256`` and ``size`` keys see :ref:`this
<image-section>` part of the section :ref:`Manifest
<sec_ref_manifest>`.
Expand Down

0 comments on commit 18dbe84

Please sign in to comment.