[dpdk-dev] [PATCH] doc: fix interactive commands in testpmd guide

[Ferruh Yigit]

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 at 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 at 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'