[dpdk-dev] [PATCH] doc: fix formatting in testpmd user guide

[dpdk-dev] [PATCH] doc: fix formatting in testpmd user guide

[Ajit Khaparde]

[-- Attachment #1: Type: text/plain, Size: 1312 bytes --]

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.
 
 *   ``--eth-link-speed``
 
-- 
2.21.1 (Apple Git-122.3)

Re: [dpdk-dev] [PATCH] doc: fix formatting in testpmd user guide

[Ferruh Yigit]

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.

Re: [dpdk-dev] [PATCH] doc: fix formatting in testpmd user guide

[Ajit Khaparde]

[-- Attachment #1: Type: text/plain, Size: 2142 bytes --]

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?

Re: [dpdk-dev] [PATCH] doc: fix formatting in testpmd user guide

[Ferruh Yigit]

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

Re: [dpdk-dev] [PATCH] doc: fix formatting in testpmd user guide

[Ferruh Yigit]

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.

[dpdk-dev] [PATCH v2] doc: fix formatting in testpmd user guide

[Ferruh Yigit]

From: Ajit Khaparde <ajit.khaparde@broadcom.com>

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>

v2:
* Fix only list formatting
---
 doc/guides/testpmd_app_ug/run_app.rst | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
index d0621658ae64..eb4831835322 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -538,8 +538,10 @@ 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
+    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.
-- 
2.30.2

Re: [dpdk-dev] [PATCH v2] doc: fix formatting in testpmd user guide

[Li, Xiaoyun]

Hi

> -----Original Message-----
> From: Yigit, Ferruh <ferruh.yigit@intel.com>
> Sent: Saturday, April 24, 2021 00:30
> To: Li, Xiaoyun <xiaoyun.li@intel.com>; Ori Kam <orika@nvidia.com>; Bing Zhao
> <bingz@nvidia.com>
> Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; dev@dpdk.org; Ajit Khaparde
> <ajit.khaparde@broadcom.com>
> Subject: [PATCH v2] doc: fix formatting in testpmd user guide
> 
> From: Ajit Khaparde <ajit.khaparde@broadcom.com>
> 
> Fix formatting in testpmd user guide for hairpin operation.
> 
> Fixes: 01817b10d27c ("app/testpmd: change hairpin queues setup")
> Cc:stable@dpdk.org

Missing a space after "Cc:" as patchwork says.

Except for this typo,
Acked-by: Xiaoyun Li <xiaoyun.li@intel.com>

Re: [dpdk-dev] [PATCH v2] doc: fix formatting in testpmd user guide

[Bing Zhao]

Hi,

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@intel.com>
> Sent: Saturday, April 24, 2021 12:30 AM
> To: Xiaoyun Li <xiaoyun.li@intel.com>; Ori Kam <orika@nvidia.com>;
> Bing Zhao <bingz@nvidia.com>
> Cc: Ferruh Yigit <ferruh.yigit@intel.com>; dev@dpdk.org; Ajit
> Khaparde <ajit.khaparde@broadcom.com>
> Subject: [PATCH v2] doc: fix formatting in testpmd user guide
> 
> External email: Use caution opening links or attachments
> 
> 
> From: Ajit Khaparde <ajit.khaparde@broadcom.com>
> 
> 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>
> 
> v2:
> * Fix only list formatting
> ---
>  doc/guides/testpmd_app_ug/run_app.rst | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/run_app.rst
> b/doc/guides/testpmd_app_ug/run_app.rst
> index d0621658ae64..eb4831835322 100644
> --- a/doc/guides/testpmd_app_ug/run_app.rst
> +++ b/doc/guides/testpmd_app_ug/run_app.rst
> @@ -538,8 +538,10 @@ 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
> +    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.
> --
> 2.30.2

Reviewed-by: Bing Zhao <bingz@nvidia.com>

Re: [dpdk-dev] [PATCH v2] doc: fix formatting in testpmd user guide

[Ferruh Yigit]

On 4/25/2021 2:53 AM, Li, Xiaoyun wrote:
> Hi
> 
>> -----Original Message-----
>> From: Yigit, Ferruh <ferruh.yigit@intel.com>
>> Sent: Saturday, April 24, 2021 00:30
>> To: Li, Xiaoyun <xiaoyun.li@intel.com>; Ori Kam <orika@nvidia.com>; Bing Zhao
>> <bingz@nvidia.com>
>> Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; dev@dpdk.org; Ajit Khaparde
>> <ajit.khaparde@broadcom.com>
>> Subject: [PATCH v2] doc: fix formatting in testpmd user guide
>>
>> From: Ajit Khaparde <ajit.khaparde@broadcom.com>
>>
>> Fix formatting in testpmd user guide for hairpin operation.
>>
>> Fixes: 01817b10d27c ("app/testpmd: change hairpin queues setup")
>> Cc:stable@dpdk.org
> 
> Missing a space after "Cc:" as patchwork says.
> 
> Except for this typo,
> Acked-by: Xiaoyun Li <xiaoyun.li@intel.com>
> 

Applied to dpdk-next-net/main, thanks.


Typo fixed while merging.