[PATCH] usb: Fix typo in `struct usb_host_interface' comment

[PATCH] usb: Fix typo in `struct usb_host_interface' comment

[Chris Rorvick]

The descriptor member `bNumEndpoints' is plural.

Signed-off-by: Chris Rorvick <chris@rorvick.com>
---
 include/linux/usb.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/usb.h b/include/linux/usb.h
index f89c24a..4add566 100644
--- a/include/linux/usb.h
+++ b/include/linux/usb.h
@@ -82,7 +82,7 @@ struct usb_host_interface {
 	int extralen;
 	unsigned char *extra;   /* Extra descriptors */
 
-	/* array of desc.bNumEndpoint endpoints associated with this
+	/* array of desc.bNumEndpoints endpoints associated with this
 	 * interface setting.  these will be in no particular order.
 	 */
 	struct usb_host_endpoint *endpoint;
-- 
2.1.0

Re: [PATCH] usb: Fix typo in `struct usb_host_interface' comment

[Oliver Neukum]

On Wed, 2015-01-14 at 21:52 -0600, Chris Rorvick wrote:
> The descriptor member `bNumEndpoints' is plural.

I am afraid that is not a good idea. The name of a
member of a structure mentioned in the specification should
appear as it is used in the specification.

	Regards
		Oliver

Re: [PATCH] usb: Fix typo in `struct usb_host_interface' comment

[Chris Rorvick]

On Thu, Jan 15, 2015 at 5:03 AM, Oliver Neukum <oneukum@suse.de> wrote:
> On Wed, 2015-01-14 at 21:52 -0600, Chris Rorvick wrote:
>> The descriptor member `bNumEndpoints' is plural.
>
> I am afraid that is not a good idea. The name of a
> member of a structure mentioned in the specification should
> appear as it is used in the specification.

Where is it not plural in the specification?

Re: [PATCH] usb: Fix typo in `struct usb_host_interface' comment

[Chris Rorvick]

On Thu, Jan 15, 2015 at 6:54 AM, Chris Rorvick <chris@rorvick.com> wrote:
> On Thu, Jan 15, 2015 at 5:03 AM, Oliver Neukum <oneukum@suse.de> wrote:
>> On Wed, 2015-01-14 at 21:52 -0600, Chris Rorvick wrote:
>>> The descriptor member `bNumEndpoints' is plural.
>>
>> I am afraid that is not a good idea. The name of a
>> member of a structure mentioned in the specification should
>> appear as it is used in the specification.
>
> Where is it not plural in the specification?

I think understand your comment now so I will respond more specifically:
This is a typo precisely because `bNumEndpoint' is not consistent with
the specification, nor is it consistent with the definition of `struct
usb_interface_descriptor'.  The specification and the structure both use
`bNumEndpoints'.

Fixing this has utility because `struct usb_interface_descriptor' is not
defined in <linux/usb.h>.  So, if corrected, the code for determining
the number of endpoints is readily available to anyone looking at
`struct usb_host_interface' without tracking down the uapi header.

Mentioning that the descriptor member/field is plural was just an
attempt to make it easy to see what changed.

Regards,

Chris

Re: [PATCH] usb: Fix typo in `struct usb_host_interface' comment

[Oliver Neukum]

On Thu, 2015-01-15 at 17:47 -0600, Chris Rorvick wrote:
> I think understand your comment now so I will respond more
> specifically:
> This is a typo precisely because `bNumEndpoint' is not consistent with
> the specification, nor is it consistent with the definition of `struct
> usb_interface_descriptor'.  The specification and the structure both
> use
> `bNumEndpoints'.

Sorry, I stand corrected. The patch is good.

	Regards
		Oliver