[PATCH] commands: ethlog: wire up help text

[PATCH] commands: ethlog: wire up help text

[Roland Hieber]

The help text for ethlog currently contains only the short synopsis, but
no explanation what all the options actually do, although that info is
available a few lines further up. It was probably just forgotten to be
included in the command definition.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 commands/ethlog.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/commands/ethlog.c b/commands/ethlog.c
index 7885d32c6b47..21d88bf1cbfb 100644
--- a/commands/ethlog.c
+++ b/commands/ethlog.c
@@ -90,4 +90,5 @@ BAREBOX_CMD_START(ethlog)
 	BAREBOX_CMD_OPTS("[-rp] [device]")
 	BAREBOX_CMD_GROUP(CMD_GRP_NET)
 	BAREBOX_CMD_COMPLETE(eth_complete)
+	BAREBOX_CMD_HELP(cmd_ethlog_help)
 BAREBOX_CMD_END
-- 
2.39.2

Re: [PATCH] commands: ethlog: wire up help text

[Roland Hieber]

On Thu, May 25, 2023 at 05:29:35PM +0200, Roland Hieber wrote:
> The help text for ethlog currently contains only the short synopsis, but
> no explanation what all the options actually do, although that info is
> available a few lines further up. It was probably just forgotten to be
> included in the command definition.

As far as I could see, ethlog was the only (non-trivial) command without
a help text.

 - Roland

> 
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> ---
>  commands/ethlog.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/commands/ethlog.c b/commands/ethlog.c
> index 7885d32c6b47..21d88bf1cbfb 100644
> --- a/commands/ethlog.c
> +++ b/commands/ethlog.c
> @@ -90,4 +90,5 @@ BAREBOX_CMD_START(ethlog)
>  	BAREBOX_CMD_OPTS("[-rp] [device]")
>  	BAREBOX_CMD_GROUP(CMD_GRP_NET)
>  	BAREBOX_CMD_COMPLETE(eth_complete)
> +	BAREBOX_CMD_HELP(cmd_ethlog_help)
>  BAREBOX_CMD_END
> -- 
> 2.39.2
> 
> 

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

Re: [PATCH] commands: ethlog: wire up help text

[Sascha Hauer]

On Thu, May 25, 2023 at 05:29:35PM +0200, Roland Hieber wrote:
> The help text for ethlog currently contains only the short synopsis, but
> no explanation what all the options actually do, although that info is
> available a few lines further up. It was probably just forgotten to be
> included in the command definition.
> 
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> ---
>  commands/ethlog.c | 1 +
>  1 file changed, 1 insertion(+)

Applied, thanks

Sascha

> 
> diff --git a/commands/ethlog.c b/commands/ethlog.c
> index 7885d32c6b47..21d88bf1cbfb 100644
> --- a/commands/ethlog.c
> +++ b/commands/ethlog.c
> @@ -90,4 +90,5 @@ BAREBOX_CMD_START(ethlog)
>  	BAREBOX_CMD_OPTS("[-rp] [device]")
>  	BAREBOX_CMD_GROUP(CMD_GRP_NET)
>  	BAREBOX_CMD_COMPLETE(eth_complete)
> +	BAREBOX_CMD_HELP(cmd_ethlog_help)
>  BAREBOX_CMD_END
> -- 
> 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 |