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?
/Bruce
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
>
@@ -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,
@@ -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",
.tokens = {
(void *)&cmd_show_port_tm_cap_show,
(void *)&cmd_show_port_tm_cap_port,
@@ -475,7 +475,7 @@ static void cmd_show_port_tm_level_cap_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_show_port_tm_level_cap = {
.f = cmd_show_port_tm_level_cap_parsed,
.data = NULL,
- .help_str = "Show port TM hierarchical level capabilities",
+ .help_str = "show port tm hierarchical level capabilities",
.tokens = {
(void *)&cmd_show_port_tm_level_cap_show,
(void *)&cmd_show_port_tm_level_cap_port,
@@ -598,7 +598,7 @@ static void cmd_show_port_tm_node_cap_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_show_port_tm_node_cap = {
.f = cmd_show_port_tm_node_cap_parsed,
.data = NULL,
- .help_str = "Show Port TM Hierarchy node capabilities",
+ .help_str = "show port tm Hierarchy node capabilities",
.tokens = {
(void *)&cmd_show_port_tm_node_cap_show,
(void *)&cmd_show_port_tm_node_cap_port,
@@ -716,7 +716,7 @@ static void cmd_show_port_tm_node_stats_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_show_port_tm_node_stats = {
.f = cmd_show_port_tm_node_stats_parsed,
.data = NULL,
- .help_str = "Show port tm node stats",
+ .help_str = "show port tm node stats",
.tokens = {
(void *)&cmd_show_port_tm_node_stats_show,
(void *)&cmd_show_port_tm_node_stats_port,
@@ -795,7 +795,7 @@ static void cmd_show_port_tm_node_type_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_show_port_tm_node_type = {
.f = cmd_show_port_tm_node_type_parsed,
.data = NULL,
- .help_str = "Show port tm node type",
+ .help_str = "show port tm node type",
.tokens = {
(void *)&cmd_show_port_tm_node_type_show,
(void *)&cmd_show_port_tm_node_type_port,
@@ -942,7 +942,7 @@ static void cmd_add_port_tm_node_shaper_profile_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_add_port_tm_node_shaper_profile = {
.f = cmd_add_port_tm_node_shaper_profile_parsed,
.data = NULL,
- .help_str = "Add port tm node private shaper profile",
+ .help_str = "add port tm node private shaper profile",
.tokens = {
(void *)&cmd_add_port_tm_node_shaper_profile_add,
(void *)&cmd_add_port_tm_node_shaper_profile_port,
@@ -1029,7 +1029,7 @@ static void cmd_del_port_tm_node_shaper_profile_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_del_port_tm_node_shaper_profile = {
.f = cmd_del_port_tm_node_shaper_profile_parsed,
.data = NULL,
- .help_str = "Delete port tm node private shaper profile",
+ .help_str = "delete port tm node private shaper profile",
.tokens = {
(void *)&cmd_del_port_tm_node_shaper_profile_del,
(void *)&cmd_del_port_tm_node_shaper_profile_port,
@@ -1390,7 +1390,7 @@ static void cmd_add_port_tm_node_wred_profile_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_add_port_tm_node_wred_profile = {
.f = cmd_add_port_tm_node_wred_profile_parsed,
.data = NULL,
- .help_str = "Add port tm node wred profile",
+ .help_str = "add port tm node wred profile",
.tokens = {
(void *)&cmd_add_port_tm_node_wred_profile_add,
(void *)&cmd_add_port_tm_node_wred_profile_port,
@@ -1483,7 +1483,7 @@ static void cmd_del_port_tm_node_wred_profile_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_del_port_tm_node_wred_profile = {
.f = cmd_del_port_tm_node_wred_profile_parsed,
.data = NULL,
- .help_str = "Delete port tm node wred profile",
+ .help_str = "delete port tm node wred profile",
.tokens = {
(void *)&cmd_del_port_tm_node_wred_profile_del,
(void *)&cmd_del_port_tm_node_wred_profile_port,
@@ -1577,7 +1577,7 @@ static void cmd_set_port_tm_node_shaper_profile_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_set_port_tm_node_shaper_profile = {
.f = cmd_set_port_tm_node_shaper_profile_parsed,
.data = NULL,
- .help_str = "Set port tm node shaper profile",
+ .help_str = "set port tm node shaper profile",
.tokens = {
(void *)&cmd_set_port_tm_node_shaper_profile_set,
(void *)&cmd_set_port_tm_node_shaper_profile_port,
@@ -1744,7 +1744,7 @@ static void cmd_add_port_tm_nonleaf_node_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_add_port_tm_nonleaf_node = {
.f = cmd_add_port_tm_nonleaf_node_parsed,
.data = NULL,
- .help_str = "Add port tm nonleaf node",
+ .help_str = "add port tm nonleaf node",
.tokens = {
(void *)&cmd_add_port_tm_nonleaf_node_add,
(void *)&cmd_add_port_tm_nonleaf_node_port,
@@ -1911,7 +1911,7 @@ static void cmd_add_port_tm_nonleaf_node_pmode_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_add_port_tm_nonleaf_node_pmode = {
.f = cmd_add_port_tm_nonleaf_node_pmode_parsed,
.data = NULL,
- .help_str = "Add port tm nonleaf node pktmode",
+ .help_str = "add port tm nonleaf node pktmode",
.tokens = {
(void *)&cmd_add_port_tm_nonleaf_node_pmode_add,
(void *)&cmd_add_port_tm_nonleaf_node_pmode_port,
@@ -2089,7 +2089,7 @@ static void cmd_add_port_tm_leaf_node_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_add_port_tm_leaf_node = {
.f = cmd_add_port_tm_leaf_node_parsed,
.data = NULL,
- .help_str = "Add port tm leaf node",
+ .help_str = "add port tm leaf node",
.tokens = {
(void *)&cmd_add_port_tm_leaf_node_add,
(void *)&cmd_add_port_tm_leaf_node_port,
@@ -2301,7 +2301,7 @@ static void cmd_del_port_tm_node_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_del_port_tm_node = {
.f = cmd_del_port_tm_node_parsed,
.data = NULL,
- .help_str = "Delete port tm node",
+ .help_str = "delete port tm node",
.tokens = {
(void *)&cmd_del_port_tm_node_del,
(void *)&cmd_del_port_tm_node_port,
@@ -2394,7 +2394,7 @@ static void cmd_set_port_tm_node_parent_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_set_port_tm_node_parent = {
.f = cmd_set_port_tm_node_parent_parsed,
.data = NULL,
- .help_str = "Set port tm node parent",
+ .help_str = "set port tm node parent",
.tokens = {
(void *)&cmd_set_port_tm_node_parent_set,
(void *)&cmd_set_port_tm_node_parent_port,
@@ -2465,7 +2465,7 @@ static void cmd_suspend_port_tm_node_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_suspend_port_tm_node = {
.f = cmd_suspend_port_tm_node_parsed,
.data = NULL,
- .help_str = "Suspend port tm node",
+ .help_str = "suspend port tm node",
.tokens = {
(void *)&cmd_suspend_port_tm_node_suspend,
(void *)&cmd_suspend_port_tm_node_port,
@@ -2530,7 +2530,7 @@ static void cmd_resume_port_tm_node_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_resume_port_tm_node = {
.f = cmd_resume_port_tm_node_parsed,
.data = NULL,
- .help_str = "Resume port tm node",
+ .help_str = "resume port tm node",
.tokens = {
(void *)&cmd_resume_port_tm_node_resume,
(void *)&cmd_resume_port_tm_node_port,
@@ -2602,7 +2602,7 @@ static void cmd_port_tm_hierarchy_commit_parsed(void *parsed_result,
cmdline_parse_inst_t cmd_port_tm_hierarchy_commit = {
.f = cmd_port_tm_hierarchy_commit_parsed,
.data = NULL,
- .help_str = "Commit port tm hierarchy",
+ .help_str = "commit port tm hierarchy",
.tokens = {
(void *)&cmd_port_tm_hierarchy_commit_port,
(void *)&cmd_port_tm_hierarchy_commit_tm,