mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: "Enrico Jörns" <ejo@pengutronix.de>
To: barebox@lists.infradead.org
Cc: "Enrico Jörns" <ejo@pengutronix.de>
Subject: [PATCH 1/2] Documentation: bootchooser: fix grammar and wording for 'attempts_locked'
Date: Fri, 20 Feb 2026 09:50:54 +0100	[thread overview]
Message-ID: <20260220085130.1326621-1-ejo@pengutronix.de> (raw)

* 'variable in the bootstate' is undefined -> replace
* fix and rephrase 'use case' sentence
* fix and rephrase 'trade-off' sentence
* Add missing period after 'avoid this behavior'
* Avoid unclear 'to boot if any'
* fix typo, remove excess whitespace

Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
---
 Documentation/user/bootchooser.rst | 26 ++++++++++++++------------
 1 file changed, 14 insertions(+), 12 deletions(-)

diff --git a/Documentation/user/bootchooser.rst b/Documentation/user/bootchooser.rst
index 360305e92e..b38bae2c23 100644
--- a/Documentation/user/bootchooser.rst
+++ b/Documentation/user/bootchooser.rst
@@ -88,21 +88,23 @@ variable.
 
 Alternatively, counting down the remaining attempts can be disabled by
 locking bootchooser boot attempts.
-This is done by defining a (32-bit) ``attempts_locked`` variable in the
-bootstate and setting its value to ``1`` (usually from userspace).
+This is done by defining a (32-bit) ``attempts_locked`` run-time variable and
+setting its value to ``1`` (usually from userspace).
 
-In scenarios where the system is rebootet too frequently (after the ``remaining_attempts``
-counter is decremented, but before it got incremented again after a successful boot) and falls
-back to the other boot target, the ``attempts_locked`` variable can be used to avoid this behavior
+In scenarios where the system is rebooted too frequently (after the ``remaining_attempts``
+counter is decremented, but before it got incremented again after a successful boot), it can unintentionally fall
+back to the other boot target.
+The ``attempts_locked`` variable can be used to avoid this behavior.
 Bootchooser is prevented from decrementing the ``remaining_attempts`` counter and falling back
-to the other target. It comes with the trade-off that a slot, that becomes broken
-over time, it won't be detected anymore and will be booted indefinitely.
+to the other target. It comes with the trade-off that a slot that becomes broken
+over time will no longer be detected as such and will be booted indefinitely.
 
 The variable affects all targets, is optional and its absence is
 interpreted as ``0``, meaning that attempts are decremented normally.
 
-The ``attempts_locked`` value does not influence the decision on which target
-to boot if any, only whether to decrement the attempts when booting.
+The ``attempts_locked`` variable does not influence which boot target is
+selected, only whether its ``remaining_attempts`` counter is decremented when
+booting.
 
 If :ref:`global.bootchooser.retry <magicvar_global_bootchooser_retry>`
 is enabled (set to ``1``), the bootchooser
@@ -134,12 +136,12 @@ on the :ref:`reset reason <reset_reason>` (i.e. != WDG) using the
 This will reset the ``remaining_attempts`` counter of the *last chosen* slot to
 its default value (``reset_attempts``).
 
-Another option is to use ``attempts_locked``. Normally this should be controlled from
+An additional option is to use ``attempts_locked``. Normally this should be controlled from
 Linux userspace using the *barebox-state* tool, i.e.::
 
-  barebox-state -s  bootstate.attempts_locked=1
+  barebox-state -s bootstate.attempts_locked=1
 
-It can also be locked via the :ref:`bootchooser command <command_bootchooser>`::
+It can also be locked from barebox via the :ref:`bootchooser command <command_bootchooser>`::
 
   bootchooser -l
 
-- 
2.47.3




             reply	other threads:[~2026-02-20  8:53 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-20  8:50 Enrico Jörns [this message]
2026-02-20  8:50 ` [PATCH 2/2] Documentation: bootchooser: move attempts locking to own section Enrico Jörns

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260220085130.1326621-1-ejo@pengutronix.de \
    --to=ejo@pengutronix.de \
    --cc=barebox@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox