diff mbox series

[v2] doc: fix formatting in testpmd user guide

Message ID 20210423162944.354416-1-ferruh.yigit@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers show
Series [v2] doc: fix formatting in testpmd user guide | expand

Checks

Context Check Description
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/github-robot success github build: passed
ci/checkpatch warning coding style issues

Commit Message

Ferruh Yigit April 23, 2021, 4:29 p.m. UTC
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(-)

Comments

Li, Xiaoyun April 25, 2021, 1:53 a.m. UTC | #1
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>
Bing Zhao April 25, 2021, 6:12 a.m. UTC | #2
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>
Ferruh Yigit April 27, 2021, 12:03 p.m. UTC | #3
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.
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 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.