netdev - Re: [PATCH ethtool-next 3/5] separate FLAGS out in -h

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <31713271-964d-42cb-9d27-2e111c818a12@intel.com>
Date:   Wed, 23 Sep 2020 17:12:01 -0700
From:   Jacob Keller <jacob.e.keller@...el.com>
To:     Jakub Kicinski <kuba@...nel.org>, mkubecek@...e.cz
Cc:     netdev@...r.kernel.org
Subject: Re: [PATCH ethtool-next 3/5] separate FLAGS out in -h



On 9/15/2020 4:52 PM, Jakub Kicinski wrote:
> Help output is quite crowded already with every command
> being prefixed by --debug and --json options, and we're
> about to add a third one.
> 
> Add an indirection.
> 
> Signed-off-by: Jakub Kicinski <kuba@...nel.org>

Seems reasonable to me.

Reviewed-by: Jacob Keller <jacob.e.keller@...el.com>

> ---
>  ethtool.c | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff --git a/ethtool.c b/ethtool.c
> index 23ecfcfd069c..ae5310e9e306 100644
> --- a/ethtool.c
> +++ b/ethtool.c
> @@ -5947,10 +5947,10 @@ static int show_usage(struct cmd_context *ctx __maybe_unused)
>  	fprintf(stdout, PACKAGE " version " VERSION "\n");
>  	fprintf(stdout,
>  		"Usage:\n"
> -		"        ethtool [ --debug MASK ][ --json ] DEVNAME\t"
> +		"        ethtool [ FLAGS ] DEVNAME\t"
>  		"Display standard information about device\n");
>  	for (i = 0; args[i].opts; i++) {
> -		fputs("        ethtool [ --debug MASK ][ --json ] ", stdout);
> +		fputs("        ethtool [ FLAGS ] ", stdout);
>  		fprintf(stdout, "%s %s\t%s\n",
>  			args[i].opts,
>  			args[i].no_dev ? "\t" : "DEVNAME",
> @@ -5959,7 +5959,10 @@ static int show_usage(struct cmd_context *ctx __maybe_unused)
>  			fputs(args[i].xhelp, stdout);
>  	}
>  	nl_monitor_usage();
> -	fprintf(stdout, "Not all options support JSON output\n");
> +	fprintf(stdout, "\n");
> +	fprintf(stdout, "FLAGS:\n");
> +	fprintf(stdout, "	--debug MASK	turn on debugging messages\n");
> +	fprintf(stdout, "	--json		enable JSON output format (not supported by all commands)\n");
>  

Not really related to this patch, but what is the behavior of a command
when --json is used but it doesn't support it?

Thanks,
Jake

>  	return 0;
>  }
>