| Message ID | 20211103024103.2420-1-joyce.kong@arm.com (mailing list archive) |
|---|---|
| State | Superseded, archived |
| Delegated to: | Thomas Monjalon |
| Headers | show |
| Series | [v1] examples/flow_filtering: fix wrong comment | expand |
| Context | Check | Description |
|---|---|---|
| ci/iol-x86_64-unit-testing | fail | Testing issues |
| ci/iol-aarch64-compile-testing | success | Testing PASS |
| ci/iol-intel-Functional | success | Functional Testing PASS |
| ci/iol-intel-Performance | success | Performance Testing PASS |
| ci/iol-x86_64-compile-testing | success | Testing PASS |
| ci/iol-aarch64-unit-testing | success | Testing PASS |
| ci/iol-broadcom-Performance | success | Performance Testing PASS |
| ci/iol-broadcom-Functional | success | Functional Testing PASS |
| ci/iol-mellanox-Performance | success | Performance Testing PASS |
| ci/intel-Testing | success | Testing PASS |
| ci/Intel-compilation | fail | Compilation issues |
| ci/github-robot: build | fail | github build: failed |
| ci/checkpatch | success | coding style OK |
> From: Joyce Kong <joyce.kong@arm.com> > Sent: Wednesday 3 November 2021 02:41 > To: Ori Kam <orika@nvidia.com>; Mcnamara, John > <john.mcnamara@intel.com>; Walsh, Conor <conor.walsh@intel.com>; > Conor Fogarty <conor.fogarty@intel.com> > Cc: dev@dpdk.org; nd@arm.com; stable@dpdk.org > Subject: [PATCH v1] examples/flow_filtering: fix wrong comment > > Change the 'IPV4' level to 'ETH' level in the comment > as it was previously misdescribed. > > Fixes: 9a212dc06c7a ("doc: use code snippets in sample app guides") > Cc: stable@dpdk.org > > Signed-off-by: Joyce Kong <joyce.kong@arm.com> > Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com> > --- > examples/flow_filtering/flow_blocks.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/examples/flow_filtering/flow_blocks.c > b/examples/flow_filtering/flow_blocks.c > index 3251ed9f8f..b168dc6e71 100644 > --- a/examples/flow_filtering/flow_blocks.c > +++ b/examples/flow_filtering/flow_blocks.c > @@ -75,7 +75,7 @@ generate_ipv4_flow(uint16_t port_id, uint16_t rx_q, > * ipv4 we set this level to allow all. > */ > > - /* IPv4 we set this level to allow all. 8< */ > + /* ETH we set this level to allow all. 8< */ > pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH; > /* >8 End of setting the first level of the pattern. */ Hi Joyce, This can't be applied as is, it will break the docs build as follows: doc/guides/sample_app_ug/flow_filtering.rst:225: WARNING: start-after pattern not found: IPv4 we set this level to allow all. 8< The comment is a tag used by the docs to locate a snippet within the code so the corresponding tag must be changed in the docs. The following must be added to this patch: diff --git a/doc/guides/sample_app_ug/flow_filtering.rst b/doc/guides/sample_app_ug/flow_filtering.rst index 11da9148ca..e8605f36f2 100644 --- a/doc/guides/sample_app_ug/flow_filtering.rst +++ b/doc/guides/sample_app_ug/flow_filtering.rst @@ -224,7 +224,7 @@ Setting the first level of the pattern ETH: .. literalinclude:: ../../../examples/flow_filtering/flow_blocks.c :language: c - :start-after: IPv4 we set this level to allow all. 8< + :start-after: ETH we set this level to allow all. 8< :end-before: >8 End of setting the first level of the pattern. :dedent: 1 Thanks, Conor.
<snip> > > --- > > examples/flow_filtering/flow_blocks.c | 2 +- > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > diff --git a/examples/flow_filtering/flow_blocks.c > > b/examples/flow_filtering/flow_blocks.c > > index 3251ed9f8f..b168dc6e71 100644 > > --- a/examples/flow_filtering/flow_blocks.c > > +++ b/examples/flow_filtering/flow_blocks.c > > @@ -75,7 +75,7 @@ generate_ipv4_flow(uint16_t port_id, uint16_t rx_q, > > * ipv4 we set this level to allow all. > > */ > > > > - /* IPv4 we set this level to allow all. 8< */ > > + /* ETH we set this level to allow all. 8< */ > > pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH; > > /* >8 End of setting the first level of the pattern. */ > > Hi Joyce, > > This can't be applied as is, it will break the docs build as follows: > doc/guides/sample_app_ug/flow_filtering.rst:225: WARNING: start-after > pattern not found: IPv4 we set this level to allow all. 8< > > The comment is a tag used by the docs to locate a snippet within the code so > the corresponding tag must be changed in the docs. > The following must be added to this patch: > > diff --git a/doc/guides/sample_app_ug/flow_filtering.rst > b/doc/guides/sample_app_ug/flow_filtering.rst > index 11da9148ca..e8605f36f2 100644 > --- a/doc/guides/sample_app_ug/flow_filtering.rst > +++ b/doc/guides/sample_app_ug/flow_filtering.rst > @@ -224,7 +224,7 @@ Setting the first level of the pattern ETH: > > .. literalinclude:: ../../../examples/flow_filtering/flow_blocks.c > :language: c > - :start-after: IPv4 we set this level to allow all. 8< > + :start-after: ETH we set this level to allow all. 8< > :end-before: >8 End of setting the first level of the pattern. > :dedent: 1 > > Thanks, > Conor. Hi Conor, please see V2. Thanks, Joyce
> From: Joyce Kong <Joyce.Kong@arm.com> > Sent: Thursday 4 November 2021 07:34 > To: Walsh, Conor <conor.walsh@intel.com>; Ori Kam <orika@nvidia.com>; > Mcnamara, John <john.mcnamara@intel.com>; Conor Fogarty > <conor.fogarty@intel.com> > Cc: dev@dpdk.org; nd <nd@arm.com>; stable@dpdk.org > Subject: RE: [PATCH v1] examples/flow_filtering: fix wrong comment > > <snip> > > > > --- > > > examples/flow_filtering/flow_blocks.c | 2 +- > > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > > > diff --git a/examples/flow_filtering/flow_blocks.c > > > b/examples/flow_filtering/flow_blocks.c > > > index 3251ed9f8f..b168dc6e71 100644 > > > --- a/examples/flow_filtering/flow_blocks.c > > > +++ b/examples/flow_filtering/flow_blocks.c > > > @@ -75,7 +75,7 @@ generate_ipv4_flow(uint16_t port_id, uint16_t rx_q, > > > * ipv4 we set this level to allow all. > > > */ > > > > > > - /* IPv4 we set this level to allow all. 8< */ > > > + /* ETH we set this level to allow all. 8< */ > > > pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH; > > > /* >8 End of setting the first level of the pattern. */ > > > > Hi Joyce, > > > > This can't be applied as is, it will break the docs build as follows: > > doc/guides/sample_app_ug/flow_filtering.rst:225: WARNING: start-after > > pattern not found: IPv4 we set this level to allow all. 8< > > > > The comment is a tag used by the docs to locate a snippet within the code > so > > the corresponding tag must be changed in the docs. > > The following must be added to this patch: > > > > diff --git a/doc/guides/sample_app_ug/flow_filtering.rst > > b/doc/guides/sample_app_ug/flow_filtering.rst > > index 11da9148ca..e8605f36f2 100644 > > --- a/doc/guides/sample_app_ug/flow_filtering.rst > > +++ b/doc/guides/sample_app_ug/flow_filtering.rst > > @@ -224,7 +224,7 @@ Setting the first level of the pattern ETH: > > > > .. literalinclude:: ../../../examples/flow_filtering/flow_blocks.c > > :language: c > > - :start-after: IPv4 we set this level to allow all. 8< > > + :start-after: ETH we set this level to allow all. 8< > > :end-before: >8 End of setting the first level of the pattern. > > :dedent: 1 > > > > Thanks, > > Conor. > > Hi Conor, please see V2. > > Thanks, Joyce Hi Joyce, v2 looks correct to me, I will apply my tag to v2 now. Thanks, Conor.
diff --git a/examples/flow_filtering/flow_blocks.c b/examples/flow_filtering/flow_blocks.c index 3251ed9f8f..b168dc6e71 100644 --- a/examples/flow_filtering/flow_blocks.c +++ b/examples/flow_filtering/flow_blocks.c @@ -75,7 +75,7 @@ generate_ipv4_flow(uint16_t port_id, uint16_t rx_q, * ipv4 we set this level to allow all. */ - /* IPv4 we set this level to allow all. 8< */ + /* ETH we set this level to allow all. 8< */ pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH; /* >8 End of setting the first level of the pattern. */
Change the 'IPV4' level to 'ETH' level in the comment as it was previously misdescribed. Fixes: 9a212dc06c7a ("doc: use code snippets in sample app guides") Cc: stable@dpdk.org Signed-off-by: Joyce Kong <joyce.kong@arm.com> Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com> --- examples/flow_filtering/flow_blocks.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)