DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Li, Xiaoyun" <xiaoyun.li@intel.com>
To: "Yigit, Ferruh" <ferruh.yigit@intel.com>,
	"Singh, Jasvinder" <jasvinder.singh@intel.com>,
	"Wu, Jingjing" <jingjing.wu@intel.com>,
	"Adrien Mazarguil" <adrien.mazarguil@6wind.com>,
	"Dumitrescu, Cristian" <cristian.dumitrescu@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>, "stable@dpdk.org" <stable@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v3] app/testpmd: fix meter commands help strings
Date: Wed, 10 Feb 2021 00:28:33 +0000	[thread overview]
Message-ID: <CY4PR11MB17506BA3C2CD8C2E013DAD54998D9@CY4PR11MB1750.namprd11.prod.outlook.com> (raw)
In-Reply-To: <20210209141506.1506473-1-ferruh.yigit@intel.com>

Acked-by: Xiaoyun Li <xiaoyun.li@intel.com>

-----Original Message-----
From: Yigit, Ferruh <ferruh.yigit@intel.com> 
Sent: Tuesday, February 9, 2021 22:15
To: Li, Xiaoyun <xiaoyun.li@intel.com>; Singh, Jasvinder <jasvinder.singh@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>; Adrien Mazarguil <adrien.mazarguil@6wind.com>; Dumitrescu, Cristian <cristian.dumitrescu@intel.com>
Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; dev@dpdk.org; stable@dpdk.org
Subject: [PATCH v3] app/testpmd: fix meter commands help strings

Helps strings syntax is "command : description", the 'command' part was missing, updated command help strings.

Fixes: 281eeb8afc55 ("app/testpmd: add commands for metering and policing")
Fixes: 30ffb4e67ee3 ("app/testpmd: add commands traffic metering and policing")
Fixes: e63b50162aa3 ("app/testpmd: clean metering and policing commands")
Cc: stable@dpdk.org

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Cc: jasvinder.singh@intel.com
Cc: cristian.dumitrescu@intel.com

- "set port meter dscp table" documented with 'port_id' & 'mtr_id', but
  command itself is not requiring it, can be better to double check the
  intention in the command.
- In command "show port meter stats <port_id> <mtr_id> yes|no", it is
  not clear what 'yes|no' is, can be better to have a 'clear' keyword
  there: "show port meter stats <port_id> <mtr_id> clear yes|no"
- 'meter' commands seems using many high level commands, that is harder
  to remember when you take all commands into account:
  "show port meter ..."
  "add port meter ..."
  "del port meter ..."
  "create port meter ..."
  "enable port meter ..."
  "disable port meter ..."
  "set port meter ..."
  And some high level commands created just for 'meter'. Instead I think
  it is better to group the commands, like:
  "port meter [add,del,create,enable,disable] ..."
  "show port meter ..."
  It is already too late but it worth to keep in mind for the possible
  future update.

v2:
* Fixed typo, actiono -> action0
* Added more info to help string, like "<variable>(possible values)"

v3:
* Fix the "set port meter dscp table" command according the original
  intention
---
 app/test-pmd/cmdline_mtr.c | 33 +++++++++++++++++++--------------
 1 file changed, 19 insertions(+), 14 deletions(-)


      parent reply	other threads:[~2021-02-10  0:28 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-05 13:39 [dpdk-dev] [PATCH] " Ferruh Yigit
2021-02-07  2:47 ` Li, Xiaoyun
2021-02-08 14:40   ` Ferruh Yigit
2021-02-08 15:15 ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
2021-02-09  2:35   ` Li, Xiaoyun
2021-02-09 11:19     ` Ferruh Yigit
2021-02-09 14:15 ` [dpdk-dev] [PATCH v3] " Ferruh Yigit
2021-02-09 15:32   ` Singh, Jasvinder
2021-02-10 20:59     ` Thomas Monjalon
2021-02-10  0:28   ` Li, Xiaoyun [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=CY4PR11MB17506BA3C2CD8C2E013DAD54998D9@CY4PR11MB1750.namprd11.prod.outlook.com \
    --to=xiaoyun.li@intel.com \
    --cc=adrien.mazarguil@6wind.com \
    --cc=cristian.dumitrescu@intel.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=jasvinder.singh@intel.com \
    --cc=jingjing.wu@intel.com \
    --cc=stable@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).