* [PATCH v3 31/56] usb: dwc3: fix kernel-doc markups
[not found] <cover.1603469755.git.mchehab+huawei@kernel.org>
@ 2020-10-23 16:33 ` Mauro Carvalho Chehab
2020-10-27 6:58 ` Felipe Balbi
0 siblings, 1 reply; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2020-10-23 16:33 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Felipe Balbi,
Greg Kroah-Hartman, Heikki Krogerus, linux-kernel, linux-usb
There is a common comment marked, instead, with kernel-doc
notation.
Also, some identifiers have different names between their
prototypes and the kernel-doc markup.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
drivers/usb/dwc3/core.c | 2 +-
drivers/usb/dwc3/core.h | 2 +-
drivers/usb/gadget/composite.c | 2 +-
drivers/usb/typec/mux.c | 2 +-
include/linux/usb/composite.h | 2 +-
5 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/drivers/usb/dwc3/core.c b/drivers/usb/dwc3/core.c
index bdf0925da6b6..841daec70b6e 100644
--- a/drivers/usb/dwc3/core.c
+++ b/drivers/usb/dwc3/core.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0
-/**
+/*
* core.c - DesignWare USB3 DRD Controller Core file
*
* Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index 74323b10a64a..2f95f08ca511 100644
--- a/drivers/usb/dwc3/core.h
+++ b/drivers/usb/dwc3/core.h
@@ -1277,7 +1277,7 @@ struct dwc3_event_type {
#define DWC3_DEPEVT_EPCMDCMPLT 0x07
/**
- * struct dwc3_event_depvt - Device Endpoint Events
+ * struct dwc3_event_depevt - Device Endpoint Events
* @one_bit: indicates this is an endpoint event (not used)
* @endpoint_number: number of the endpoint
* @endpoint_event: The event we have:
diff --git a/drivers/usb/gadget/composite.c b/drivers/usb/gadget/composite.c
index 05b176c82cc5..c6d455f2bb92 100644
--- a/drivers/usb/gadget/composite.c
+++ b/drivers/usb/gadget/composite.c
@@ -1245,7 +1245,7 @@ int usb_string_id(struct usb_composite_dev *cdev)
EXPORT_SYMBOL_GPL(usb_string_id);
/**
- * usb_string_ids() - allocate unused string IDs in batch
+ * usb_string_ids_tab() - allocate unused string IDs in batch
* @cdev: the device whose string descriptor IDs are being allocated
* @str: an array of usb_string objects to assign numbers to
* Context: single threaded during gadget setup
diff --git a/drivers/usb/typec/mux.c b/drivers/usb/typec/mux.c
index b069a5122aaa..cf720e944aaa 100644
--- a/drivers/usb/typec/mux.c
+++ b/drivers/usb/typec/mux.c
@@ -71,7 +71,7 @@ struct typec_switch *fwnode_typec_switch_get(struct fwnode_handle *fwnode)
EXPORT_SYMBOL_GPL(fwnode_typec_switch_get);
/**
- * typec_put_switch - Release USB Type-C orientation switch
+ * typec_switch_put - Release USB Type-C orientation switch
* @sw: USB Type-C orientation switch
*
* Decrement reference count for @sw.
diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h
index 2040696d75b6..a2d229ab63ba 100644
--- a/include/linux/usb/composite.h
+++ b/include/linux/usb/composite.h
@@ -437,7 +437,7 @@ static inline struct usb_composite_driver *to_cdriver(
#define OS_STRING_IDX 0xEE
/**
- * struct usb_composite_device - represents one composite usb gadget
+ * struct usb_composite_dev - represents one composite usb gadget
* @gadget: read-only, abstracts the gadget's usb peripheral controller
* @req: used for control responses; buffer is pre-allocated
* @os_desc_req: used for OS descriptors responses; buffer is pre-allocated
--
2.26.2
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v3 31/56] usb: dwc3: fix kernel-doc markups
2020-10-23 16:33 ` [PATCH v3 31/56] usb: dwc3: fix kernel-doc markups Mauro Carvalho Chehab
@ 2020-10-27 6:58 ` Felipe Balbi
2020-10-28 9:08 ` Greg Kroah-Hartman
0 siblings, 1 reply; 4+ messages in thread
From: Felipe Balbi @ 2020-10-27 6:58 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Greg Kroah-Hartman,
Heikki Krogerus, linux-kernel, linux-usb
[-- Attachment #1: Type: text/plain, Size: 682 bytes --]
Hi Mauro,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> There is a common comment marked, instead, with kernel-doc
> notation.
>
> Also, some identifiers have different names between their
> prototypes and the kernel-doc markup.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> drivers/usb/dwc3/core.c | 2 +-
> drivers/usb/dwc3/core.h | 2 +-
> drivers/usb/gadget/composite.c | 2 +-
> drivers/usb/typec/mux.c | 2 +-
> include/linux/usb/composite.h | 2 +-
mind breaking this into 4 commits? One for dwc3, one for
gadget/composite, one for type/mux, and a final for composite.h.
--
balbi
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 857 bytes --]
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v3 31/56] usb: dwc3: fix kernel-doc markups
2020-10-27 6:58 ` Felipe Balbi
@ 2020-10-28 9:08 ` Greg Kroah-Hartman
2020-10-28 9:13 ` Felipe Balbi
0 siblings, 1 reply; 4+ messages in thread
From: Greg Kroah-Hartman @ 2020-10-28 9:08 UTC (permalink / raw)
To: Felipe Balbi
Cc: Mauro Carvalho Chehab, Linux Doc Mailing List, Jonathan Corbet,
Heikki Krogerus, linux-kernel, linux-usb
On Tue, Oct 27, 2020 at 08:58:47AM +0200, Felipe Balbi wrote:
>
> Hi Mauro,
>
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> > There is a common comment marked, instead, with kernel-doc
> > notation.
> >
> > Also, some identifiers have different names between their
> > prototypes and the kernel-doc markup.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > ---
> > drivers/usb/dwc3/core.c | 2 +-
> > drivers/usb/dwc3/core.h | 2 +-
> > drivers/usb/gadget/composite.c | 2 +-
> > drivers/usb/typec/mux.c | 2 +-
> > include/linux/usb/composite.h | 2 +-
>
> mind breaking this into 4 commits? One for dwc3, one for
> gadget/composite, one for type/mux, and a final for composite.h.
I'll just take these all at once, it's easy enough :)
thanks,
greg k-h
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v3 31/56] usb: dwc3: fix kernel-doc markups
2020-10-28 9:08 ` Greg Kroah-Hartman
@ 2020-10-28 9:13 ` Felipe Balbi
0 siblings, 0 replies; 4+ messages in thread
From: Felipe Balbi @ 2020-10-28 9:13 UTC (permalink / raw)
To: Greg Kroah-Hartman
Cc: Mauro Carvalho Chehab, Linux Doc Mailing List, Jonathan Corbet,
Heikki Krogerus, linux-kernel, linux-usb
[-- Attachment #1: Type: text/plain, Size: 1000 bytes --]
Greg Kroah-Hartman <gregkh@linuxfoundation.org> writes:
> On Tue, Oct 27, 2020 at 08:58:47AM +0200, Felipe Balbi wrote:
>>
>> Hi Mauro,
>>
>> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
>> > There is a common comment marked, instead, with kernel-doc
>> > notation.
>> >
>> > Also, some identifiers have different names between their
>> > prototypes and the kernel-doc markup.
>> >
>> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>> > ---
>> > drivers/usb/dwc3/core.c | 2 +-
>> > drivers/usb/dwc3/core.h | 2 +-
>> > drivers/usb/gadget/composite.c | 2 +-
>> > drivers/usb/typec/mux.c | 2 +-
>> > include/linux/usb/composite.h | 2 +-
>>
>> mind breaking this into 4 commits? One for dwc3, one for
>> gadget/composite, one for type/mux, and a final for composite.h.
>
> I'll just take these all at once, it's easy enough :)
Sure thing, in that case:
Acked-by: Felipe Balbi <balbi@kernel.org>
--
balbi
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 857 bytes --]
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-10-29 1:00 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <cover.1603469755.git.mchehab+huawei@kernel.org>
2020-10-23 16:33 ` [PATCH v3 31/56] usb: dwc3: fix kernel-doc markups Mauro Carvalho Chehab
2020-10-27 6:58 ` Felipe Balbi
2020-10-28 9:08 ` Greg Kroah-Hartman
2020-10-28 9:13 ` Felipe Balbi
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).