DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Burakov, Anatoly" <anatoly.burakov@intel.com>
To: Stephen Hemminger <stephen@networkplumber.org>
Cc: <dev@dpdk.org>, Aman Singh <aman.deep.singh@intel.com>,
	"Cristian Dumitrescu" <cristian.dumitrescu@intel.com>
Subject: Re: [PATCH v2 1/2] app/testpmd: harmonize case in help strings
Date: Thu, 29 May 2025 17:57:29 +0200	[thread overview]
Message-ID: <403c2595-c803-40a4-9a27-7e750bc82a6a@intel.com> (raw)
In-Reply-To: <20250526075243.20d0b358@hermes.local>

On 5/26/2025 4:52 PM, Stephen Hemminger wrote:
> On Fri, 23 May 2025 11:36:04 +0100
> Anatoly Burakov <anatoly.burakov@intel.com> wrote:
> 
>> Most testpmd help strings are lower case. Amend those that aren't.
>>
>> Signed-off-by: Anatoly Burakov <anatoly.burakov@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

      reply	other threads:[~2025-05-29 15:57 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-14 13:02 [PATCH v1 " Anatoly Burakov
2025-05-14 13:02 ` [PATCH v1 2/2] app/testpmd: sort commands by help string Anatoly Burakov
2025-05-14 13:29   ` Bruce Richardson
2025-05-21 22:24   ` Stephen Hemminger
2025-05-23 10:19     ` Burakov, Anatoly
2025-05-23 10:09   ` Anatoly Burakov
2025-05-14 13:26 ` [PATCH v1 1/2] app/testpmd: harmonize case in help strings Bruce Richardson
2025-05-15 11:07   ` Burakov, Anatoly
2025-05-23 10:09 ` Anatoly Burakov
2025-05-23 10:36 ` [PATCH v2 " Anatoly Burakov
2025-05-23 10:36   ` [PATCH v2 2/2] app/testpmd: sort commands by help string Anatoly Burakov
2025-05-26 14:52   ` [PATCH v2 1/2] app/testpmd: harmonize case in help strings Stephen Hemminger
2025-05-29 15:57     ` Burakov, Anatoly [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=403c2595-c803-40a4-9a27-7e750bc82a6a@intel.com \
    --to=anatoly.burakov@intel.com \
    --cc=aman.deep.singh@intel.com \
    --cc=cristian.dumitrescu@intel.com \
    --cc=dev@dpdk.org \
    --cc=stephen@networkplumber.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).