[PATCH v2 1/2] app/testpmd: harmonize case in help strings

Burakov, Anatoly anatoly.burakov at intel.com
Thu May 29 17:57:29 CEST 2025


On 5/26/2025 4:52 PM, Stephen Hemminger wrote:
> On Fri, 23 May 2025 11:36:04 +0100
> Anatoly Burakov <anatoly.burakov at intel.com> wrote:
> 
>> Most testpmd help strings are lower case. Amend those that aren't.
>>
>> Signed-off-by: Anatoly Burakov <anatoly.burakov at intel.com>
> 
> Why does DPDK not follow the convention used for years by the Unix
> man pages and commands? The Unix command description style is to use
> upper case for items in command that are variables.
> 
> 	.help_str = "port PORT_ID enable|disable COUNTER_NAME",
> 
> These strings should match what is in the documentation for examples.
> 
> $ ls --help
> Usage: ls [OPTION]... [FILE]...
> ...
>    -F, --classify[=WHEN]      append indicator (one of */=>@|) to entries WHEN
>        --file-type            likewise, except do not append '*'
>        --format=WORD          across,horizontal (-x), commas (-m), long (-l),
>                               single-column (-1), verbose (-l), vertical (-C)

With respect, this is an entirely different issue that we can address 
separately, that has nothing whatsoever to do with this patchset. The 
only reason I adjusted these strings is because their inconsistent 
casing was screwing up the ordering because strcmp is case sensitive, 
and this patch addresses that issue. After this patch, whatever their 
specific flavor of wrongness, at least strings are consistent and order 
themselves correctly.

I can submit further reworks on this front, but it will have to be a 
separate patchset.

-- 
Thanks,
Anatoly


More information about the dev mailing list