2024-01-08 12:45:24

by Udipto Goswami

Subject: [PATCH] usb: gadget: ncm: Fix indentations in documentation of NCM section

Currently, the section of NCM which describes attributes are having wrong
indentation.

Fix this by following the correct format recommended.

Fixes: 1900daeefd3e ("usb: gadget: ncm: Add support to update wMaxSegmentSize via configfs")
Signed-off-by: Udipto Goswami <[email protected]>
---
Documentation/usb/gadget-testing.rst | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
index 8cd62c466d20..077dfac7ed98 100644
--- a/Documentation/usb/gadget-testing.rst
+++ b/Documentation/usb/gadget-testing.rst
@@ -448,17 +448,17 @@ Function-specific configfs interface
The function name to use when creating the function directory is "ncm".
The NCM function provides these attributes in its function directory:

- =============== ==================================================
- ifname network device interface name associated with this
- function instance
- qmult queue length multiplier for high and super speed
- host_addr MAC address of host's end of this
- Ethernet over USB link
- dev_addr MAC address of device's end of this
- Ethernet over USB link
- max_segment_size Segment size required for P2P connections. This
- will set MTU to (max_segment_size - 14 bytes)
- =============== ==================================================
+ ======================= ==================================================
+ ifname network device interface name associated with this
+ function instance
+ qmult queue length multiplier for high and super speed
+ host_addr MAC address of host's end of this
+ Ethernet over USB link
+ dev_addr MAC address of device's end of this
+ Ethernet over USB link
+ max_segment_size Segment size required for P2P connections. This
+ will set MTU to 14 bytes
+ ======================= ==================================================

and after creating the functions/ncm.<instance name> they contain default
values: qmult is 5, dev_addr and host_addr are randomly selected.
--
2.17.1

2024-01-08 12:50:25

by Greg Kroah-Hartman

Subject: Re: [PATCH] usb: gadget: ncm: Fix indentations in documentation of NCM section

On Mon, Jan 08, 2024 at 06:06:02PM +0530, Udipto Goswami wrote:
> Currently, the section of NCM which describes attributes are having wrong
> indentation.
>
> Fix this by following the correct format recommended.
>
> Fixes: 1900daeefd3e ("usb: gadget: ncm: Add support to update wMaxSegmentSize via configfs")
> Signed-off-by: Udipto Goswami <[email protected]>
> ---
> Documentation/usb/gadget-testing.rst | 22 +++++++++++-----------
> 1 file changed, 11 insertions(+), 11 deletions(-)

This was reported in linux-next so it needs a "reported-by:" tag, right?

thanks,

greg k-h

2024-01-08 13:14:38

by Udipto Goswami

Subject: Re: [PATCH] usb: gadget: ncm: Fix indentations in documentation of NCM section

On 1/8/2024 6:15 PM, Greg Kroah-Hartman wrote:
> On Mon, Jan 08, 2024 at 06:06:02PM +0530, Udipto Goswami wrote:
>> Currently, the section of NCM which describes attributes are having wrong
>> indentation.
>>
>> Fix this by following the correct format recommended.
>>
>> Fixes: 1900daeefd3e ("usb: gadget: ncm: Add support to update wMaxSegmentSize via configfs")
>> Signed-off-by: Udipto Goswami <[email protected]>
>> ---
>> Documentation/usb/gadget-testing.rst | 22 +++++++++++-----------
>> 1 file changed, 11 insertions(+), 11 deletions(-)
>
> This was reported in linux-next so it needs a "reported-by:" tag, right?

right, apologies!
Will address in v2.

Thanks,
-Udipto