Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751714AbdIQR5q (ORCPT ); Sun, 17 Sep 2017 13:57:46 -0400 Received: from bombadil.infradead.org ([65.50.211.133]:44958 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751529AbdIQR5o (ORCPT ); Sun, 17 Sep 2017 13:57:44 -0400 Subject: Re: rcu kernel-doc issues (4.14-rc1) To: paulmck@linux.vnet.ibm.com Cc: LKML , "linux-doc@vger.kernel.org" , Jonathan Corbet References: <20170917044145.GZ3521@linux.vnet.ibm.com> <20170917174716.GA3611@linux.vnet.ibm.com> From: Randy Dunlap Message-ID: Date: Sun, 17 Sep 2017 10:57:42 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.3.0 MIME-Version: 1.0 In-Reply-To: <20170917174716.GA3611@linux.vnet.ibm.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 4439 Lines: 130 On 09/17/17 10:47, Paul E. McKenney wrote: > On Sat, Sep 16, 2017 at 09:41:45PM -0700, Paul E. McKenney wrote: >> 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? > > And thanks to Akira Yokosawa for pointing out my confusion in reading > these error messages. The line numbers of course apply to the file > Documentation/core-api/kernel-api.rst rather than the various RCU > C-language source files. > > The patch below removes the error messages for me. Is this what you > had in mind? (Might need other options at some point, but somewhere > to start.) > Yes, much better. Thanks. Just some missing kernel-doc on parameters mostly remaining: ../include/linux/rcupdate.h:818: warning: No description found for parameter 'p' ../include/linux/rcupdate.h:818: warning: No description found for parameter 'v' ../include/linux/rcupdate.h:826: warning: No description found for parameter 'p' ../include/linux/rcupdate.h:826: warning: No description found for parameter 'v' ../include/linux/srcu.h:95: warning: No description found for parameter 'sp' ../kernel/rcu/srcutree.c:873: warning: No description found for parameter 'rhp' ../kernel/rcu/srcutree.c:873: warning: Excess function parameter 'head' description in 'call_srcu' ../include/linux/rculist.h:302: warning: Incorrect use of kernel-doc format: * list_first_or_null_rcu - get the first element from a list ../include/linux/rculist.h:317: warning: No description found for parameter 'ptr' ../include/linux/rculist.h:317: warning: No description found for parameter 'type' ../include/linux/rculist.h:317: warning: No description found for parameter 'member' ../kernel/rcu/sync.c:94: warning: No description found for parameter 'rsp' ../kernel/rcu/sync.c:162: warning: No description found for parameter 'rcu' ../kernel/rcu/sync.c:162: warning: Excess function parameter 'rsp' description in 'rcu_sync_func' > > ------------------------------------------------------------------------ > > diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst > index 8282099e0cbf..30b2666bf494 100644 > --- a/Documentation/core-api/kernel-api.rst > +++ b/Documentation/core-api/kernel-api.rst > @@ -352,44 +352,44 @@ Read-Copy Update (RCU) > ---------------------- > > .. kernel-doc:: include/linux/rcupdate.h > - :external: > + :export > > .. kernel-doc:: include/linux/rcupdate_wait.h > - :external: > + :export > > .. kernel-doc:: include/linux/rcutree.h > - :external: > + :export > > .. kernel-doc:: kernel/rcu/tree.c > - :external: > + :export > > .. kernel-doc:: kernel/rcu/tree_plugin.h > - :external: > + :export > > .. kernel-doc:: kernel/rcu/tree_exp.h > - :external: > + :export > > .. kernel-doc:: kernel/rcu/update.c > - :external: > + :export > > .. kernel-doc:: include/linux/srcu.h > - :external: > + :export > > .. kernel-doc:: kernel/rcu/srcutree.c > - :external: > + :export > > .. kernel-doc:: include/linux/rculist_bl.h > - :external: > + :export > > .. kernel-doc:: include/linux/rculist.h > - :external: > + :export > > .. kernel-doc:: include/linux/rculist_nulls.h > - :external: > + :export > > .. kernel-doc:: include/linux/rcu_sync.h > - :external: > + :export > > .. kernel-doc:: kernel/rcu/sync.c > - :external: > + :export > > > -- -- ~Randy