diff mbox series

[v2] ethdev: fix comments of packet integrity flow item

Message ID 20210519173316.2364189-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Headers
Series [v2] ethdev: fix comments of packet integrity flow item |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/iol-abi-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/github-robot success github build: passed
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance fail Performance Testing issues
ci/iol-mellanox-Functional fail Functional Testing issues
ci/iol-intel-Performance success Performance Testing PASS

Commit Message

Thomas Monjalon May 19, 2021, 5:33 p.m. UTC 
  The Doxygen comments are placed before the related lines,
but the markers were /**< instead of /**

The struct rte_flow_item_integrity did not appear in Doxygen output
because there was no general comment for the struct.

Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules")

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
---
v2: add general comment for the struct (thanks Ferruh for the catch)
---
 lib/ethdev/rte_flow.h | 26 +++++++++++++++++---------
 1 file changed, 17 insertions(+), 9 deletions(-)

Comments

Ferruh Yigit May 19, 2021, 5:47 p.m. UTC | #1 
On 5/19/2021 6:33 PM, Thomas Monjalon wrote:
> The Doxygen comments are placed before the related lines,
> but the markers were /**< instead of /**
> 
> The struct rte_flow_item_integrity did not appear in Doxygen output
> because there was no general comment for the struct.
> 
> Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules")
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>


btw, there are some related issues for other structs, do you think should we fix
them in this release?

Following are missing doxygen comment for its item:
* "struct rte_flow_item_conntrack"
* "struct rte_flow_item_ecpri"

* Following are missing doxygen comments for its items, and missing experimental
tag.
  * "struct rte_flow_item_geneve_opt"
  * "struct rte_flow_item_ipv6_frag_ext"

And I suspect we can see similar issues with more structs as we check them all.
Thomas Monjalon May 19, 2021, 5:59 p.m. UTC | #2 
19/05/2021 19:47, Ferruh Yigit:
> On 5/19/2021 6:33 PM, Thomas Monjalon wrote:
> > The Doxygen comments are placed before the related lines,
> > but the markers were /**< instead of /**
> > 
> > The struct rte_flow_item_integrity did not appear in Doxygen output
> > because there was no general comment for the struct.
> > 
> > Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules")
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> > Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> 
> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 
> 
> btw, there are some related issues for other structs, do you think should we fix
> them in this release?
> 
> Following are missing doxygen comment for its item:
> * "struct rte_flow_item_conntrack"
> * "struct rte_flow_item_ecpri"
> 
> * Following are missing doxygen comments for its items, and missing experimental
> tag.
>   * "struct rte_flow_item_geneve_opt"
>   * "struct rte_flow_item_ipv6_frag_ext"
> 
> And I suspect we can see similar issues with more structs as we check them all.

Except GENEVE, they are singleton (one member in the struct),
so it is not a big deal.
Given they are missing comment (not wrong), I propose to wait the next release
for making rte_flow doxygen more complete.
I plan to have a look at the rst doc as well.
Ferruh Yigit May 19, 2021, 6:02 p.m. UTC | #3 
On 5/19/2021 6:59 PM, Thomas Monjalon wrote:
> 19/05/2021 19:47, Ferruh Yigit:
>> On 5/19/2021 6:33 PM, Thomas Monjalon wrote:
>>> The Doxygen comments are placed before the related lines,
>>> but the markers were /**< instead of /**
>>>
>>> The struct rte_flow_item_integrity did not appear in Doxygen output
>>> because there was no general comment for the struct.
>>>
>>> Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules")
>>>
>>> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>>> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
>>> Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
>>
>> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
>>
>>
>> btw, there are some related issues for other structs, do you think should we fix
>> them in this release?
>>
>> Following are missing doxygen comment for its item:
>> * "struct rte_flow_item_conntrack"
>> * "struct rte_flow_item_ecpri"
>>
>> * Following are missing doxygen comments for its items, and missing experimental
>> tag.
>>   * "struct rte_flow_item_geneve_opt"
>>   * "struct rte_flow_item_ipv6_frag_ext"
>>
>> And I suspect we can see similar issues with more structs as we check them all.
> 
> Except GENEVE, they are singleton (one member in the struct),
> so it is not a big deal.
> Given they are missing comment (not wrong), I propose to wait the next release
> for making rte_flow doxygen more complete.
> I plan to have a look at the rst doc as well.
> 
>

OK
Thomas Monjalon May 19, 2021, 8:35 p.m. UTC | #4 
19/05/2021 19:47, Ferruh Yigit:
> On 5/19/2021 6:33 PM, Thomas Monjalon wrote:
> > The Doxygen comments are placed before the related lines,
> > but the markers were /**< instead of /**
> > 
> > The struct rte_flow_item_integrity did not appear in Doxygen output
> > because there was no general comment for the struct.
> > 
> > Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules")
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> > Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> 
> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied
diff mbox series

Patch

diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index 94c8c1ccc8..961a5884fe 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -1707,8 +1707,16 @@  rte_flow_item_geneve_opt_mask = {
 };
 #endif
 
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice
+ *
+ * RTE_FLOW_ITEM_TYPE_INTEGRITY
+ *
+ * Match on packet integrity check result.
+ */
 struct rte_flow_item_integrity {
-	/**< Tunnel encapsulation level the item should apply to.
+	/** Tunnel encapsulation level the item should apply to.
 	 * @see rte_flow_action_rss
 	 */
 	uint32_t level;
@@ -1716,21 +1724,21 @@  struct rte_flow_item_integrity {
 	union {
 		__extension__
 		struct {
-			/**< The packet is valid after passing all HW checks. */
+			/** The packet is valid after passing all HW checks. */
 			uint64_t packet_ok:1;
-			/**< L2 layer is valid after passing all HW checks. */
+			/** L2 layer is valid after passing all HW checks. */
 			uint64_t l2_ok:1;
-			/**< L3 layer is valid after passing all HW checks. */
+			/** L3 layer is valid after passing all HW checks. */
 			uint64_t l3_ok:1;
-			/**< L4 layer is valid after passing all HW checks. */
+			/** L4 layer is valid after passing all HW checks. */
 			uint64_t l4_ok:1;
-			/**< L2 layer CRC is valid. */
+			/** L2 layer CRC is valid. */
 			uint64_t l2_crc_ok:1;
-			/**< IPv4 layer checksum is valid. */
+			/** IPv4 layer checksum is valid. */
 			uint64_t ipv4_csum_ok:1;
-			/**< L4 layer checksum is valid. */
+			/** L4 layer checksum is valid. */
 			uint64_t l4_csum_ok:1;
-			/**< The l3 length is smaller than the frame length. */
+			/** L3 length is smaller than frame length. */
 			uint64_t l3_len_ok:1;
 			uint64_t reserved:56;
 		};