[dpdk-dev] [PATCH v1] examples/flow_filtering: fix wrong comment

[dpdk-dev] [PATCH v1] examples/flow_filtering: fix wrong comment

[Joyce Kong]

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. */
 
-- 
2.17.1

Re: [dpdk-dev] [PATCH v1] examples/flow_filtering: fix wrong comment

[Walsh, Conor]

> 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.

Re: [dpdk-dev] [PATCH v1] examples/flow_filtering: fix wrong comment

[Joyce Kong]

<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

Re: [dpdk-dev] [PATCH v1] examples/flow_filtering: fix wrong comment

[Walsh, Conor]

> 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.

[dpdk-dev] [PATCH v2] examples/flow_filtering: fix wrong comment

[Joyce Kong]

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>
---
 doc/guides/sample_app_ug/flow_filtering.rst | 2 +-
 examples/flow_filtering/flow_blocks.c       | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

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
 
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. */
 
-- 
2.17.1

Re: [dpdk-dev] [PATCH v2] examples/flow_filtering: fix wrong comment

[Walsh, Conor]

> From: Joyce Kong <joyce.kong@arm.com>
> Sent: Thursday 4 November 2021 07:32
> To: Ori Kam <orika@nvidia.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Conor Fogarty <conor.fogarty@intel.com>;
> Walsh, Conor <conor.walsh@intel.com>
> Cc: dev@dpdk.org; nd@arm.com; stable@dpdk.org
> Subject: [PATCH v2] 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>
> ---

Reviewed-by: Conor Walsh <conor.walsh@intel.com>

[PATCH v3] examples/flow_filtering: fix wrong comment

[Joyce Kong]

The 'IPv4' in the comment is to mark the code
snippet, while it made some confusion. Then
removing 'IPv4' description will be clearer.

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>
Reviewed-by: Conor Walsh <conor.walsh@intel.com>
---
 doc/guides/sample_app_ug/flow_filtering.rst | 2 +-
 examples/flow_filtering/flow_blocks.c       | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/sample_app_ug/flow_filtering.rst b/doc/guides/sample_app_ug/flow_filtering.rst
index 11da9148ca..8cac2f8a8f 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: Set this level to allow all. 8<
     :end-before: >8 End of setting the first level of the pattern.
     :dedent: 1
 
diff --git a/examples/flow_filtering/flow_blocks.c b/examples/flow_filtering/flow_blocks.c
index 3251ed9f8f..f368e6124d 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< */
+	/* 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. */
 
-- 
2.17.1

Re: [PATCH v3] examples/flow_filtering: fix wrong comment

[David Marchand]

On Fri, Nov 12, 2021 at 7:37 AM Joyce Kong <joyce.kong@arm.com> wrote:
>
> The 'IPv4' in the comment is to mark the code
> snippet, while it made some confusion. Then
> removing 'IPv4' description will be clearer.
>
> Fixes: 9a212dc06c7a ("doc: use code snippets in sample app guides")
> Cc: stable@dpdk.org

I removed the backport request: it's not fixing a problem, just
enhancing readability of a comment.

>
> Signed-off-by: Joyce Kong <joyce.kong@arm.com>
> Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com>
> Reviewed-by: Conor Walsh <conor.walsh@intel.com>

Applied, thanks.


-- 
David Marchand