linux-next: build warning after merge of the hid tree

linux-next: build warning after merge of the hid tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 427 bytes --]

Hi all,

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

include/linux/mod_devicetable.h:909: warning: Function parameter or member 'guid' not described in 'ishtp_device_id'

Introduced by commit

  fa443bc3c1e4 ("HID: intel-ish-hid: add support for MODULE_DEVICE_TABLE()")

I also notice that there is a @context description, but no field.

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the hid tree

[Jiri Kosina]

On Wed, 10 Nov 2021, Stephen Rothwell wrote:

> Hi all,
> 
> After merging the hid tree, today's linux-next build (htmldocs) produced
> this warning:
> 
> include/linux/mod_devicetable.h:909: warning: Function parameter or member 'guid' not described in 'ishtp_device_id'
> 
> Introduced by commit
> 
>   fa443bc3c1e4 ("HID: intel-ish-hid: add support for MODULE_DEVICE_TABLE()")
> 
> I also notice that there is a @context description, but no field.

Thanks for spotting it. The kerneldoc is clearly wrong there both on the 
'guid' member name, and also the description (mind the '36 char' part, 
where it should have been '16 char' instead).

Thomas, could you please send me a fixup patch for that?

Thanks,

-- 
Jiri Kosina
SUSE Labs

[PATCH] mod_devicetable: fix kdocs for ishtp_device_id

[Thomas Weißschuh]

The kdocs were copied from another device_id struct and not adapted.

Fixes: fa443bc3c1e4 ("HID: intel-ish-hid: add support for MODULE_DEVICE_TABLE()")
Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
---
 include/linux/mod_devicetable.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/include/linux/mod_devicetable.h b/include/linux/mod_devicetable.h
index befbf53c4b7c..c70abe7aaef2 100644
--- a/include/linux/mod_devicetable.h
+++ b/include/linux/mod_devicetable.h
@@ -901,8 +901,7 @@ struct dfl_device_id {
 
 /**
  * struct ishtp_device_id - ISHTP device identifier
- * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
- * @context: pointer to driver specific data
+ * @guid: GUID of the device.
  */
 struct ishtp_device_id {
 	guid_t guid;

base-commit: 7fb0413baa7f8a04caef0c504df9af7e0623d296
-- 
2.33.1

Re: [PATCH] mod_devicetable: fix kdocs for ishtp_device_id

[Jiri Kosina]

On Wed, 10 Nov 2021, Thomas Weißschuh wrote:

> The kdocs were copied from another device_id struct and not adapted.
> 
> Fixes: fa443bc3c1e4 ("HID: intel-ish-hid: add support for MODULE_DEVICE_TABLE()")
> Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>

I've added

	Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>

and applied, thanks.

-- 
Jiri Kosina
SUSE Labs