[v3] examples/flow_filtering: fix wrong comment
Checks
Commit Message
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(-)
Comments
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.
@@ -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
@@ -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. */