[PATCH v2] common: add help text for CONFIG_STATE

Ahmad Fatoum a.fatoum at pengutronix.de
Wed Jun 8 23:09:23 PDT 2022


While we have extensive documentation for state, some sentences in the
kconfig are a good thing.

Signed-off-by: Ahmad Fatoum <a.fatoum at pengutronix.de>
---
v1 -> v2:
  - remove reference to barebox TLV until that support is upstreamed.
---
 common/Kconfig | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/common/Kconfig b/common/Kconfig
index f7a6a96e877c..3ff45d6c9d0d 100644
--- a/common/Kconfig
+++ b/common/Kconfig
@@ -1004,6 +1004,11 @@ config STATE
 	select ENVIRONMENT_VARIABLES
 	select OFTREE
 	select PARAMETER
+	help
+	  barebox state is a generic framework for atomic power fail-safe
+	  variable storage and retrieval. It can be used to safely maintain
+	  data over reboots and to exchange information with Linux, e.g.
+	  for redundant boot with bootchooser.
 
 config STATE_CRYPTO
 	bool "HMAC based authentication support"
-- 
2.30.2




More information about the barebox mailing list