On Sun, Jul 19, 2020 at 09:05:40PM +0000, Colton Lewis wrote:
> Silence documentation build warnings by correcting kernel-doc comment
> for rcu_nmi_enter function and kfree_rcu_cpu struct.
>
> ./kernel/rcu/tree.c:969: warning: Excess function parameter 'irq' description in 'rcu_nmi_enter'
> ./kernel/rcu/tree.c:3024: warning: Function parameter or member 'count' not described in 'kfree_rcu_cpu'
>
> Signed-off-by: Colton Lewis <colton.w.lewis@xxxxxxxxxxxxxx>
Good eyes, but someone beat you to this one, and the patch is queued
in -rcu.
Thanx, Paul
> ---
> kernel/rcu/tree.c | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
> index 6c6569e0586c..f38a51b96027 100644
> --- a/kernel/rcu/tree.c
> +++ b/kernel/rcu/tree.c
> @@ -954,7 +954,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
> @@ -3004,6 +3003,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 is 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
> @@ -3019,7 +3019,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;
> };
>
> --
> 2.26.2
>
>
