From: "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: LKML <linux-kernel@vger.kernel.org>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Subject: Re: rcu kernel-doc issues (4.14-rc1)
Date: Sat, 16 Sep 2017 21:41:45 -0700 [thread overview]
Message-ID: <20170917044145.GZ3521@linux.vnet.ibm.com> (raw)
In-Reply-To: <fe9c6796-f308-6905-a058-6c6e537fde13@infradead.org>
On Sat, Sep 16, 2017 at 06:26:04PM -0700, Randy Dunlap wrote:
> On 4.14-rc1, I am seeing lots of warnings on rcu kernel-doc:
>
> .. kernel-doc:: include/linux/rcupdate.h
> :external:
> ./Documentation/core-api/kernel-api.rst:357: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
$ grep external include/linux/rcupdate.h
* by a single external-to-structure RCU-protected pointer, then you may
* external-to-structure pointer -after- you have completely initialized
Do these comments somehow qualify as an "external" option? If so, how
do I tell kernel-doc to ignore them? Or must I reword them to avoid
the word "external"?
> .. kernel-doc:: include/linux/rcupdate_wait.h
> :external:
> ./Documentation/core-api/kernel-api.rst:360: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
$ grep external include/linux/rcupdate_wait.h
There is no occurrence of the string "external" in this file. So this
"external" option is unknown to me as well. So, any hints on how I
should interpret these error messages?
Thanx, Paul
> .. kernel-doc:: include/linux/rcutree.h
> :external:
> ./Documentation/core-api/kernel-api.rst:363: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: kernel/rcu/tree.c
> :external:
> ./Documentation/core-api/kernel-api.rst:366: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: kernel/rcu/tree_plugin.h
> :external:
> ./Documentation/core-api/kernel-api.rst:369: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: kernel/rcu/tree_exp.h
> :external:
> ./Documentation/core-api/kernel-api.rst:372: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: kernel/rcu/update.c
> :external:
> ./Documentation/core-api/kernel-api.rst:375: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: include/linux/srcu.h
> :external:
> ./Documentation/core-api/kernel-api.rst:378: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: kernel/rcu/srcutree.c
> :external:
> ./Documentation/core-api/kernel-api.rst:381: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: include/linux/rculist_bl.h
> :external:
> ./Documentation/core-api/kernel-api.rst:384: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: include/linux/rculist.h
> :external:
> ./Documentation/core-api/kernel-api.rst:387: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: include/linux/rculist_nulls.h
> :external:
> ./Documentation/core-api/kernel-api.rst:390: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: include/linux/rcu_sync.h
> :external:
> ./Documentation/core-api/kernel-api.rst:393: ERROR: Error in "kernel-doc" directive:
> unknown option: "external".
>
> .. kernel-doc:: kernel/rcu/sync.c
> :external:
>
> ../kernel/rcu/tree.c:3091: ERROR: Unexpected indentation.
> ../kernel/rcu/tree.c:3118: ERROR: Unexpected indentation.
> ../kernel/rcu/tree.c:3119: WARNING: Bullet list ends without a blank line; unexpected unindent.
>
>
> --
> ~Randy
>
next prev parent reply other threads:[~2017-09-17 4:41 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-17 1:26 rcu kernel-doc issues (4.14-rc1) Randy Dunlap
2017-09-17 4:41 ` Paul E. McKenney [this message]
2017-09-17 17:47 ` Paul E. McKenney
2017-09-17 17:57 ` Randy Dunlap
2017-09-17 19:49 ` Paul E. McKenney
2017-09-18 2:40 ` Paul E. McKenney
2017-09-18 7:30 ` Markus Heiser
2017-09-18 14:21 ` Paul E. McKenney
2017-10-16 19:58 ` Randy Dunlap
2017-10-16 20:07 ` Paul E. McKenney
2017-10-16 20:18 ` Randy Dunlap
2017-10-16 20:26 ` Paul E. McKenney
2017-10-16 21:46 ` Randy Dunlap
2017-10-16 23:35 ` Paul E. McKenney
2017-10-18 16:03 ` Jonathan Corbet
2017-10-18 16:27 ` Paul E. McKenney
2017-10-18 16:36 ` Jonathan Corbet
2017-10-20 16:42 ` Paul E. McKenney
2017-10-20 16:53 ` Randy Dunlap
2017-09-18 6:43 ` Markus Heiser
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=20170917044145.GZ3521@linux.vnet.ibm.com \
--to=paulmck@linux.vnet.ibm.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.