Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Mon, 1 May 2023 15:20:20 +0200
From:   Peter Zijlstra <peterz@infradead.org>
To:     Randy Dunlap <rdunlap@infradead.org>
Cc:     linux-kernel@vger.kernel.org,
        Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
        Ingo Molnar <mingo@redhat.com>
Subject: Re: [PATCH -next] sched: fix cid_lock kernel-doc warnings
Message-ID: <20230501132020.GA1597538@hirez.programming.kicks-ass.net>
References: <20230428031111.322-1-rdunlap@infradead.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20230428031111.322-1-rdunlap@infradead.org>
Precedence: bulk

On Thu, Apr 27, 2023 at 08:11:11PM -0700, Randy Dunlap wrote:
> Fix kernel-doc warnings for cid_lock and use_cid_lock.
> These comments are not in kernel-doc format.
> 
> kernel/sched/core.c:11496: warning: Cannot understand  * @cid_lock: Guarantee forward-progress of cid allocation.
>  on line 11496 - I thought it was a doc line
> kernel/sched/core.c:11505: warning: Cannot understand  * @use_cid_lock: Select cid allocation behavior: lock-free vs spinlock.
>  on line 11505 - I thought it was a doc line
> 
> Fixes: 223baf9d17f2 ("sched: Fix performance regression introduced by mm_cid")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Blergh, so mostly I avoid kerneldoc like the plague; because then you
get random people doing 'fixups' that end up making the actual comment
unreadable garbage.

Mostly my answer to any such patch is to simply remove the extra * and
call it fixed.

But now the thing presumes to know better? :-(

Anyway, in this case I suppose we can add it on and see, there's still a
fair number of actual kerneldoc comments in that file.

>  kernel/sched/core.c |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff -- a/kernel/sched/core.c b/kernel/sched/core.c
> --- a/kernel/sched/core.c
> +++ b/kernel/sched/core.c
> @@ -11492,7 +11492,7 @@ void call_trace_sched_update_nr_running(
>  
>  #ifdef CONFIG_SCHED_MM_CID
>  
> -/**
> +/*
>   * @cid_lock: Guarantee forward-progress of cid allocation.
>   *
>   * Concurrency ID allocation within a bitmap is mostly lock-free. The cid_lock
> @@ -11501,7 +11501,7 @@ void call_trace_sched_update_nr_running(
>   */
>  DEFINE_RAW_SPINLOCK(cid_lock);
>  
> -/**
> +/*
>   * @use_cid_lock: Select cid allocation behavior: lock-free vs spinlock.
>   *
>   * When @use_cid_lock is 0, the cid allocation is lock-free. When contention is