doc: remove repeated repeated words
Checks
Commit Message
The script devtools/check-dup-words.sh can detect some words
which are duplicated.
Fixes: fdec9301f52d ("doc: add flow classify guides")
Cc: bernard.iremonger@intel.com
Fixes: 4dc6d8e63c16 ("doc: add graph library guide")
Cc: jerinj@marvell.com
Fixes: 30d3aa861db5 ("doc: rework VM power manager user guide")
Cc: david.hunt@intel.com
Fixes: 0d547ed03717 ("examples/ipsec-secgw: support configuration file")
Cc: roy.fan.zhang@intel.com
Fixes: e64833f2273a ("examples/l2fwd-keepalive: add sample application")
Cc: remy.horton@intel.com
Cc: stable@dpdk.org
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
doc/guides/prog_guide/flow_classify_lib.rst | 2 +-
doc/guides/prog_guide/graph_lib.rst | 2 +-
doc/guides/sample_app_ug/ipsec_secgw.rst | 2 +-
doc/guides/sample_app_ug/keep_alive.rst | 2 +-
doc/guides/sample_app_ug/vm_power_management.rst | 2 +-
5 files changed, 5 insertions(+), 5 deletions(-)
Comments
05/11/2021 22:10, Thomas Monjalon:
> The script devtools/check-dup-words.sh can detect some words
> which are duplicated.
After double check, it seems this script is not in the repository,
probably because of the false positives.
I will change this sentence in the v2.
On Fri, Nov 5, 2021 at 10:11 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> The script devtools/check-dup-words.sh can detect some words
> which are duplicated.
>
Err, that's one of our private checks.
Good to pass it every once in a while.
But checkpatch.pl itself is supposed to do a similar job for new changes.
> Fixes: fdec9301f52d ("doc: add flow classify guides")
> Cc: bernard.iremonger@intel.com
> Fixes: 4dc6d8e63c16 ("doc: add graph library guide")
> Cc: jerinj@marvell.com
> Fixes: 30d3aa861db5 ("doc: rework VM power manager user guide")
> Cc: david.hunt@intel.com
> Fixes: 0d547ed03717 ("examples/ipsec-secgw: support configuration file")
> Cc: roy.fan.zhang@intel.com
> Fixes: e64833f2273a ("examples/l2fwd-keepalive: add sample application")
> Cc: remy.horton@intel.com
> Cc: stable@dpdk.org
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
> doc/guides/prog_guide/flow_classify_lib.rst | 2 +-
> doc/guides/prog_guide/graph_lib.rst | 2 +-
> doc/guides/sample_app_ug/ipsec_secgw.rst | 2 +-
> doc/guides/sample_app_ug/keep_alive.rst | 2 +-
> doc/guides/sample_app_ug/vm_power_management.rst | 2 +-
> 5 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/doc/guides/prog_guide/flow_classify_lib.rst b/doc/guides/prog_guide/flow_classify_lib.rst
> index f0ed5a1a04..7dae0bc8c6 100644
> --- a/doc/guides/prog_guide/flow_classify_lib.rst
> +++ b/doc/guides/prog_guide/flow_classify_lib.rst
> @@ -366,7 +366,7 @@ Packet Matching
> ~~~~~~~~~~~~~~~
>
> The ``rte_flow_classifier_query`` API is used to find packets which match a
> -given flow Flow rule in the table.
> +given flow rule in the table.
I think the "Flow rule" form was intended.
> This API calls the flow_classify_run internal function which calls the
> ``table.ops.f_lookup`` API to see if any packets in a burst match any
> of the Flow rules in the table.
^^^^
See here.
Otherwise patch lgtm.
06/11/2021 10:01, David Marchand:
> On Fri, Nov 5, 2021 at 10:11 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> > --- a/doc/guides/prog_guide/flow_classify_lib.rst
> > +++ b/doc/guides/prog_guide/flow_classify_lib.rst
> > @@ -366,7 +366,7 @@ Packet Matching
> > ~~~~~~~~~~~~~~~
> >
> > The ``rte_flow_classifier_query`` API is used to find packets which match a
> > -given flow Flow rule in the table.
> > +given flow rule in the table.
>
> I think the "Flow rule" form was intended.
>
>
> > This API calls the flow_classify_run internal function which calls the
> > ``table.ops.f_lookup`` API to see if any packets in a burst match any
> > of the Flow rules in the table.
> ^^^^
> See here.
I don't understand the meaning of the capital letter.
On Sat, Nov 6, 2021 at 6:54 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> 06/11/2021 10:01, David Marchand:
> > On Fri, Nov 5, 2021 at 10:11 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> > > --- a/doc/guides/prog_guide/flow_classify_lib.rst
> > > +++ b/doc/guides/prog_guide/flow_classify_lib.rst
> > > @@ -366,7 +366,7 @@ Packet Matching
> > > ~~~~~~~~~~~~~~~
> > >
> > > The ``rte_flow_classifier_query`` API is used to find packets which match a
> > > -given flow Flow rule in the table.
> > > +given flow rule in the table.
> >
> > I think the "Flow rule" form was intended.
> >
> >
> > > This API calls the flow_classify_run internal function which calls the
> > > ``table.ops.f_lookup`` API to see if any packets in a burst match any
> > > of the Flow rules in the table.
> > ^^^^
> > See here.
>
> I don't understand the meaning of the capital letter.
I don't get the intention either.
I will go with your patch.
On Fri, Nov 5, 2021 at 10:11 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> The script devtools/check-dup-words.sh can detect some words
> which are duplicated.
Updated as:
Some duplicate words were detected with a script.
>
> Fixes: fdec9301f52d ("doc: add flow classify guides")
> Fixes: 4dc6d8e63c16 ("doc: add graph library guide")
> Fixes: 30d3aa861db5 ("doc: rework VM power manager user guide")
> Fixes: 0d547ed03717 ("examples/ipsec-secgw: support configuration file")
> Fixes: e64833f2273a ("examples/l2fwd-keepalive: add sample application")
> Cc: stable@dpdk.org
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: David Marchand <david.marchand@redhat.com>
Applied, thanks.
@@ -366,7 +366,7 @@ Packet Matching
~~~~~~~~~~~~~~~
The ``rte_flow_classifier_query`` API is used to find packets which match a
-given flow Flow rule in the table.
+given flow rule in the table.
This API calls the flow_classify_run internal function which calls the
``table.ops.f_lookup`` API to see if any packets in a burst match any
of the Flow rules in the table.
@@ -220,7 +220,7 @@ the user needs to update the context of the node hence access to
``struct rte_node *`` memory.
``rte_graph_foreach_node()``, ``rte_graph_node_get()``,
-``rte_graph_node_get_by_name()`` APIs can be used to to get the
+``rte_graph_node_get_by_name()`` APIs can be used to get the
``struct rte_node*``. ``rte_graph_foreach_node()`` iterator function works on
``struct rte_graph *`` fast-path graph object while others works on graph ID or name.
@@ -443,7 +443,7 @@ where each options means:
* *protect <SA_idx>*: the specified traffic is protected by SA rule
with id SA_idx
- * *bypass*: the specified traffic traffic is bypassed
+ * *bypass*: the specified traffic is bypassed
* *discard*: the specified traffic is discarded
``<priority>``
@@ -78,7 +78,7 @@ options.
Explanation
-----------
-The following sections provide some explanation of the The
+The following sections provide some explanation of the
Keep-Alive/'Liveliness' conceptual scheme. As mentioned in the
overview section, the initialization and run-time paths are very
similar to those of the :doc:`l2_forward_real_virtual`.
@@ -236,7 +236,7 @@ Compiling and Running the Host Application
Compiling the Host Application
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-For information on compiling the DPDK and sample applications, see
+For information on compiling the DPDK and sample applications,
see :doc:`compiling`.
The application is located in the ``vm_power_manager`` subdirectory.