lkml.org 
[lkml]   [2015]   [Jan]   [15]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH] usb: Fix typo in `struct usb_host_interface' comment
From
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


\
 
 \ /
  Last update: 2015-01-16 01:01    [W:1.603 / U:0.012 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site