[PATCH] kernel/rcu/tree.c: fix kernel-doc warnings

[PATCH] kernel/rcu/tree.c: fix kernel-doc warnings

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warnings:

../kernel/rcu/tree.c:959: warning: Excess function parameter 'irq' description in 'rcu_nmi_enter'
../kernel/rcu/tree.c:3006: warning: Function parameter or member 'count' not described in 'kfree_rcu_cpu'

Fixes: cf7614e13c8f ("rcu: Refactor rcu_{nmi,irq}_{enter,exit}()")
Fixes: 9154244c1ab6 ("rcu/tree: Add a shrinker to prevent OOM due to kfree_rcu() batching")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Byungchul Park <byungchul.park@lge.com>
Cc: Joel Fernandes (Google) <joel@joelfernandes.org>
Cc: Paul E. McKenney <paulmck@kernel.org>
---
Note: The first Fixes: commit ID might be incorrect.

 kernel/rcu/tree.c |    3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

--- linux-next-20200615.orig/kernel/rcu/tree.c
+++ linux-next-20200615/kernel/rcu/tree.c
@@ -944,7 +944,6 @@ void __rcu_irq_enter_check_tick(void)
 
 /**
  * rcu_nmi_enter - inform RCU of entry to NMI context
- * @irq: Is this call from rcu_irq_enter?
  *
  * If the CPU was idle from RCU's viewpoint, update rdp->dynticks and
  * rdp->dynticks_nmi_nesting to let the RCU grace-period handling know
@@ -2986,6 +2985,7 @@ struct kfree_rcu_cpu_work {
  * @monitor_work: Promote @head to @head_free after KFREE_DRAIN_JIFFIES
  * @monitor_todo: Tracks whether a @monitor_work delayed work is pending
  * @initialized: The @lock and @rcu_work fields have been initialized
+ * @count: Number of objects for which GP not started
  *
  * This is a per-CPU structure.  The reason that it is not included in
  * the rcu_data structure is to permit this code to be extracted from
@@ -3001,7 +3001,6 @@ struct kfree_rcu_cpu {
 	struct delayed_work monitor_work;
 	bool monitor_todo;
 	bool initialized;
-	// Number of objects for which GP not started
 	int count;
 };
 

Re: [PATCH] kernel/rcu/tree.c: fix kernel-doc warnings

[Paul E. McKenney]

On Mon, Jun 15, 2020 at 12:28:05PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warnings:
> 
> ../kernel/rcu/tree.c:959: warning: Excess function parameter 'irq' description in 'rcu_nmi_enter'
> ../kernel/rcu/tree.c:3006: warning: Function parameter or member 'count' not described in 'kfree_rcu_cpu'
> 
> Fixes: cf7614e13c8f ("rcu: Refactor rcu_{nmi,irq}_{enter,exit}()")
> Fixes: 9154244c1ab6 ("rcu/tree: Add a shrinker to prevent OOM due to kfree_rcu() batching")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Byungchul Park <byungchul.park@lge.com>
> Cc: Joel Fernandes (Google) <joel@joelfernandes.org>
> Cc: Paul E. McKenney <paulmck@kernel.org>

Someone beat you to the second hunk, but the first hunk is queued
and pushed, thank you!

							Thanx, Paul

> ---
> Note: The first Fixes: commit ID might be incorrect.
> 
>  kernel/rcu/tree.c |    3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> --- linux-next-20200615.orig/kernel/rcu/tree.c
> +++ linux-next-20200615/kernel/rcu/tree.c
> @@ -944,7 +944,6 @@ void __rcu_irq_enter_check_tick(void)
>  
>  /**
>   * rcu_nmi_enter - inform RCU of entry to NMI context
> - * @irq: Is this call from rcu_irq_enter?
>   *
>   * If the CPU was idle from RCU's viewpoint, update rdp->dynticks and
>   * rdp->dynticks_nmi_nesting to let the RCU grace-period handling know
> @@ -2986,6 +2985,7 @@ struct kfree_rcu_cpu_work {
>   * @monitor_work: Promote @head to @head_free after KFREE_DRAIN_JIFFIES
>   * @monitor_todo: Tracks whether a @monitor_work delayed work is pending
>   * @initialized: The @lock and @rcu_work fields have been initialized
> + * @count: Number of objects for which GP not started
>   *
>   * This is a per-CPU structure.  The reason that it is not included in
>   * the rcu_data structure is to permit this code to be extracted from
> @@ -3001,7 +3001,6 @@ struct kfree_rcu_cpu {
>  	struct delayed_work monitor_work;
>  	bool monitor_todo;
>  	bool initialized;
> -	// Number of objects for which GP not started
>  	int count;
>  };
>  
> 
>