2021-12-21 02:57:05

by Yang Li

Subject: [PATCH -next] mux: Fix struct mux_state kernel-doc comment

A warning is reported because a colon was dropped, it is found by running
scripts/kernel-doc, which is caused by using 'make W=1'.
drivers/mux/core.c:44: warning: Function parameter or member 'state' not
described in 'mux_state'

Reported-by: Abaci Robot <[email protected]>
Fixes: f20e55504ef4 ("mux: Add support for reading mux state from consumer DT node")
Signed-off-by: Yang Li <[email protected]>
---
drivers/mux/core.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/mux/core.c b/drivers/mux/core.c
index 7d38e7c0c02e..c0cf27582299 100644
--- a/drivers/mux/core.c
+++ b/drivers/mux/core.c
@@ -33,7 +33,7 @@
* struct mux_state - Represents a mux controller state specific to a given
* consumer.
* @mux: Pointer to a mux controller.
- * @state State of the mux to be selected.
+ * @state: State of the mux to be selected.
*
* This structure is specific to the consumer that acquires it and has
* information specific to that consumer.
--
2.20.1.7.g153144c

2021-12-21 22:33:00

by Peter Rosin

Subject: Re: [PATCH -next] mux: Fix struct mux_state kernel-doc comment

Hi!

On 2021-12-21 03:56, Yang Li wrote:
> A warning is reported because a colon was dropped, it is found by running
> scripts/kernel-doc, which is caused by using 'make W=1'.
> drivers/mux/core.c:44: warning: Function parameter or member 'state' not
> described in 'mux_state'
>
> Reported-by: Abaci Robot <[email protected]>
> Fixes: f20e55504ef4 ("mux: Add support for reading mux state from consumer DT node")
> Signed-off-by: Yang Li <[email protected]>

Applied, but I dropped the Fixes tag. Greg will probably not do a raw
pull and instead add his sign-off on the individual patches, so everything
will get new hashes anyway.

Cheers,
Peter