diff mbox series

doc: fix formatting in testpmd user guide

Message ID 20210308223434.48768-1-ajit.khaparde@broadcom.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series doc: fix formatting in testpmd user guide |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Ajit Khaparde March 8, 2021, 10:34 p.m. UTC 
  Fix formatting in testpmd user guide for hairpin operation.

Fixes: 01817b10d27c ("app/testpmd: change hairpin queues setup")
Cc:stable@dpdk.org

Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
Cc: Bing Zhao <bingz@nvidia.com>
Cc: Ori Kam <orika@nvidia.com>
---
 doc/guides/testpmd_app_ug/run_app.rst | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

Comments

Ferruh Yigit March 9, 2021, 12:52 p.m. UTC | #1 
On 3/8/2021 10:34 PM, Ajit Khaparde wrote:
> Fix formatting in testpmd user guide for hairpin operation.
> 
> Fixes: 01817b10d27c ("app/testpmd: change hairpin queues setup")
> Cc:stable@dpdk.org
> 
> Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> Cc: Bing Zhao <bingz@nvidia.com>
> Cc: Ori Kam <orika@nvidia.com>
> ---
>   doc/guides/testpmd_app_ug/run_app.rst | 12 +++++++-----
>   1 file changed, 7 insertions(+), 5 deletions(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
> index 3035118cdc..8ec2300ee5 100644
> --- a/doc/guides/testpmd_app_ug/run_app.rst
> +++ b/doc/guides/testpmd_app_ug/run_app.rst
> @@ -531,11 +531,13 @@ The command line options are:
>   
>   *   ``--hairpin-mode=0xXX``
>   
> -    Set the hairpin port mode with bitmask, only valid when hairpin queues number is set.
> -    bit 4 - explicit Tx flow rule
> -    bit 1 - two hairpin ports paired
> -    bit 0 - two hairpin ports loop
> -    The default value is 0. Hairpin will use single port mode and implicit Tx flow mode.
> +    Set the hairpin port mode with bitmask, only valid when hairpin queues number is set::
> +
> +	bit 4 - explicit Tx flow rule
> +	bit 1 - two hairpin ports paired
> +	bit 0 - two hairpin ports loop
> +	The default value is 0.
> +	Hairpin will use single port mode and implicit Tx flow mode.
>   

Not sure if the last line intended to be part of the list, what do you think 
only keep bit descriptions in the box but left the last sentences as regular 
paragraph.
Ori please correct me if I am wrong with the original intention.
Ajit Khaparde March 9, 2021, 10 p.m. UTC | #2 
On Tue, Mar 9, 2021 at 4:52 AM Ferruh Yigit <ferruh.yigit@intel.com> wrote:
>
> On 3/8/2021 10:34 PM, Ajit Khaparde wrote:
> > Fix formatting in testpmd user guide for hairpin operation.
> >
> > Fixes: 01817b10d27c ("app/testpmd: change hairpin queues setup")
> > Cc:stable@dpdk.org
> >
> > Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> > Cc: Bing Zhao <bingz@nvidia.com>
> > Cc: Ori Kam <orika@nvidia.com>
> > ---
> >   doc/guides/testpmd_app_ug/run_app.rst | 12 +++++++-----
> >   1 file changed, 7 insertions(+), 5 deletions(-)
> >
> > diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
> > index 3035118cdc..8ec2300ee5 100644
> > --- a/doc/guides/testpmd_app_ug/run_app.rst
> > +++ b/doc/guides/testpmd_app_ug/run_app.rst
> > @@ -531,11 +531,13 @@ The command line options are:
> >
> >   *   ``--hairpin-mode=0xXX``
> >
> > -    Set the hairpin port mode with bitmask, only valid when hairpin queues number is set.
> > -    bit 4 - explicit Tx flow rule
> > -    bit 1 - two hairpin ports paired
> > -    bit 0 - two hairpin ports loop
> > -    The default value is 0. Hairpin will use single port mode and implicit Tx flow mode.
> > +    Set the hairpin port mode with bitmask, only valid when hairpin queues number is set::
> > +
> > +     bit 4 - explicit Tx flow rule
> > +     bit 1 - two hairpin ports paired
> > +     bit 0 - two hairpin ports loop
> > +     The default value is 0.
> > +     Hairpin will use single port mode and implicit Tx flow mode.
> >
>
> Not sure if the last line intended to be part of the list, what do you think
> only keep bit descriptions in the box but left the last sentences as regular
> paragraph.
> Ori please correct me if I am wrong with the original intention.
Ori,
Not just indentation. How about this modified text as well?

-       bit 0 - two hairpin ports loop
-       The default value is 0.
-       Hairpin will use single port mode and implicit Tx flow mode.
+       bit 0 - two hairpin ports loop (default)
+
+.. Note::
+
+   When hairpin is used in single port mode, Tx flow rule will be implicit.
Does this statement look right?
Ferruh Yigit March 26, 2021, 10 a.m. UTC | #3 
On 3/9/2021 10:00 PM, Ajit Khaparde wrote:
> On Tue, Mar 9, 2021 at 4:52 AM Ferruh Yigit <ferruh.yigit@intel.com> wrote:
>>
>> On 3/8/2021 10:34 PM, Ajit Khaparde wrote:
>>> Fix formatting in testpmd user guide for hairpin operation.
>>>
>>> Fixes: 01817b10d27c ("app/testpmd: change hairpin queues setup")
>>> Cc:stable@dpdk.org
>>>
>>> Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
>>> Cc: Bing Zhao <bingz@nvidia.com>
>>> Cc: Ori Kam <orika@nvidia.com>
>>> ---
>>>    doc/guides/testpmd_app_ug/run_app.rst | 12 +++++++-----
>>>    1 file changed, 7 insertions(+), 5 deletions(-)
>>>
>>> diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
>>> index 3035118cdc..8ec2300ee5 100644
>>> --- a/doc/guides/testpmd_app_ug/run_app.rst
>>> +++ b/doc/guides/testpmd_app_ug/run_app.rst
>>> @@ -531,11 +531,13 @@ The command line options are:
>>>
>>>    *   ``--hairpin-mode=0xXX``
>>>
>>> -    Set the hairpin port mode with bitmask, only valid when hairpin queues number is set.
>>> -    bit 4 - explicit Tx flow rule
>>> -    bit 1 - two hairpin ports paired
>>> -    bit 0 - two hairpin ports loop
>>> -    The default value is 0. Hairpin will use single port mode and implicit Tx flow mode.
>>> +    Set the hairpin port mode with bitmask, only valid when hairpin queues number is set::
>>> +
>>> +     bit 4 - explicit Tx flow rule
>>> +     bit 1 - two hairpin ports paired
>>> +     bit 0 - two hairpin ports loop
>>> +     The default value is 0.
>>> +     Hairpin will use single port mode and implicit Tx flow mode.
>>>
>>
>> Not sure if the last line intended to be part of the list, what do you think
>> only keep bit descriptions in the box but left the last sentences as regular
>> paragraph.
>> Ori please correct me if I am wrong with the original intention.
> Ori,
> Not just indentation. How about this modified text as well?
> 
> -       bit 0 - two hairpin ports loop
> -       The default value is 0.
> -       Hairpin will use single port mode and implicit Tx flow mode.
> +       bit 0 - two hairpin ports loop (default)
> +
> +.. Note::
> +
> +   When hairpin is used in single port mode, Tx flow rule will be implicit.
> Does this statement look right?
> 

Ping
Ferruh Yigit April 13, 2021, 4:18 p.m. UTC | #4 
On 3/26/2021 10:00 AM, Ferruh Yigit wrote:
> On 3/9/2021 10:00 PM, Ajit Khaparde wrote:
>> On Tue, Mar 9, 2021 at 4:52 AM Ferruh Yigit <ferruh.yigit@intel.com> wrote:
>>>
>>> On 3/8/2021 10:34 PM, Ajit Khaparde wrote:
>>>> Fix formatting in testpmd user guide for hairpin operation.
>>>>
>>>> Fixes: 01817b10d27c ("app/testpmd: change hairpin queues setup")
>>>> Cc:stable@dpdk.org
>>>>
>>>> Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
>>>> Cc: Bing Zhao <bingz@nvidia.com>
>>>> Cc: Ori Kam <orika@nvidia.com>
>>>> ---
>>>>    doc/guides/testpmd_app_ug/run_app.rst | 12 +++++++-----
>>>>    1 file changed, 7 insertions(+), 5 deletions(-)
>>>>
>>>> diff --git a/doc/guides/testpmd_app_ug/run_app.rst 
>>>> b/doc/guides/testpmd_app_ug/run_app.rst
>>>> index 3035118cdc..8ec2300ee5 100644
>>>> --- a/doc/guides/testpmd_app_ug/run_app.rst
>>>> +++ b/doc/guides/testpmd_app_ug/run_app.rst
>>>> @@ -531,11 +531,13 @@ The command line options are:
>>>>
>>>>    *   ``--hairpin-mode=0xXX``
>>>>
>>>> -    Set the hairpin port mode with bitmask, only valid when hairpin queues 
>>>> number is set.
>>>> -    bit 4 - explicit Tx flow rule
>>>> -    bit 1 - two hairpin ports paired
>>>> -    bit 0 - two hairpin ports loop
>>>> -    The default value is 0. Hairpin will use single port mode and implicit 
>>>> Tx flow mode.
>>>> +    Set the hairpin port mode with bitmask, only valid when hairpin queues 
>>>> number is set::
>>>> +
>>>> +     bit 4 - explicit Tx flow rule
>>>> +     bit 1 - two hairpin ports paired
>>>> +     bit 0 - two hairpin ports loop
>>>> +     The default value is 0.
>>>> +     Hairpin will use single port mode and implicit Tx flow mode.
>>>>
>>>
>>> Not sure if the last line intended to be part of the list, what do you think
>>> only keep bit descriptions in the box but left the last sentences as regular
>>> paragraph.
>>> Ori please correct me if I am wrong with the original intention.
>> Ori,
>> Not just indentation. How about this modified text as well?
>>
>> -       bit 0 - two hairpin ports loop
>> -       The default value is 0.
>> -       Hairpin will use single port mode and implicit Tx flow mode.
>> +       bit 0 - two hairpin ports loop (default)
>> +
>> +.. Note::
>> +
>> +   When hairpin is used in single port mode, Tx flow rule will be implicit.
>> Does this statement look right?
>>
> 
> Ping

Hi Ori, can you please check the question, let's close this patch out of way.
diff mbox series

Patch

diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
index 3035118cdc..8ec2300ee5 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -531,11 +531,13 @@  The command line options are:
 
 *   ``--hairpin-mode=0xXX``
 
-    Set the hairpin port mode with bitmask, only valid when hairpin queues number is set.
-    bit 4 - explicit Tx flow rule
-    bit 1 - two hairpin ports paired
-    bit 0 - two hairpin ports loop
-    The default value is 0. Hairpin will use single port mode and implicit Tx flow mode.
+    Set the hairpin port mode with bitmask, only valid when hairpin queues number is set::
+
+	bit 4 - explicit Tx flow rule
+	bit 1 - two hairpin ports paired
+	bit 0 - two hairpin ports loop
+	The default value is 0.
+	Hairpin will use single port mode and implicit Tx flow mode.
 
 *   ``--eth-link-speed``