diff mbox series

doc: fix typing error in example/l3_forward_access_ctrl

Message ID 20201102111915.5279-1-ibtisam.tariq@emumba.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers show
Series doc: fix typing error in example/l3_forward_access_ctrl | expand

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Ibtisam Tariq Nov. 2, 2020, 11:19 a.m. UTC
Add "--" and remove extra spaces in l3fwd-acl commands.

Fixes: d0dff9ba4 ("doc: sample application user guide")
Cc: bernard.iremonger@intel.com

Signed-off-by: Ibtisam Tariq <ibtisam.tariq@emumba.com>
---
 doc/guides/sample_app_ug/l3_forward_access_ctrl.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

David Marchand Nov. 5, 2020, 8:54 a.m. UTC | #1
On Mon, Nov 2, 2020 at 12:20 PM Ibtisam Tariq <ibtisam.tariq@emumba.com> wrote:
>
> Add "--" and remove extra spaces in l3fwd-acl commands.
>
> Fixes: d0dff9ba4 ("doc: sample application user guide")
> Cc: bernard.iremonger@intel.com
>
> Signed-off-by: Ibtisam Tariq <ibtisam.tariq@emumba.com>
> ---
>  doc/guides/sample_app_ug/l3_forward_access_ctrl.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst b/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
> index 4a96800ec..3cdfbfb17 100644
> --- a/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
> +++ b/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
> @@ -236,7 +236,7 @@ The application has a number of command line options:
>
>  ..  code-block:: console
>
> -    ./<build_dir>/examples/dpdk-l3fwd-acl [EAL options] -- -p PORTMASK [-P] --config(port,queue,lcore)[,(port,queue,lcore)] --rule_ipv4 FILENAME rule_ipv6 FILENAME [--alg=<val>] [--enable-jumbo [--max-pkt-len PKTLEN]] [--no-numa] [--eth-dest=X,MM:MM:MM:MM:MM:MM]
> +    ./<build_dir>/examples/dpdk-l3fwd-acl [EAL options] -- -p PORTMASK [-P] --config(port,queue,lcore)[,(port,queue,lcore)] --rule_ipv4 FILENAME --rule_ipv6 FILENAME [--alg=<val>] [--enable-jumbo [--max-pkt-len PKTLEN]] [--no-numa] [--eth-dest=X,MM:MM:MM:MM:MM:MM]
>
>
>  where,
> @@ -271,7 +271,7 @@ To enable L3 forwarding between two ports, assuming that both ports are in the s
>
>  ..  code-block:: console
>
> -    ./<build_dir>/examples/dpdk-l3fwd-acl -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="./rule_ipv4.db" -- rule_ipv6="./rule_ipv6.db" --alg=scalar
> +    ./<build_dir>/examples/dpdk-l3fwd-acl -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="./rule_ipv4.db" --rule_ipv6="./rule_ipv6.db" --alg=scalar
>
>  In this command:
>
> @@ -293,9 +293,9 @@ In this command:
>      |          |            |           |                                     |
>      +----------+------------+-----------+-------------------------------------+
>
> -*   The --rule_ipv4 option specifies the reading of IPv4 rules sets from the ./ rule_ipv4.db file.
> +*   The --rule_ipv4 option specifies the reading of IPv4 rules sets from the ./rule_ipv4.db file.

No point in keeping the ./ and I would remove it in the cmdline
example above too.


> -*   The --rule_ipv6 option specifies the reading of IPv6 rules sets from the ./ rule_ipv6.db file.
> +*   The --rule_ipv6 option specifies the reading of IPv6 rules sets from the ./rule_ipv6.db file.
>
>  *   The --alg=scalar option specifies the performing of rule lookup with a scalar function.
>
> --
> 2.17.1
>

Reviewed-by: David Marchand <david.marchand@redhat.com>

