examples/flow_filtering: enhance code snippet readability
authorJoyce Kong <joyce.kong@arm.com>
Fri, 12 Nov 2021 06:37:03 +0000 (00:37 -0600)
committerDavid Marchand <david.marchand@redhat.com>
Tue, 16 Nov 2021 15:22:26 +0000 (16:22 +0100)
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")

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
examples/flow_filtering/flow_blocks.c

index 11da914..8cac2f8 100644 (file)
@@ -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
 
index 3251ed9..f368e61 100644 (file)
@@ -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. */