linux-kernel - Re: linux-next: build warning after merge of the workqueues tree

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date: Thu, 8 Feb 2024 22:45:45 -0500
From: Waiman Long <longman@...hat.com>
To: Stephen Rothwell <sfr@...b.auug.org.au>, Tejun Heo <tj@...nel.org>
Cc: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
 Linux Next Mailing List <linux-next@...r.kernel.org>
Subject: Re: linux-next: build warning after merge of the workqueues tree

On 2/8/24 22:24, Stephen Rothwell wrote:
> Hi all,
>
> After merging the workqueues tree, today's linux-next build (htmldocs)
> produced this warning:
>
> Documentation/core-api/workqueue:778: kernel/workqueue.c:1801: WARNING: Line block ends without a blank line.
> Documentation/core-api/workqueue:778: kernel/workqueue.c:1804: WARNING: Line block ends without a blank line.
>
> Introduced by commit
>
>    4c065dbce1e8 ("workqueue: Enable unbound cpumask update on ordered workqueues")

That warning is likely by the following function comment:

/**
  * unplug_oldest_pwq - restart an oldest plugged pool_workqueue
  * @wq: workqueue_struct to be restarted
  *
  * pwq's are linked into wq->pwqs with the oldest first. For ordered
  * workqueues, only the oldest pwq is unplugged, the others are plugged to
  * suspend execution until the oldest one is drained. When this 
happens, the
  * next oldest one (first plugged pwq in iteration) will be unplugged to
  * restart work item execution to ensure proper work item ordering.
  *
  *    dfl_pwq --------------+     [P] - plugged
  *                          |
  *                          v
  *    pwqs -> A -> B [P] -> C [P] (newest)
  *            |    |        |
  *            1    3        5
  *            |    |        |
  *            2    4        6
  */

One possible solution is to take out one '*' of the leading "/**" so 
that it is not regarded as an inline documentation block. Any other 
suggestion is welcome.

Cheers,
Longman