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

[Ajit Khaparde <ajit.khaparde@broadcom.com>]

[-- 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?