Re: [PATCH] rculist: Describe variadic macro argument in a Sphinx-compatible way

From: Jonathan NeuschÃfer
Date: Fri Oct 04 2019 - 19:24:13 EST


On Fri, Oct 04, 2019 at 03:24:39PM -0700, Paul E. McKenney wrote:
> On Fri, Oct 04, 2019 at 11:54:02PM +0200, Jonathan NeuschÃfer wrote:
> > Without this patch, Sphinx shows "variable arguments" as the description
> > of the cond argument, rather than the intended description, and prints
> > the following warnings:
> >
> > ./include/linux/rculist.h:374: warning: Excess function parameter 'cond' description in 'list_for_each_entry_rcu'
> > ./include/linux/rculist.h:651: warning: Excess function parameter 'cond' description in 'hlist_for_each_entry_rcu'

Hmm, small detail that I didn't realize before: It's actually the
kernel-doc script, not Sphinx, that can't deal with variadic macro
arguments and thus requires this patch.

So it may also be possible to fix the script instead. (I have not
looked into how much work that would be.)


Thanks,
Jonathan NeuschÃfer

Attachment: signature.asc
Description: PGP signature