[PATCH] commands: global: document usage without parameters

[PATCH] commands: global: document usage without parameters

[Roland Hieber]

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 commands/global.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/commands/global.c b/commands/global.c
index cf8e9a5b4894..a8ff5ea18fb0 100644
--- a/commands/global.c
+++ b/commands/global.c
@@ -50,6 +50,7 @@ static int do_global(int argc, char *argv[])
 
 BAREBOX_CMD_HELP_START(global)
 BAREBOX_CMD_HELP_TEXT("Add a new global variable named VAR, optionally set to VALUE.")
+BAREBOX_CMD_HELP_TEXT("Without options, print all global and env (prefixed with *) variables.")
 BAREBOX_CMD_HELP_TEXT("")
 BAREBOX_CMD_HELP_TEXT("Options:")
 BAREBOX_CMD_HELP_OPT("-r", "Remove globalvars")
@@ -58,7 +59,7 @@ BAREBOX_CMD_HELP_END
 BAREBOX_CMD_START(global)
 	.cmd		= do_global,
 	BAREBOX_CMD_DESC("create or set global variables")
-	BAREBOX_CMD_OPTS("[-r] VAR[=VALUE] ...")
+	BAREBOX_CMD_OPTS("[-r] [VAR[=VALUE] ...]")
 	BAREBOX_CMD_GROUP(CMD_GRP_ENV)
 	BAREBOX_CMD_HELP(cmd_global_help)
 	BAREBOX_CMD_COMPLETE(global_complete)
-- 
2.39.2

Re: [PATCH] commands: global: document usage without parameters

[Sascha Hauer]

On Mon, Aug 14, 2023 at 04:11:13PM +0200, Roland Hieber wrote:
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> ---
>  commands/global.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)

Applied, thanks

Sascha

> 
> diff --git a/commands/global.c b/commands/global.c
> index cf8e9a5b4894..a8ff5ea18fb0 100644
> --- a/commands/global.c
> +++ b/commands/global.c
> @@ -50,6 +50,7 @@ static int do_global(int argc, char *argv[])
>  
>  BAREBOX_CMD_HELP_START(global)
>  BAREBOX_CMD_HELP_TEXT("Add a new global variable named VAR, optionally set to VALUE.")
> +BAREBOX_CMD_HELP_TEXT("Without options, print all global and env (prefixed with *) variables.")
>  BAREBOX_CMD_HELP_TEXT("")
>  BAREBOX_CMD_HELP_TEXT("Options:")
>  BAREBOX_CMD_HELP_OPT("-r", "Remove globalvars")
> @@ -58,7 +59,7 @@ BAREBOX_CMD_HELP_END
>  BAREBOX_CMD_START(global)
>  	.cmd		= do_global,
>  	BAREBOX_CMD_DESC("create or set global variables")
> -	BAREBOX_CMD_OPTS("[-r] VAR[=VALUE] ...")
> +	BAREBOX_CMD_OPTS("[-r] [VAR[=VALUE] ...]")
>  	BAREBOX_CMD_GROUP(CMD_GRP_ENV)
>  	BAREBOX_CMD_HELP(cmd_global_help)
>  	BAREBOX_CMD_COMPLETE(global_complete)
> -- 
> 2.39.2
> 
> 
> 

-- 
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 |