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

["Burakov, Anatoly" <anatoly.burakov@intel.com>]

On 5/14/2025 3:26 PM, Bruce Richardson wrote:
> On Wed, May 14, 2025 at 02:02:11PM +0100, Anatoly Burakov wrote:
>> Most testpmd help strings are lower case. Amend those that aren't.
>>
>> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
>> ---
>>   app/test-pmd/cmdline.c    |  4 ++--
>>   app/test-pmd/cmdline_tm.c | 36 ++++++++++++++++++------------------
>>   2 files changed, 20 insertions(+), 20 deletions(-)
>>
>> diff --git a/app/test-pmd/cmdline.c b/app/test-pmd/cmdline.c
>> index d4bb3ec998..a8f1b8ad67 100644
>> --- a/app/test-pmd/cmdline.c
>> +++ b/app/test-pmd/cmdline.c
>> @@ -8078,7 +8078,7 @@ static cmdline_parse_token_string_t cmd_operate_set_counter_name =
>>   static cmdline_parse_inst_t cmd_operate_set_counter = {
>>   	.f = cmd_operate_set_counter_parsed,
>>   	.data = NULL,
>> -	.help_str = "port (port_id) enable|disable <counter_name>",
>> +	.help_str = "port <port_id> enable|disable <counter_name>",
>>   	.tokens = {
>>   		(void *)&cmd_operate_set_counter_port,
>>   		(void *)&cmd_operate_set_counter_port_id,
>> @@ -9034,7 +9034,7 @@ static cmdline_parse_token_string_t cmd_dump_dump =
>>   static cmdline_parse_inst_t cmd_dump = {
>>   	.f = cmd_dump_parsed,  /* function to call */
>>   	.data = NULL,      /* 2nd arg of func */
>> -	.help_str = "Dump status",
>> +	.help_str = "dump status",
>>   	.tokens = {        /* token list, NULL terminated */
>>   		(void *)&cmd_dump_dump,
>>   		NULL,
>> diff --git a/app/test-pmd/cmdline_tm.c b/app/test-pmd/cmdline_tm.c
>> index 7ade91549c..acf86c1ef0 100644
>> --- a/app/test-pmd/cmdline_tm.c
>> +++ b/app/test-pmd/cmdline_tm.c
>> @@ -327,7 +327,7 @@ static void cmd_show_port_tm_cap_parsed(void *parsed_result,
>>   cmdline_parse_inst_t cmd_show_port_tm_cap = {
>>   	.f = cmd_show_port_tm_cap_parsed,
>>   	.data = NULL,
>> -	.help_str = "Show Port TM Capabilities",
>> +	.help_str = "show port tm capabilities",
> 
> Not so certain about this change. Should acronyms like "TM" not be
> capitalised, to make it clear they are not normal words?
> 

Most instances of the same are already lowercase, so if we want to TM to 
be upper case, it's not just these instances that will need to be fixed. 
Also, help messages are pretty consistently lower case for all types of 
commands, so I'm not sure if making TM stand out would be better. I have 
no preference over which it is, it's just that ordering is case 
sensitive (at least when using strcmp - do we have a case-insensitive 
compare?) so some things may be ordered in a counter-intuitive way.

> /Bruce
> 


-- 
Thanks,
Anatoly