* [dpdk-dev] [PATCH] ethdev: fix comments of packet integrity flow item
@ 2021-05-19 16:27 Thomas Monjalon
2021-05-19 16:30 ` Andrew Rybchenko
` (2 more replies)
0 siblings, 3 replies; 10+ messages in thread
From: Thomas Monjalon @ 2021-05-19 16:27 UTC (permalink / raw)
To: dev; +Cc: ferruh.yigit, Ori Kam, Andrew Rybchenko, Ajit Khaparde
The Doxygen comments are placed before the related lines,
but the markers were /**< instead of /**
Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules")
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
lib/ethdev/rte_flow.h | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index 94c8c1ccc8..d7e0082dc7 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -1708,7 +1708,7 @@ rte_flow_item_geneve_opt_mask = {
#endif
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 +1716,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;
};
--
2.31.1
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [dpdk-dev] [PATCH] ethdev: fix comments of packet integrity flow item
2021-05-19 16:27 [dpdk-dev] [PATCH] ethdev: fix comments of packet integrity flow item Thomas Monjalon
@ 2021-05-19 16:30 ` Andrew Rybchenko
2021-05-19 16:31 ` Ajit Khaparde
2021-05-19 16:53 ` Ferruh Yigit
2021-05-19 17:33 ` [dpdk-dev] [PATCH v2] " Thomas Monjalon
2 siblings, 1 reply; 10+ messages in thread
From: Andrew Rybchenko @ 2021-05-19 16:30 UTC (permalink / raw)
To: Thomas Monjalon, dev; +Cc: ferruh.yigit, Ori Kam, Ajit Khaparde
On 5/19/21 7:27 PM, Thomas Monjalon wrote:
> The Doxygen comments are placed before the related lines,
> but the markers were /**< instead of /**
>
> 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>
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [dpdk-dev] [PATCH] ethdev: fix comments of packet integrity flow item
2021-05-19 16:30 ` Andrew Rybchenko
@ 2021-05-19 16:31 ` Ajit Khaparde
0 siblings, 0 replies; 10+ messages in thread
From: Ajit Khaparde @ 2021-05-19 16:31 UTC (permalink / raw)
To: Andrew Rybchenko; +Cc: Thomas Monjalon, dpdk-dev, Ferruh Yigit, Ori Kam
[-- Attachment #1: Type: text/plain, Size: 499 bytes --]
On Wed, May 19, 2021 at 9:30 AM Andrew Rybchenko <
andrew.rybchenko@oktetlabs.ru> wrote:
> On 5/19/21 7:27 PM, Thomas Monjalon wrote:
> > The Doxygen comments are placed before the related lines,
> > but the markers were /**< instead of /**
> >
> > 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>
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [dpdk-dev] [PATCH] ethdev: fix comments of packet integrity flow item
2021-05-19 16:27 [dpdk-dev] [PATCH] ethdev: fix comments of packet integrity flow item Thomas Monjalon
2021-05-19 16:30 ` Andrew Rybchenko
@ 2021-05-19 16:53 ` Ferruh Yigit
2021-05-19 17:23 ` Thomas Monjalon
2021-05-19 17:33 ` [dpdk-dev] [PATCH v2] " Thomas Monjalon
2 siblings, 1 reply; 10+ messages in thread
From: Ferruh Yigit @ 2021-05-19 16:53 UTC (permalink / raw)
To: Thomas Monjalon, dev; +Cc: Ori Kam, Andrew Rybchenko, Ajit Khaparde
On 5/19/2021 5:27 PM, Thomas Monjalon wrote:
> The Doxygen comments are placed before the related lines,
> but the markers were /**< instead of /**
>
> Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules")
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
> lib/ethdev/rte_flow.h | 18 +++++++++---------
> 1 file changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
> index 94c8c1ccc8..d7e0082dc7 100644
> --- a/lib/ethdev/rte_flow.h
> +++ b/lib/ethdev/rte_flow.h
> @@ -1708,7 +1708,7 @@ rte_flow_item_geneve_opt_mask = {
> #endif
>
> 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 +1716,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;
> };
>
+1 to fix but the struct is not listed at all in the API documentation, because
it is missing Doxygen comment for the struct itself.
Can it be possible to add a doxygen comment for the struct, even it is very
basic, to enable it to be documented?
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [dpdk-dev] [PATCH] ethdev: fix comments of packet integrity flow item
2021-05-19 16:53 ` Ferruh Yigit
@ 2021-05-19 17:23 ` Thomas Monjalon
0 siblings, 0 replies; 10+ messages in thread
From: Thomas Monjalon @ 2021-05-19 17:23 UTC (permalink / raw)
To: dev, Ferruh Yigit; +Cc: Ori Kam, Andrew Rybchenko, Ajit Khaparde
19/05/2021 18:53, Ferruh Yigit:
> On 5/19/2021 5:27 PM, Thomas Monjalon wrote:
> > The Doxygen comments are placed before the related lines,
> > but the markers were /**< instead of /**
> >
> > Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules")
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > ---
> > lib/ethdev/rte_flow.h | 18 +++++++++---------
> > 1 file changed, 9 insertions(+), 9 deletions(-)
> >
> > diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
> > index 94c8c1ccc8..d7e0082dc7 100644
> > --- a/lib/ethdev/rte_flow.h
> > +++ b/lib/ethdev/rte_flow.h
> > @@ -1708,7 +1708,7 @@ rte_flow_item_geneve_opt_mask = {
> > #endif
> >
> > 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 +1716,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;
> > };
> >
>
> +1 to fix but the struct is not listed at all in the API documentation, because
> it is missing Doxygen comment for the struct itself.
>
> Can it be possible to add a doxygen comment for the struct, even it is very
> basic, to enable it to be documented?
Yes OK
^ permalink raw reply [flat|nested] 10+ messages in thread
* [dpdk-dev] [PATCH v2] ethdev: fix comments of packet integrity flow item
2021-05-19 16:27 [dpdk-dev] [PATCH] ethdev: fix comments of packet integrity flow item Thomas Monjalon
2021-05-19 16:30 ` Andrew Rybchenko
2021-05-19 16:53 ` Ferruh Yigit
@ 2021-05-19 17:33 ` Thomas Monjalon
2021-05-19 17:47 ` Ferruh Yigit
2 siblings, 1 reply; 10+ messages in thread
From: Thomas Monjalon @ 2021-05-19 17:33 UTC (permalink / raw)
To: dev; +Cc: ferruh.yigit, asafp, Andrew Rybchenko, Ajit Khaparde, Ori Kam
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(-)
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;
};
--
2.31.1
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [dpdk-dev] [PATCH v2] ethdev: fix comments of packet integrity flow item
2021-05-19 17:33 ` [dpdk-dev] [PATCH v2] " Thomas Monjalon
@ 2021-05-19 17:47 ` Ferruh Yigit
2021-05-19 17:59 ` Thomas Monjalon
2021-05-19 20:35 ` Thomas Monjalon
0 siblings, 2 replies; 10+ messages in thread
From: Ferruh Yigit @ 2021-05-19 17:47 UTC (permalink / raw)
To: Thomas Monjalon, dev; +Cc: asafp, Andrew Rybchenko, Ajit Khaparde, Ori Kam
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.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [dpdk-dev] [PATCH v2] ethdev: fix comments of packet integrity flow item
2021-05-19 17:47 ` Ferruh Yigit
@ 2021-05-19 17:59 ` Thomas Monjalon
2021-05-19 18:02 ` Ferruh Yigit
2021-05-19 20:35 ` Thomas Monjalon
1 sibling, 1 reply; 10+ messages in thread
From: Thomas Monjalon @ 2021-05-19 17:59 UTC (permalink / raw)
To: Ferruh Yigit; +Cc: dev, asafp, Andrew Rybchenko, Ajit Khaparde, Ori Kam, bingz
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.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [dpdk-dev] [PATCH v2] ethdev: fix comments of packet integrity flow item
2021-05-19 17:59 ` Thomas Monjalon
@ 2021-05-19 18:02 ` Ferruh Yigit
0 siblings, 0 replies; 10+ messages in thread
From: Ferruh Yigit @ 2021-05-19 18:02 UTC (permalink / raw)
To: Thomas Monjalon
Cc: dev, asafp, Andrew Rybchenko, Ajit Khaparde, Ori Kam, bingz
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
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [dpdk-dev] [PATCH v2] ethdev: fix comments of packet integrity flow item
2021-05-19 17:47 ` Ferruh Yigit
2021-05-19 17:59 ` Thomas Monjalon
@ 2021-05-19 20:35 ` Thomas Monjalon
1 sibling, 0 replies; 10+ messages in thread
From: Thomas Monjalon @ 2021-05-19 20:35 UTC (permalink / raw)
To: dev; +Cc: asafp, Andrew Rybchenko, Ajit Khaparde, Ori Kam, Ferruh Yigit
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
^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2021-05-19 20:36 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-19 16:27 [dpdk-dev] [PATCH] ethdev: fix comments of packet integrity flow item Thomas Monjalon
2021-05-19 16:30 ` Andrew Rybchenko
2021-05-19 16:31 ` Ajit Khaparde
2021-05-19 16:53 ` Ferruh Yigit
2021-05-19 17:23 ` Thomas Monjalon
2021-05-19 17:33 ` [dpdk-dev] [PATCH v2] " Thomas Monjalon
2021-05-19 17:47 ` Ferruh Yigit
2021-05-19 17:59 ` Thomas Monjalon
2021-05-19 18:02 ` Ferruh Yigit
2021-05-19 20:35 ` Thomas Monjalon
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).