linux-kernel - [PATCH] doc: Fix malformed table in gadget-testing.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20240128195731.40003-1-kohshi54.yam@gmail.com>
Date: Mon, 29 Jan 2024 04:57:31 +0900
From: Kohshi Yamaguchi <kohshi54.yam@...il.com>
To: gregkh@...uxfoundation.org,
	corbet@....net
Cc: Kohshi Yamaguchi <kohshi54.yam@...il.com>,
	linux-usb@...r.kernel.org,
	linux-doc@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	skhan@...uxfoundation.org
Subject: [PATCH] doc: Fix malformed table in gadget-testing.rst

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@...il.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