2024-01-30 02:46:20

by Stephen Rothwell

[permalink] [raw]
Subject: linux-next: build warning after merge of the workqueues tree

Hi all,

After merging the workqueues tree, today's linux-next build (htmldocs)
produced this warning:

Documentation/core-api/workqueue:761: include/linux/workqueue.h:476: WARNING: Inline literal start-string without end-string.

Introduced by commit

5797b1c18919 ("workqueue: Implement system-wide nr_active enforcement for unbound workqueues")

--
Cheers,
Stephen Rothwell


Attachments:
(No filename) (499.00 B)
OpenPGP digital signature

2024-04-21 23:48:31

by Stephen Rothwell

[permalink] [raw]
Subject: Re: linux-next: build warning after merge of the workqueues tree

Hi all,

On Tue, 30 Jan 2024 13:37:48 +1100 Stephen Rothwell <[email protected]> wrote:
>
> After merging the workqueues tree, today's linux-next build (htmldocs)
> produced this warning:
>
> Documentation/core-api/workqueue:761: include/linux/workqueue.h:476: WARNING: Inline literal start-string without end-string.
>
> Introduced by commit
>
> 5797b1c18919 ("workqueue: Implement system-wide nr_active enforcement for unbound workqueues")

I am still seeing the above warning.

--
Cheers,
Stephen Rothwell


Attachments:
(No filename) (499.00 B)
OpenPGP digital signature

2024-04-22 20:01:27

by Tejun Heo

[permalink] [raw]
Subject: Re: linux-next: build warning after merge of the workqueues tree

On Mon, Apr 22, 2024 at 09:48:16AM +1000, Stephen Rothwell wrote:
> Hi all,
>
> On Tue, 30 Jan 2024 13:37:48 +1100 Stephen Rothwell <[email protected]> wrote:
> >
> > After merging the workqueues tree, today's linux-next build (htmldocs)
> > produced this warning:
> >
> > Documentation/core-api/workqueue:761: include/linux/workqueue.h:476: WARNING: Inline literal start-string without end-string.
> >
> > Introduced by commit
> >
> > 5797b1c18919 ("workqueue: Implement system-wide nr_active enforcement for unbound workqueues")
>
> I am still seeing the above warning.

Oops, sorry about missing that. Will fix.

Thanks.

--
tejun

2024-04-22 20:13:16

by Tejun Heo

[permalink] [raw]
Subject: Re: linux-next: build warning after merge of the workqueues tree

Hello,

I applied the following patch to wq/for-6.10.

The offending line wasn't introduced recently tho. It goes way back.
5797b1c18919 just touches the surrounding lines. Maybe that triggered
something?

Thanks.
------ 8< ------
From 51da7f68edae38e81543d57fd71811f7481c0472 Mon Sep 17 00:00:00 2001
From: Tejun Heo <[email protected]>
Date: Mon, 22 Apr 2024 10:03:13 -1000
Subject: [PATCH] workqueue: Use "@..." in function comment to describe
variable length argument

Previously, it was using "remaining args" without leading "@" which isn't
valid. Let's follow snprintf()'s example and use "@...".

Signed-off-by: Tejun Heo <[email protected]>
Reported-by: Stephen Rothwell <[email protected]>
---
include/linux/workqueue.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/workqueue.h b/include/linux/workqueue.h
index 2df1188c0f96..fb3993894536 100644
--- a/include/linux/workqueue.h
+++ b/include/linux/workqueue.h
@@ -473,7 +473,7 @@ void workqueue_softirq_dead(unsigned int cpu);
* @fmt: printf format for the name of the workqueue
* @flags: WQ_* flags
* @max_active: max in-flight work items, 0 for default
- * remaining args: args for @fmt
+ * @...: args for @fmt
*
* For a per-cpu workqueue, @max_active limits the number of in-flight work
* items for each CPU. e.g. @max_active of 1 indicates that each CPU can be
--
2.44.0