From: Bruce Richardson <bruce.richardson@intel.com>
To: David Marchand <david.marchand@redhat.com>
Cc: <dev@dpdk.org>, <stable@dpdk.org>,
Olivier Matz <olivier.matz@6wind.com>,
Dekel Peled <dekelp@nvidia.com>,
Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Subject: Re: [PATCH] mbuf: fix doxygen for distributor metadata
Date: Mon, 19 Jun 2023 15:19:55 +0100 [thread overview]
Message-ID: <ZJBkC2c0WyhD8Kvp@bricha3-MOBL.ger.corp.intel.com> (raw)
In-Reply-To: <CAJFAV8wb6mvY1f4TuzEQJVDX4TtwnUSr-ac963UyUzPtpJMrhA@mail.gmail.com>
On Mon, Jun 19, 2023 at 09:37:09AM +0200, David Marchand wrote:
> On Thu, Jun 15, 2023 at 5:15 PM Bruce Richardson
> <bruce.richardson@intel.com> wrote:
> >
> > On Thu, Jun 15, 2023 at 03:49:42PM +0200, David Marchand wrote:
> > > /**< is for post annotations.
> > >
> > > Fixes: 839b20be0e9b ("ethdev: support metadata as flow rule criteria")
> > > Cc: stable@dpdk.org
> > >
> > > Signed-off-by: David Marchand <david.marchand@redhat.com>
> > > ---
> > > lib/mbuf/rte_mbuf_core.h | 2 +-
> > > 1 file changed, 1 insertion(+), 1 deletion(-)
> > >
> > > diff --git a/lib/mbuf/rte_mbuf_core.h b/lib/mbuf/rte_mbuf_core.h
> > > index c692c33ec4..2030b3bef9 100644
> > > --- a/lib/mbuf/rte_mbuf_core.h
> > > +++ b/lib/mbuf/rte_mbuf_core.h
> > > @@ -584,8 +584,8 @@ struct rte_mbuf {
> > > * @see rte_event_eth_tx_adapter_txq_set()
> > > */
> > > } txadapter; /**< Eventdev ethdev Tx adapter */
> > > - /**< User defined tags. See rte_distributor_process() */
> > > uint32_t usr;
> > > + /**< User defined tags. See rte_distributor_process() */
> >
> > Yes, this fixes the issue, but...
> > I dislike having the comment on the line under the item in question. I
> > think the post-annotation comments should only be used for comments on the
> > same line. If the comment is to be on a different line, I think it should
> > go on the previous line to the item. I also think this tends to be the
> > style used throughout DPDK generally.
>
> I dislike post annotations (regardless of being on the same line or
> not) as it is easy to mix the description of fields in a structure.
> But this file has many other usages of this form and, in doubt, I
> aligned to them.
>
> I can send a followup cleanup if you want, is that ok for you?
>
If this is consistent with what is already done in the file, then I'm ok
with it as a fix. Follow-up cleanup is obviously welcome, but doesn't have
to be you doing it.
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
next prev parent reply other threads:[~2023-06-19 14:20 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-15 13:49 David Marchand
2023-06-15 14:42 ` Bruce Richardson
2023-06-19 7:37 ` David Marchand
2023-06-19 14:19 ` Bruce Richardson [this message]
2023-06-22 17:38 ` 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=ZJBkC2c0WyhD8Kvp@bricha3-MOBL.ger.corp.intel.com \
--to=bruce.richardson@intel.com \
--cc=andrew.rybchenko@oktetlabs.ru \
--cc=david.marchand@redhat.com \
--cc=dekelp@nvidia.com \
--cc=dev@dpdk.org \
--cc=olivier.matz@6wind.com \
--cc=stable@dpdk.org \
/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).