Re: [rcu:dev.2019.04.28a 85/85] htmldocs: kernel/rcu/sync.c:74: warning: Function parameter or member 'rcu' not described in 'rcu_sync_func'

["Paul E. McKenney" <paulmck@linux.ibm.com>]

On Fri, May 03, 2019 at 02:58:59PM +0800, kbuild test robot wrote:
> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git dev.2019.04.28a
> head:   a4e0e069df6e8718bf165fb009cd3a23e7a808a3
> commit: a4e0e069df6e8718bf165fb009cd3a23e7a808a3 [85/85] rcu/sync: Simplify the state machine
> reproduce: make htmldocs
> 
> If you fix the issue, kindly add following tag
> Reported-by: kbuild test robot <lkp@intel.com>
> 
> All warnings (new ones prefixed by >>):
> 
>    WARNING: convert(1) not found, for SVG to PDF conversion install ImageMagick (https://www.imagemagick.org)
>    include/linux/generic-radix-tree.h:1: warning: no structured comments found
>    kernel/rcu/tree_plugin.h:1: warning: no structured comments found
> >> kernel/rcu/sync.c:74: warning: Function parameter or member 'rcu' not described in 'rcu_sync_func'
>    kernel/rcu/sync.c:74: warning: Excess function parameter 'rhp' description in 'rcu_sync_func'

Good catch!  I will be folding in the diff shown below.

>    kernel/rcu/tree_plugin.h:1: warning: no structured comments found

Maybe I should add some?  ;-)

							Thanx, Paul

------------------------------------------------------------------------

commit 54479fcd0f2956d4168a5e2dd170bc9b2689df45
Author: Paul E. McKenney <paulmck@linux.ibm.com>
Date:   Fri May 3 07:13:42 2019 -0700

    squash! rcu/sync: Simplify the state machine
    
    Signed-off-by: Paul E. McKenney <paulmck@linux.ibm.com>
    [ paulmck: Tweaks to make htmldocs happy. (Reported by kbuild test robot.) ]

diff --git a/kernel/rcu/sync.c b/kernel/rcu/sync.c
index f72b779f9a8a..d4558ab7a07d 100644
--- a/kernel/rcu/sync.c
+++ b/kernel/rcu/sync.c
@@ -40,7 +40,7 @@ void rcu_sync_enter_start(struct rcu_sync *rsp)
 }
 
 
-static void rcu_sync_func(struct rcu_head *rcu);
+static void rcu_sync_func(struct rcu_head *rhp);
 
 static void rcu_sync_call(struct rcu_sync *rsp)
 {
@@ -70,9 +70,9 @@ static void rcu_sync_call(struct rcu_sync *rsp)
  * rcu_sync_exit().  Otherwise, set all state back to idle so that readers
  * can again use their fastpaths.
  */
-static void rcu_sync_func(struct rcu_head *rcu)
+static void rcu_sync_func(struct rcu_head *rhp)
 {
-	struct rcu_sync *rsp = container_of(rcu, struct rcu_sync, cb_head);
+	struct rcu_sync *rsp = container_of(rhp, struct rcu_sync, cb_head);
 	unsigned long flags;
 
 	WARN_ON_ONCE(READ_ONCE(rsp->gp_state) == GP_IDLE);