Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Sat, 5 Oct 2019 01:23:28 +0200
From:   Jonathan =?utf-8?Q?Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>
To:     "Paul E. McKenney" <paulmck@kernel.org>
Cc:     Jonathan =?utf-8?Q?Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>,
        rcu@vger.kernel.org, Josh Triplett <josh@joshtriplett.org>,
        Steven Rostedt <rostedt@goodmis.org>,
        Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
        Lai Jiangshan <jiangshanlai@gmail.com>,
        Joel Fernandes <joel@joelfernandes.org>,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH] rculist: Describe variadic macro argument in a
 Sphinx-compatible way
Message-ID: <20191004232328.GC19803@latitude>
References: <20191004215402.28008-1-j.neuschaefer@gmx.net>
 <20191004222439.GR2689@paulmck-ThinkPad-P72>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="yLVHuoLXiP9kZBkt"
Content-Disposition: inline
In-Reply-To: <20191004222439.GR2689@paulmck-ThinkPad-P72>
User-Agent: Mutt/1.10.1 (2018-07-13)
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk


--yLVHuoLXiP9kZBkt
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

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=C3=A4fer 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:
> >=20
> > ./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=C3=A4fer

--yLVHuoLXiP9kZBkt
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQIzBAABCgAdFiEEvHAHGBBjQPVy+qvDCDBEmo7zX9sFAl2X1GgACgkQCDBEmo7z
X9s0lxAAhbmET4fTZ9qZJYbUJMFK904D5myAIXWjznns59vjlShN+zO/T0h1q89U
UFTks5xYqACo5fCEDNTrNwrl4H67gW8Pi4qF8nx/tlxN06OIhidWjptnMEvgO0BS
c9eileN8Oi2Lz87Rqlc6WLFdEYQPDyG+opLxL/F3kVOpv71a8ynSiml2tnSPfwUD
QaFYeUC6bz2SE6piL1k0Bg3YY5GJznFLtWZWOLtgmn8LIxJj8UOjTCIZfiQq++0a
5Gi5gr+A82rTwhHRy7iquICJNmbpBA4K4a/hFDj7YfRahnSy+/18KQjSZYONs8ll
Urxgty8nfWili/6cRAdEQsyQGXfoqDMY0FEfPScx0GfHE9VTyNQHvCixYe81dXAf
q9naIP3VtuiZ06wZUDqgx4jyC+Rvlxo2kqTwzhz793JWLarQnlGfYibHpBse00F7
RahsWvN7AwCfpgEPuiC3bJzjTZYr81l/3Tnj2Qmk9xGKSVzA8oNHSfJ45CVUk51c
R3PAHir8H+lCAPOltkngj9ArRX6s9O9NAhYF5tsyOmwvXz0UsUB71DcdE7ZKJ6GZ
5hb95j1T92R0CVaTl4+h06ZxX+7+GP8lObsvWUlsG/1rrPjTAJ4FxbnPlNKx8a/G
Z/zI9PIKK8hlhEyWMq870PcZIIsyeX4uSbdkUFtaOFt7biPUn8w=
=LuOm
-----END PGP SIGNATURE-----

--yLVHuoLXiP9kZBkt--