Received-SPF: pass (google.com: domain of linux-kernel+bounces-58990-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Message-ID: <45d11189-3ca2-422f-89dc-d33f6ee33f7d@redhat.com>
Date: Thu, 8 Feb 2024 22:45:45 -0500
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: linux-next: build warning after merge of the workqueues tree
Content-Language: en-US
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>
References: <20240209142432.05acc1b2@canb.auug.org.au>
From: Waiman Long <longman@redhat.com>
In-Reply-To: <20240209142432.05acc1b2@canb.auug.org.au>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit

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