summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEnrico Jorns <ejo@pengutronix.de>2019-02-15 13:53:47 +0100
committerSascha Hauer <s.hauer@pengutronix.de>2019-02-18 14:26:27 +0100
commitfd51d78b85dc241a6d59c803136973c80108ed36 (patch)
tree5bea20d89dc40497b6d781ffc7d1f0b4af8780e7
parent2b21c973876587dfa012a2ed892c6786cecec09a (diff)
downloadbarebox-fd51d78b85dc241a6d59c803136973c80108ed36.tar.gz
doc: bootchooser: add details about bootchooser.reset_attempts handling
For understanding and correctly using the algorith it is useful to know when the values are evaluated. Signed-off-by: Enrico Jorns <ejo@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
-rw-r--r--Documentation/user/bootchooser.rst12
1 files changed, 7 insertions, 5 deletions
diff --git a/Documentation/user/bootchooser.rst b/Documentation/user/bootchooser.rst
index 00ce896..ad80975 100644
--- a/Documentation/user/bootchooser.rst
+++ b/Documentation/user/bootchooser.rst
@@ -88,11 +88,13 @@ controlled by the ``global.bootchooser.reset_attempts`` variable. It holds a
list of space-separated flags. Possible values are:
- empty: counters will never be reset
-- ``power-on``: The ``remaining_attempts`` counters of all enabled boot targets are reset
- after a ``power-on`` reset (``$global.system.reset="POR"``). This means after a power
- cycle all boot targets will be tried again for the configured number of retries.
-- ``all-zero``: The ``remaining_attempts`` counters of all enabled boot targets are
- reset when none of them has any ``remaining_attempts`` left.
+- ``power-on``: When the bootchooser starts and a power-on reset
+ (``$global.system.reset="POR"``) is detected, the ``remaining_attempts``
+ counters of all enabled targets are reset to their defaults.
+ This means after a power cycle all boot targets will be tried again for the configured number of retries.
+- ``all-zero``: When the bootchooser starts and the ``remaining_attempts``
+ counters of all enabled targets are zero, the ``remaining_attempts``
+ counters of all enabled targets are reset to their defaults.
Marking a Boot as Successful
############################