diff mbox series

usb: gadget: fix max_segment_size malformed table

Message ID 20240110203558.2638-1-rdunlap@infradead.org
State New
Headers
Series usb: gadget: fix max_segment_size malformed table |

Commit Message

Randy Dunlap Jan. 10, 2024, 8:35 p.m. UTC 
  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 to 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 <rdunlap@infradead.org>
Cc: Krishna Kurapati <quic_kriskura@quicinc.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-usb@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
 Documentation/usb/gadget-testing.rst |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Sergei Shtylyov Jan. 10, 2024, 8:38 p.m. UTC | #1 
On 1/10/24 11:35 PM, Randy Dunlap wrote:

> 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 to error.

   s/to error/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 <rdunlap@infradead.org>
> Cc: Krishna Kurapati <quic_kriskura@quicinc.com>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: linux-usb@vger.kernel.org
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
[...]

MBR, Sergey
Randy Dunlap Jan. 10, 2024, 9:04 p.m. UTC | #2 
On 1/10/24 12:38, Sergei Shtylyov wrote:
> On 1/10/24 11:35 PM, Randy Dunlap wrote:
> 
>> 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 to error.
> 
>    s/to error/the error/?

yes, thanks.

> 
>> 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 <rdunlap@infradead.org>
>> Cc: Krishna Kurapati <quic_kriskura@quicinc.com>
>> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
>> Cc: linux-usb@vger.kernel.org
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: linux-doc@vger.kernel.org
> [...]
> 
> MBR, Sergey
diff mbox series

Patch

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.