Re: [PATCH] rcu: fix kerneldoc comments in rcuupdate.h

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Paul

On 2020-07-02 at 19:06:04 +0200, Paul E. McKenney <paulmck@xxxxxxxxxx> 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@xxxxxxxxxx>
> 
> 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?

I've sent v2 of the patch [1] which amends the commit message to mention
which the "()" were added.

[1] https://lore.kernel.org/rcu/20200709130559.25588-1-tklauser@xxxxxxxxxx/

As noted in the previous message [2], adding the "()" doesn't change
anything with regards to whether a link gets created and where it points
to. Thus, I mentiond in the v2 commit message that this is only for
consistency with kerneldoc comments of other functions in the same file.

[2] https://lore.kernel.org/rcu/20200702194306.uc4sumrk7ahuk23l@xxxxxxxxxx/

Thanks
Tobias



[Index of Archives]     [Linux Samsung SoC]     [Linux Rockchip SoC]     [Linux Actions SoC]     [Linux for Synopsys ARC Processors]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]


  Powered by Linux