Thanks.
David Marchand Nov. 20, 2020, 12:04 p.m. UTC | #2
On Thu, Nov 5, 2020 at 9:54 AM David Marchand <david.marchand@redhat.com> wrote:
> On Mon, Nov 2, 2020 at 12:20 PM Ibtisam Tariq <ibtisam.tariq@emumba.com> wrote:
> >
> > Add "--" and remove extra spaces in l3fwd-acl commands.
> >
> > Fixes: d0dff9ba4 ("doc: sample application user guide")
Cc: stable@dpdk.org

> >
> > Signed-off-by: Ibtisam Tariq <ibtisam.tariq@emumba.com>
> Reviewed-by: David Marchand <david.marchand@redhat.com>

Applied, thanks.
Ibtisam Tariq Nov. 24, 2020, 12:40 p.m. UTC | #3
Thank you for applying it.

On Fri, Nov 20, 2020 at 5:04 PM David Marchand <david.marchand@redhat.com>
wrote:

> On Thu, Nov 5, 2020 at 9:54 AM David Marchand <david.marchand@redhat.com>
> wrote:
> > On Mon, Nov 2, 2020 at 12:20 PM Ibtisam Tariq <ibtisam.tariq@emumba.com>
> wrote:
> > >
> > > Add "--" and remove extra spaces in l3fwd-acl commands.
> > >
> > > Fixes: d0dff9ba4 ("doc: sample application user guide")
> Cc: stable@dpdk.org
>
> > >
> > > Signed-off-by: Ibtisam Tariq <ibtisam.tariq@emumba.com>
> > Reviewed-by: David Marchand <david.marchand@redhat.com>
>
> Applied, thanks.
>
>
> --
> David Marchand
>
>
diff mbox series

Patch

diff --git a/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst b/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
index 4a96800ec..3cdfbfb17 100644
--- a/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
+++ b/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
@@ -236,7 +236,7 @@  The application has a number of command line options:
 
 ..  code-block:: console
 
-    ./<build_dir>/examples/dpdk-l3fwd-acl [EAL options] -- -p PORTMASK [-P] --config(port,queue,lcore)[,(port,queue,lcore)] --rule_ipv4 FILENAME rule_ipv6 FILENAME [--alg=<val>] [--enable-jumbo [--max-pkt-len PKTLEN]] [--no-numa] [--eth-dest=X,MM:MM:MM:MM:MM:MM]
+    ./<build_dir>/examples/dpdk-l3fwd-acl [EAL options] -- -p PORTMASK [-P] --config(port,queue,lcore)[,(port,queue,lcore)] --rule_ipv4 FILENAME --rule_ipv6 FILENAME [--alg=<val>] [--enable-jumbo [--max-pkt-len PKTLEN]] [--no-numa] [--eth-dest=X,MM:MM:MM:MM:MM:MM]
 
 
 where,
@@ -271,7 +271,7 @@  To enable L3 forwarding between two ports, assuming that both ports are in the s
 
 ..  code-block:: console
 
-    ./<build_dir>/examples/dpdk-l3fwd-acl -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="./rule_ipv4.db" -- rule_ipv6="./rule_ipv6.db" --alg=scalar
+    ./<build_dir>/examples/dpdk-l3fwd-acl -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="./rule_ipv4.db" --rule_ipv6="./rule_ipv6.db" --alg=scalar
 
 In this command:
 
@@ -293,9 +293,9 @@  In this command:
     |          |            |           |                                     |
     +----------+------------+-----------+-------------------------------------+
 
-*   The --rule_ipv4 option specifies the reading of IPv4 rules sets from the ./ rule_ipv4.db file.
+*   The --rule_ipv4 option specifies the reading of IPv4 rules sets from the ./rule_ipv4.db file.
 
-*   The --rule_ipv6 option specifies the reading of IPv6 rules sets from the ./ rule_ipv6.db file.
+*   The --rule_ipv6 option specifies the reading of IPv6 rules sets from the ./rule_ipv6.db file.
 
 *   The --alg=scalar option specifies the performing of rule lookup with a scalar function.