[PATCH v2] common: add help text for CONFIG_STATE

[PATCH v2] common: add help text for CONFIG_STATE

[Ahmad Fatoum]

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

Signed-off-by: Ahmad Fatoum <a.fatoum@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


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: [PATCH v2] common: add help text for CONFIG_STATE

[Sascha Hauer]

On Thu, Jun 09, 2022 at 08:09:23AM +0200, Ahmad Fatoum wrote:
> While we have extensive documentation for state, some sentences in the
> kconfig are a good thing.
> 
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
> ---
> v1 -> v2:
>   - remove reference to barebox TLV until that support is upstreamed.
> ---
>  common/Kconfig | 5 +++++
>  1 file changed, 5 insertions(+)

Applied, thanks

Sascha

> 
> 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
> 
> 
> _______________________________________________
> barebox mailing list
> barebox@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/barebox
> 

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox