On Tue, 2023-04-04 at 18:55 +1000, Stephen Rothwell wrote:
> Hi Bastien,
>
> On Tue, 04 Apr 2023 10:22:35 +0200 Bastien Nocera <hadess@xxxxxxxxxx>
> wrote:
> >
> > On Tue, 2023-04-04 at 15:42 +1000, Stephen Rothwell wrote:
> > >
> > > On Tue, 4 Apr 2023 15:40:05 +1000 Stephen Rothwell
> > > <sfr@xxxxxxxxxxxxxxxx> wrote:
> > > >
> > > > After merging the hid tree, today's linux-next build (htmldocs)
> > > > produced
> > > > this warning:
> > > >
> > > > drivers/usb/core/message.c:1939: warning: Function parameter or
> > > > member 'iface' not described in 'usb_set_wireless_status'
> > > > drivers/usb/core/message.c:1939: warning: Excess function
> > > > parameter
> > > > 'dev' description in 'usb_set_wireless_status'
> > > >
> > > > Introduced by commit
> > > >
> > > > 0a4db185f078 ("USB: core: Add API to change the
> > > > wireless_status")
> > >
> > > Also this:
> > >
> > > include/linux/usb.h:270: warning: Function parameter or member
> > > 'wireless_status_work' not described in 'usb_interface'
> >
> > How does one reproduce those warnings?
>
> I just ran "make htmldocs" (see above). You may need to install some
> software - but it will tell you if so.
>
Before I send patches, does this look correct to you?
diff --git a/drivers/usb/core/message.c b/drivers/usb/core/message.c
index 7930dca84616..7c7f88ca4f62 100644
--- a/drivers/usb/core/message.c
+++ b/drivers/usb/core/message.c
@@ -1926,7 +1926,7 @@ static void __usb_wireless_status_intf(struct work_struct *ws)
1926⋮1926│
1927⋮1927│ /**
1928⋮1928│ * usb_set_wireless_status - sets the wireless_status struct member
1929⋮ │- * @dev: the device to modify
⋮1929│+ * @iface: the interface to modify
1930⋮1930│ * @status: the new wireless status
1931⋮1931│ *
1932⋮1932│ * Set the wireless_status struct member to the new value, and emit
diff --git a/include/linux/usb.h b/include/linux/usb.h
index a48eeec62a66..3d523ebf0c09 100644
--- a/include/linux/usb.h
+++ b/include/linux/usb.h
@@ -261,7 +261,8 @@ struct usb_interface {
261⋮ 261│ unsigned needs_binding:1; /* needs delayed unbind/rebind */
262⋮ 262│ unsigned resetting_device:1; /* true: bandwidth alloc after reset */
263⋮ 263│ unsigned authorized:1; /* used for interface authorization */
264⋮ │- enum usb_wireless_status wireless_status;
⋮ 264│+ enum usb_wireless_status wireless_status; /* whether the emitter is
⋮ 265│+ * connected to this receiver */
265⋮ 266│ struct work_struct wireless_status_work;
266⋮ 267│
267⋮ 268│ struct device dev; /* interface specific device info */
