From: Stephen Hemminger <stephen@networkplumber.org>
To: Anatoly Burakov <anatoly.burakov@intel.com>
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: Mon, 26 May 2025 07:52:43 -0700 [thread overview]
Message-ID: <20250526075243.20d0b358@hermes.local> (raw)
In-Reply-To: <84ed4f7e118e8003cc00826f605555212ec07781.1747996555.git.anatoly.burakov@intel.com>
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)
next prev parent reply other threads:[~2025-05-26 14:52 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 ` Stephen Hemminger [this message]
2025-05-29 15:57 ` [PATCH v2 1/2] app/testpmd: harmonize case in help strings Burakov, Anatoly
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=20250526075243.20d0b358@hermes.local \
--to=stephen@networkplumber.org \
--cc=aman.deep.singh@intel.com \
--cc=anatoly.burakov@intel.com \
--cc=cristian.dumitrescu@intel.com \
--cc=dev@dpdk.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).