From: Jakub Kicinski <kuba@kernel•org>
To: Simon Horman <horms@kernel•org>
Cc: MD Danish Anwar <danishanwar@ti•com>,
robh@kernel•org, jan.kiszka@siemens•com,
dan.carpenter@linaro•org, diogo.ivo@siemens•com, andrew@lunn•ch,
pabeni@redhat•com, edumazet@google•com, davem@davemloft•net,
linux-kernel@vger•kernel.org, netdev@vger•kernel.org,
linux-arm-kernel@lists•infradead.org, srk@ti•com,
Vignesh Raghavendra <vigneshr@ti•com>,
Roger Quadros <rogerq@kernel•org>
Subject: Re: [PATCH net] net: ti: icssg-prueth: Fix race condition for VLAN table access
Date: Fri, 4 Oct 2024 13:07:55 -0700 [thread overview]
Message-ID: <20241004130755.3ec07538@kernel.org> (raw)
In-Reply-To: <20241004104610.GD1310185@kernel.org>
On Fri, 4 Oct 2024 11:46:10 +0100 Simon Horman wrote:
> > 1. Move the documentation to kdoc - This is will result in checkpatch
> > 2. Keep the documentation in kdoc as well as inline - This will result
> > in no warnings but duplicate documentation which I don't think is good.
> >
> > I was not sure which one takes more precedence check patch or kdoc, thus
> > put it inline thinking fixing checkpatch might have more weightage.
> >
> > Let me know what should be done here.
>
> FWIIW, my preference would be for option 2.
Of the two options I'd pick 1, perhaps due to my deeply seated
"disappointment" in the quality of checkpatch warnings :)
Complaining about missing comment when there's a kdoc is a false
positive in my book. But option 2 works, too.
I haven't tested it but there's also the option 3 - providing
the kdoc inline, something like:
+ /** @vtbl_lock: Lock for vtbl in shared memory */
+ spinlock_t vtbl_lock;
Again, no strong preference on which option you choose.
kdoc warnings may get emitted during builds so we should avoid them.
next prev parent reply other threads:[~2024-10-04 20:07 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-03 10:59 [PATCH net] net: ti: icssg-prueth: Fix race condition for VLAN table access MD Danish Anwar
2024-10-04 0:41 ` Jakub Kicinski
2024-10-04 4:55 ` MD Danish Anwar
2024-10-04 10:46 ` Simon Horman
2024-10-04 20:07 ` Jakub Kicinski [this message]
2024-10-07 5:13 ` Anwar, Md Danish
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=20241004130755.3ec07538@kernel.org \
--to=kuba@kernel$(echo .)org \
--cc=andrew@lunn$(echo .)ch \
--cc=dan.carpenter@linaro$(echo .)org \
--cc=danishanwar@ti$(echo .)com \
--cc=davem@davemloft$(echo .)net \
--cc=diogo.ivo@siemens$(echo .)com \
--cc=edumazet@google$(echo .)com \
--cc=horms@kernel$(echo .)org \
--cc=jan.kiszka@siemens$(echo .)com \
--cc=linux-arm-kernel@lists$(echo .)infradead.org \
--cc=linux-kernel@vger$(echo .)kernel.org \
--cc=netdev@vger$(echo .)kernel.org \
--cc=pabeni@redhat$(echo .)com \
--cc=robh@kernel$(echo .)org \
--cc=rogerq@kernel$(echo .)org \
--cc=srk@ti$(echo .)com \
--cc=vigneshr@ti$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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