> From: Joyce Kong <joyce.k...@arm.com>
> Sent: Wednesday 3 November 2021 02:41
> To: Ori Kam <or...@nvidia.com>; Mcnamara, John
> <john.mcnam...@intel.com>; Walsh, Conor <conor.wa...@intel.com>;
> Conor Fogarty <conor.foga...@intel.com>
> Cc: dev@dpdk.org; n...@arm.com; sta...@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: sta...@dpdk.org
>
> Signed-off-by: Joyce Kong <joyce.k...@arm.com>
> Reviewed-by: Ruifeng Wang <ruifeng.w...@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.
