rcu.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Tobias Klauser <tklauser@distanz.ch>
To: "Paul E. McKenney" <paulmck@kernel.org>
Cc: Josh Triplett <josh@joshtriplett.org>, rcu@vger.kernel.org
Subject: Re: [PATCH] rcu: fix kerneldoc comments in rcuupdate.h
Date: Thu, 2 Jul 2020 21:43:07 +0200	[thread overview]
Message-ID: <20200702194306.uc4sumrk7ahuk23l@distanz.ch> (raw)
In-Reply-To: <20200702170604.GT9247@paulmck-ThinkPad-P72>

On 2020-07-02 at 19:06:04 +0200, Paul E. McKenney <paulmck@kernel.org> wrote:
> On Thu, Jul 02, 2020 at 06:25:57PM +0200, Tobias Klauser wrote:
> > Fix the kerneldoc comments for rcu_read_unlock_bh(),
> > rcu_read_unlock_sched() and rcu_head_after_call_rcu() so they e.g. get
> > properly linked in the API documentation.
> > 
> > Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
> 
> The addition of the second "*" is clearly needed, good eyes and thank you!
> But where do these entries link to?  As in does adding the "()" link
> somewhere else, and if so, where?  If it instead links to the entry
> created by the corresponding docbook comment, is that really helpful?
> 
> What am I missing here?

Adding the "()" doesn't change anything with regards to whether a link
gets created and where it points to, as far as I can tell. I mainly
changed these to be consistent with the kerneldoc comments for other
functions in the same file, which all use the "()" notation. Sorry, I
should have mentioned that in the commit message.

I can drop this part from the patch or send a patch with a revised
commit message if you prefer.

Thanks
Tobias

  reply	other threads:[~2020-07-02 19:43 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-02 16:25 [PATCH] rcu: fix kerneldoc comments in rcuupdate.h Tobias Klauser
2020-07-02 17:06 ` Paul E. McKenney
2020-07-02 19:43   ` Tobias Klauser [this message]
2020-07-09 13:09   ` Tobias Klauser

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=20200702194306.uc4sumrk7ahuk23l@distanz.ch \
    --to=tklauser@distanz.ch \
    --cc=josh@joshtriplett.org \
    --cc=paulmck@kernel.org \
    --cc=rcu@vger.kernel.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).