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 > -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
