2024-01-28 08:31:13

by Randy Dunlap

Subject: [PATCH v2] usb: gadget: fix max_segment_size malformed table

Sphinx reports a malformed table due to the table begin/end line
segments being too short for the word "max_segment_size", so
extend them by one more '=' character to prevent the error.

Documentation/usb/gadget-testing.rst:459: ERROR: Malformed table.
Text in column margin in table line 9.

Fixes: 1900daeefd3e ("usb: gadget: ncm: Add support to update wMaxSegmentSize via configfs")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Krishna Kurapati <[email protected]>
Cc: Greg Kroah-Hartman <[email protected]>
Cc: [email protected]
Cc: Jonathan Corbet <[email protected]>
Cc: [email protected]
Cc: Sergei Shtylyov <[email protected]>
---
v2: s /to error/the error/ in the patch description.

Documentation/usb/gadget-testing.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff -- a/Documentation/usb/gadget-testing.rst b/Documentation/usb/gadget-testing.rst
--- a/Documentation/usb/gadget-testing.rst
+++ b/Documentation/usb/gadget-testing.rst
@@ -448,7 +448,7 @@ 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
@@ -458,7 +458,7 @@ The NCM function provides these attribut
Ethernet over USB link
max_segment_size Segment size required for P2P connections. This
will set MTU to (max_segment_size - 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.

2024-01-30 21:12:33

by Jonathan Corbet

Subject: Re: [PATCH v2] usb: gadget: fix max_segment_size malformed table

Randy Dunlap <[email protected]> writes:

> Sphinx reports a malformed table due to the table begin/end line
> segments being too short for the word "max_segment_size", so
> extend them by one more '=' character to prevent the error.
>
> Documentation/usb/gadget-testing.rst:459: ERROR: Malformed table.
> Text in column margin in table line 9.
>
> Fixes: 1900daeefd3e ("usb: gadget: ncm: Add support to update wMaxSegmentSize via configfs")
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Krishna Kurapati <[email protected]>
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: [email protected]
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> Cc: Sergei Shtylyov <[email protected]>
> ---
> v2: s /to error/the error/ in the patch description.
>
> Documentation/usb/gadget-testing.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)

Applied, thanks.

jon