* [PATCH 1/1] i3c: master: fix kernel-doc check warning
@ 2024-01-09 5:25 Frank Li
2024-01-09 8:10 ` Miquel Raynal
2024-01-14 22:01 ` Alexandre Belloni
0 siblings, 2 replies; 3+ messages in thread
From: Frank Li @ 2024-01-09 5:25 UTC (permalink / raw)
To: alexandre.belloni, linux-kernel, linux-next
Cc: conor.culhane, imx, joe, linux-i3c, miquel.raynal, zbigniew.lukwinski
Fix warning found by
'scripts/kernel-doc -v -none include/linux/i3c/master.h'
include/linux/i3c/master.h:457: warning: Function parameter or member 'enable_hotjoin' not described in 'i3c_master_controller_ops'
include/linux/i3c/master.h:457: warning: Function parameter or member 'disable_hotjoin' not described in 'i3c_master_controller_ops'
include/linux/i3c/master.h:499: warning: Function parameter or member 'hotjoin' not described in 'i3c_master_controller'
Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
include/linux/i3c/master.h | 3 +++
1 file changed, 3 insertions(+)
diff --git a/include/linux/i3c/master.h b/include/linux/i3c/master.h
index 65b8965968af2..1cbf0baca65fe 100644
--- a/include/linux/i3c/master.h
+++ b/include/linux/i3c/master.h
@@ -426,6 +426,8 @@ struct i3c_bus {
* for a future IBI
* This method is mandatory only if ->request_ibi is not
* NULL.
+ * @enable_hotjoin: enable hot join event detect.
+ * @disable_hotjoin: disable hot join event detect.
*/
struct i3c_master_controller_ops {
int (*bus_init)(struct i3c_master_controller *master);
@@ -467,6 +469,7 @@ struct i3c_master_controller_ops {
* @ops: master operations. See &struct i3c_master_controller_ops
* @secondary: true if the master is a secondary master
* @init_done: true when the bus initialization is done
+ * @hotjoin: true if the master support hotjoin
* @boardinfo.i3c: list of I3C boardinfo objects
* @boardinfo.i2c: list of I2C boardinfo objects
* @boardinfo: board-level information attached to devices connected on the bus
--
2.34.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH 1/1] i3c: master: fix kernel-doc check warning
2024-01-09 5:25 [PATCH 1/1] i3c: master: fix kernel-doc check warning Frank Li
@ 2024-01-09 8:10 ` Miquel Raynal
2024-01-14 22:01 ` Alexandre Belloni
1 sibling, 0 replies; 3+ messages in thread
From: Miquel Raynal @ 2024-01-09 8:10 UTC (permalink / raw)
To: Frank Li
Cc: alexandre.belloni, linux-kernel, linux-next, conor.culhane, imx,
joe, linux-i3c, zbigniew.lukwinski
Hi Frank,
Frank.Li@nxp.com wrote on Tue, 9 Jan 2024 00:25:48 -0500:
> Fix warning found by
> 'scripts/kernel-doc -v -none include/linux/i3c/master.h'
>
> include/linux/i3c/master.h:457: warning: Function parameter or member 'enable_hotjoin' not described in 'i3c_master_controller_ops'
> include/linux/i3c/master.h:457: warning: Function parameter or member 'disable_hotjoin' not described in 'i3c_master_controller_ops'
> include/linux/i3c/master.h:499: warning: Function parameter or member 'hotjoin' not described in 'i3c_master_controller'
>
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
Reviewed-by: Miquel Raynal <miquel.raynal@bootlin.com>
Thanks,
Miquèl
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH 1/1] i3c: master: fix kernel-doc check warning
2024-01-09 5:25 [PATCH 1/1] i3c: master: fix kernel-doc check warning Frank Li
2024-01-09 8:10 ` Miquel Raynal
@ 2024-01-14 22:01 ` Alexandre Belloni
1 sibling, 0 replies; 3+ messages in thread
From: Alexandre Belloni @ 2024-01-14 22:01 UTC (permalink / raw)
To: linux-kernel, linux-next, Frank Li
Cc: conor.culhane, imx, joe, linux-i3c, miquel.raynal, zbigniew.lukwinski
On Tue, 09 Jan 2024 00:25:48 -0500, Frank Li wrote:
> Fix warning found by
> 'scripts/kernel-doc -v -none include/linux/i3c/master.h'
>
> include/linux/i3c/master.h:457: warning: Function parameter or member 'enable_hotjoin' not described in 'i3c_master_controller_ops'
> include/linux/i3c/master.h:457: warning: Function parameter or member 'disable_hotjoin' not described in 'i3c_master_controller_ops'
> include/linux/i3c/master.h:499: warning: Function parameter or member 'hotjoin' not described in 'i3c_master_controller'
>
> [...]
Applied, thanks!
[1/1] i3c: master: fix kernel-doc check warning
commit: 34d946b723b53488ab39d8ac540ddf9db255317a
Best regards,
--
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2024-01-14 22:01 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-01-09 5:25 [PATCH 1/1] i3c: master: fix kernel-doc check warning Frank Li
2024-01-09 8:10 ` Miquel Raynal
2024-01-14 22:01 ` Alexandre Belloni
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).