public inbox for linux-next@vger.kernel.org
 help / color / mirror / Atom feed
From: Waiman Long <longman@redhat.com>
To: Stephen Rothwell <sfr@canb.auug.org.au>, Tejun Heo <tj@kernel.org>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Next Mailing List <linux-next@vger.kernel.org>
Subject: Re: linux-next: build warning after merge of the workqueues tree
Date: Thu, 8 Feb 2024 22:45:45 -0500	[thread overview]
Message-ID: <45d11189-3ca2-422f-89dc-d33f6ee33f7d@redhat.com> (raw)
In-Reply-To: <20240209142432.05acc1b2@canb.auug.org.au>

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


  reply	other threads:[~2024-02-09  3:45 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-09  3:24 linux-next: build warning after merge of the workqueues tree Stephen Rothwell
2024-02-09  3:45 ` Waiman Long [this message]
  -- strict thread matches above, loose matches on Subject: below --
2024-08-21  3:45 Stephen Rothwell
2024-08-14  4:18 Stephen Rothwell
2024-02-16  3:00 Stephen Rothwell
2024-02-16  4:46 ` Tejun Heo
2024-01-30  2:37 Stephen Rothwell
2024-04-21 23:48 ` Stephen Rothwell
2024-04-22 19:59   ` Tejun Heo
2024-04-22 20:13   ` Tejun Heo
2023-01-13  3:31 Stephen Rothwell
2023-01-13 16:31 ` Tejun Heo
2023-01-13 16:47   ` Valentin Schneider
2023-01-13 16:48     ` Valentin Schneider
2023-01-13 17:16       ` Tejun Heo
2013-03-19  3:58 Stephen Rothwell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=45d11189-3ca2-422f-89dc-d33f6ee33f7d@redhat.com \
    --to=longman@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    --cc=tj@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox