From: Kohshi Yamaguchi <kohshi54.yam@gmail.com>
To: gregkh@linuxfoundation.org, corbet@lwn.net
Cc: Kohshi Yamaguchi <kohshi54.yam@gmail.com>,
linux-usb@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, skhan@linuxfoundation.org
Subject: [PATCH] doc: Fix malformed table in gadget-testing.rst
Date: Mon, 29 Jan 2024 04:57:31 +0900 [thread overview]
Message-ID: <20240128195731.40003-1-kohshi54.yam@gmail.com> (raw)
The table describing the NCM function attributes in gadget-testing.rst
was malformed, causing Sphinx build warnings. This patch fixes the table
format to align with the reStructuredText specifications.
The border lines of the table were not properly aligned with the column
headers, which was corrected by adjusting the border line lengths to
match the headers.
Signed-off-by: Kohshi Yamaguchi <kohshi54.yam@gmail.com>
---
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..1d1737f246df 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 (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.
--
2.34.1
next reply other threads:[~2024-01-28 19:57 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-28 19:57 Kohshi Yamaguchi [this message]
2024-01-29 2:59 ` [PATCH] doc: Fix malformed table in gadget-testing.rst Randy Dunlap
2024-01-29 7:50 ` Kohshi Yamaguchi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240128195731.40003-1-kohshi54.yam@gmail.com \
--to=kohshi54.yam@gmail.com \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.