From: Thomas Monjalon <thomas@monjalon.net>
To: Ferruh Yigit <ferruh.yigit@intel.com>
Cc: dev@dpdk.org, asafp@nvidia.com,
Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>,
Ajit Khaparde <ajit.khaparde@broadcom.com>,
Ori Kam <orika@nvidia.com>,
bingz@nvidia.com
Subject: Re: [dpdk-dev] [PATCH v2] ethdev: fix comments of packet integrity flow item
Date: Wed, 19 May 2021 19:59:51 +0200 [thread overview]
Message-ID: <2193430.dtPu5APMcE@thomas> (raw)
In-Reply-To: <f02f8d63-96c4-fae3-2bc0-019489a01932@intel.com>
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.
next prev parent reply other threads:[~2021-05-19 17:59 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-19 16:27 [dpdk-dev] [PATCH] " 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 [this message]
2021-05-19 18:02 ` Ferruh Yigit
2021-05-19 20:35 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2193430.dtPu5APMcE@thomas \
--to=thomas@monjalon.net \
--cc=ajit.khaparde@broadcom.com \
--cc=andrew.rybchenko@oktetlabs.ru \
--cc=asafp@nvidia.com \
--cc=bingz@nvidia.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=orika@nvidia.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).