Skip to contentSkip to conversation

doc: api: bootcount: correct bootcount description

PATCH New [email protected] 1 participant 1 message Apr 6

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: api: bootcount: correct bootcount description

From: Michael Opdenacker <[email protected]>

The bootcount variable is only incremented when the upgrade_variable is non-zero,
as implemented in drivers/bootcount/bootcount_env.c

---
 doc/api/bootcount.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/api/bootcount.rst +1 -1
index 968c679c3c6..f3c10bbe724 100644
@@ -8,7 +8,7 @@ This is enabled by CONFIG_BOOTCOUNT_LIMIT.
 This allows to detect multiple failed attempts to boot Linux.
 
 After a power-on reset, the ``bootcount`` variable will be initialized to 1, and
-each reboot will increment the value by 1.
+when ``upgrade_available`` is non-zero, each reboot will increment the value by 1.
 
 If, after a reboot, the new value of ``bootcount`` exceeds the value of
 ``bootlimit``, then instead of the standard boot action (executing the contents