[v2] examples/flow_filtering: fix wrong comment

Message ID 20211104073220.7938-1-joyce.kong@arm.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] examples/flow_filtering: fix wrong comment |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot: build success github build: passed
ci/Intel-compilation fail Compilation issues
ci/intel-Testing success Testing PASS
ci/iol-spell-check-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional fail Functional Testing issues
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

Joyce Kong Nov. 4, 2021, 7:32 a.m. UTC
  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(-)
  

Comments

Conor Walsh Nov. 4, 2021, 9:49 a.m. UTC | #1
> 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

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