From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Agalya Babu RadhaKrishnan <agalyax.babu.radhakrishnan@intel.com>,
dev@dpdk.org
Cc: reshma.pattan@intel.com, olivier.matz@6wind.com,
bernard.iremonger@intel.com
Subject: Re: [dpdk-dev] [PATCH] doc: fix interactive commands in testpmd guide
Date: Thu, 18 Apr 2019 20:51:27 +0100 [thread overview]
Message-ID: <951d5853-cd82-b41a-da0c-090f9118d6fc@intel.com> (raw)
Message-ID: <20190418195127.N2AyBdJ24o0Ib05nc0ZzzKUA3LYdrLLsxtEd4bGPuQ4@z> (raw)
In-Reply-To: <21bf3efc-dd06-6a33-a88f-c5b1cf93f6a6@intel.com>
On 4/16/2019 4:05 PM, Ferruh Yigit wrote:
> On 4/16/2019 7:33 AM, Agalya Babu RadhaKrishnan wrote:
>> From: Agalya Babu RadhaKrishnan <agalyax.babu.radhakrishnan@intel.com>
>>
>> Added some missing documentation for interactive mode commands
>>
>> Fixes: 01b2092a5e ("testpmd: add dump commands for debug")
>> Fixes: caf05a1b86 ("app/testpmd: new command to dump log types")
>>
>> Signed-off-by: Agalya Babu RadhaKrishnan <agalyax.babu.radhakrishnan@intel.com>
>
> Hi Agalya,
>
> Good to see the documentation is updated to cover the gaps, this patch documents
> various commands, are above fixes lines cover all commits?
Missing fixes are as following, please include them in next version:
Fixes: 0f62d63593ed ("app/testpmd: support tunneled TSO in checksum engine")
Fixes: 8fff667578a7 ("app/testpmd: new command to add/remove multicast MAC
addresses")
Fixes: ae03d0d18adf ("app/testpmd: command to configure MTU")
Fixes: f79959ea1504 ("app/testpmd: allow to configure RSS hash key")
Fixes: caf05a1b8608 ("app/testpmd: new command to dump log types")
>
>> ---
>> doc/guides/testpmd_app_ug/testpmd_funcs.rst | 101 ++++++++++++++++++++
>> 1 file changed, 101 insertions(+)
>>
>> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
>> index 5d4dc6f0c..a8954c279 100644
>> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
>> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
>> @@ -467,6 +467,57 @@ Show Tx metadata value set for a specific port::
>>
>> testpmd> show port (port_id) tx_metadata
>>
>> +dump physmem
>> +~~~~~~~~~~~~
>> +
>> +Dumps all physical memory segment layouts::
>> +
>> + testpmd> dump_physmem
>> +
>> +dump memzone
>> +~~~~~~~~~~~~
>> +
>> +Dumps the layout of all memory zones::
>> +
>> + testpmd> dump_memzone
>> +
>> +
>> +dump struct size
>> +~~~~~~~~~~~~~~~~
>> +
>> +Dumps the size of all memory structures::
>> +
>> + testpmd> dump_struct_sizes
>> +
>> +dump ring
>> +~~~~~~~~~
>> +
>> +Dumps the status of all or specific element in DPDK rings::
>> +
>> + testpmd> dump_ring (string)
In documentation syntax '()' for variables, '[]' for optional paramters and rest
are keywords for commandline.
For this case 'string' is optional I think, because both "dump_ring" &
"dump_ring ring_name" are valid commands. So can you please fix the command
using "[]", and 'string' can be 'ring_name' perhaps.
Same is valid for below command.
>> +
>> +dump mempool
>> +~~~~~~~~~~~~
>> +
>> +Dumps the statistics of all or specific memory pool::
>> +
>> + testpmd> dump_mempool (string)
>> + testpmd> dump_mempool (name)
Why this is duplicated, there is no two different command with 'name' and 'string'
next prev parent reply other threads:[~2019-04-18 19:51 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-16 6:33 Agalya Babu RadhaKrishnan
2019-04-16 6:33 ` Agalya Babu RadhaKrishnan
2019-04-16 7:32 ` Rami Rosen
2019-04-16 7:32 ` Rami Rosen
2019-04-16 15:05 ` Ferruh Yigit
2019-04-16 15:05 ` Ferruh Yigit
2019-04-17 9:25 ` Iremonger, Bernard
2019-04-17 9:25 ` Iremonger, Bernard
2019-04-18 19:51 ` Ferruh Yigit [this message]
2019-04-18 19:51 ` Ferruh Yigit
2019-04-23 10:44 ` [dpdk-dev] [PATCH v2] " Agalya Babu RadhaKrishnan
2019-04-23 10:44 ` Agalya Babu RadhaKrishnan
2019-04-23 11:38 ` Ferruh Yigit
2019-04-23 11:38 ` Ferruh Yigit
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=951d5853-cd82-b41a-da0c-090f9118d6fc@intel.com \
--to=ferruh.yigit@intel.com \
--cc=agalyax.babu.radhakrishnan@intel.com \
--cc=bernard.iremonger@intel.com \
--cc=dev@dpdk.org \
--cc=olivier.matz@6wind.com \
--cc=reshma.pattan@intel.com \
/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).