Documentation: networking: Fix Column span alignment warnings in l2tp.rst
Subsystems (3)
PATCH 1/1 Documentation: networking: Fix Column span alignment warnings in l2tp.rst
Fix Column span alignment problem warnings in the file
--- Documentation/networking/l2tp.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-)
Documentation/networking/l2tp.rst +13 -13
@@ -171,7 +171,8 @@ DEBUG N Debug flags. ================== ======== === Attribute Required Use ================== ======== === -CONN_ID N Identifies the tunnel id to be queried. +CONN_ID N Identifies the tunnel id + to be queried. Ignored in DUMP requests. ================== ======== ===
@@ -208,8 +209,8 @@ onto the new session. This is covered in "PPPoL2TP Sockets" later. ================== ======== === Attribute Required Use ================== ======== === -CONN_ID Y Identifies the parent tunnel id of the session - to be destroyed. +CONN_ID Y Identifies the parent tunnel id + of the session to be destroyed. SESSION_ID Y Identifies the session id to be destroyed. IFNAME N Identifies the session by interface name. If set, this overrides any CONN_ID and SESSION_ID
@@ -222,13 +223,12 @@ IFNAME N Identifies the session by interface name. If ================== ======== === Attribute Required Use ================== ======== === -CONN_ID Y Identifies the parent tunnel id of the session - to be modified. +CONN_ID Y Identifies the parent tunnel + id of the session to be modified. SESSION_ID Y Identifies the session id to be modified. -IFNAME N Identifies the session by interface name. If - set, this overrides any CONN_ID and SESSION_ID - attributes. Currently supported for L2TPv3 - Ethernet sessions only. +IFNAME N Identifies the session by interface name. If set, + this overrides any CONN_ID and SESSION_ID + attributes. Currently supported for L2TPv3 Ethernet sessions only. DEBUG N Debug flags. RECV_SEQ N Enable rx data sequence numbers. SEND_SEQ N Enable tx data sequence numbers.
@@ -243,10 +243,10 @@ RECV_TIMEOUT N Timeout to wait when reordering received ================== ======== === Attribute Required Use ================== ======== === -CONN_ID N Identifies the tunnel id to be queried. - Ignored for DUMP requests. -SESSION_ID N Identifies the session id to be queried. - Ignored for DUMP requests. +CONN_ID N Identifies the tunnel id + to be queried. Ignored for DUMP requests. +SESSION_ID N Identifies the session id + to be queried. Ignored for DUMP requests. IFNAME N Identifies the session by interface name. If set, this overrides any CONN_ID and SESSION_ID attributes. Ignored for DUMP
Signature · 1 line
2.25.1
Quoted 2 lines · Siddhant Gupta
Fix Column span alignment problem warnings in the file
Thanks for the patch, Siddhant.
Could you provide some information on how these warnings were triggered? Using Sphinx 2.4.4 I can't reproduce any warnings for l2tp.rst using the "make htmldocs" target.
Quoted 67 lines
Signed-off-by Siddhant Gupta <[email protected]>--- Documentation/networking/l2tp.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-)Documentation/networking/l2tp.rst +13
-13@@ -171,7 +171,8 @@ DEBUG N Debug flags. ================== ======== === Attribute Required Use ================== ======== === -CONN_ID N Identifies the tunnel id to be queried. +CONN_ID N Identifies the tunnel id + to be queried. Ignored in DUMP requests. ================== ======== ===@@ -208,8 +209,8 @@ onto the new session. This is covered in "PPPoL2TP Sockets" later. ================== ======== === Attribute Required Use ================== ======== === -CONN_ID Y Identifies the parent tunnel id of the session - to be destroyed. +CONN_ID Y Identifies the parent tunnel id + of the session to be destroyed. SESSION_ID Y Identifies the session id to be destroyed. IFNAME N Identifies the session by interface name. If set, this overrides any CONN_ID and SESSION_ID@@ -222,13 +223,12 @@ IFNAME N Identifies the session by interface name. If ================== ======== === Attribute Required Use ================== ======== === -CONN_ID Y Identifies the parent tunnel id of the session - to be modified. +CONN_ID Y Identifies the parent tunnel + id of the session to be modified. SESSION_ID Y Identifies the session id to be modified. -IFNAME N Identifies the session by interface name. If - set, this overrides any CONN_ID and SESSION_ID - attributes. Currently supported for L2TPv3 - Ethernet sessions only. +IFNAME N Identifies the session by interface name. If set, + this overrides any CONN_ID and SESSION_ID + attributes. Currently supported for L2TPv3 Ethernet sessions only. DEBUG N Debug flags. RECV_SEQ N Enable rx data sequence numbers. SEND_SEQ N Enable tx data sequence numbers.@@ -243,10 +243,10 @@ RECV_TIMEOUT N Timeout to wait when reordering received ================== ======== === Attribute Required Use ================== ======== === -CONN_ID N Identifies the tunnel id to be queried. - Ignored for DUMP requests. -SESSION_ID N Identifies the session id to be queried. - Ignored for DUMP requests. +CONN_ID N Identifies the tunnel id + to be queried. Ignored for DUMP requests. +SESSION_ID N Identifies the session id + to be queried. Ignored for DUMP requests. IFNAME N Identifies the session by interface name. If set, this overrides any CONN_ID and SESSION_ID attributes. Ignored for DUMPSignature · 1 line
2.25.1
Quoted 11 lines · Tom Parkin
Quoted 2 lines · Siddhant Gupta
Fix Column span alignment problem warnings in the file
Thanks for the patch, Siddhant.
Could you provide some information on how these warnings were triggered? Using Sphinx 2.4.4 I can't reproduce any warnings for
l2tp.rstusing the "make htmldocs" target.
I am currently using Sphinx v1.8.5 and I made use of command "make htmldocs >> doc_xxx.log 2>&1" for directing the errors into a file and the statements in the file showed me these warning, also to confirm those I tried using "rst2html" on l2tp.rst file and got same set of warnings.
Quoted 67 lines
Quoted 67 lines
Signed-off-by Siddhant Gupta <[email protected]>--- Documentation/networking/l2tp.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-)Documentation/networking/l2tp.rst +13
-14@@ -171,7 +171,8 @@ DEBUG N Debug flags. ================== ======== === Attribute Required Use ================== ======== === -CONN_ID N Identifies the tunnel id to be queried. +CONN_ID N Identifies the tunnel id + to be queried. Ignored in DUMP requests. ================== ======== ===@@ -208,8 +209,8 @@ onto the new session. This is covered in "PPPoL2TP Sockets" later. ================== ======== === Attribute Required Use ================== ======== === -CONN_ID Y Identifies the parent tunnel id of the session - to be destroyed. +CONN_ID Y Identifies the parent tunnel id + of the session to be destroyed. SESSION_ID Y Identifies the session id to be destroyed. IFNAME N Identifies the session by interface name. If set, this overrides any CONN_ID and SESSION_ID@@ -222,13 +223,12 @@ IFNAME N Identifies the session by interface name. If ================== ======== === Attribute Required Use ================== ======== === -CONN_ID Y Identifies the parent tunnel id of the session - to be modified. +CONN_ID Y Identifies the parent tunnel + id of the session to be modified. SESSION_ID Y Identifies the session id to be modified. -IFNAME N Identifies the session by interface name. If - set, this overrides any CONN_ID and SESSION_ID - attributes. Currently supported for L2TPv3 - Ethernet sessions only. +IFNAME N Identifies the session by interface name. If set, + this overrides any CONN_ID and SESSION_ID + attributes. Currently supported for L2TPv3 Ethernet sessions only. DEBUG N Debug flags. RECV_SEQ N Enable rx data sequence numbers. SEND_SEQ N Enable tx data sequence numbers.@@ -243,10 +243,10 @@ RECV_TIMEOUT N Timeout to wait when reordering received ================== ======== === Attribute Required Use ================== ======== === -CONN_ID N Identifies the tunnel id to be queried. - Ignored for DUMP requests. -SESSION_ID N Identifies the session id to be queried. - Ignored for DUMP requests. +CONN_ID N Identifies the tunnel id + to be queried. Ignored for DUMP requests. +SESSION_ID N Identifies the session id + to be queried. Ignored for DUMP requests. IFNAME N Identifies the session by interface name. If set, this overrides any CONN_ID and SESSION_ID attributes. Ignored for DUMP --2.25.1
Jakub Kicinski
maintainerQuoted 13 lines · On Wed, 18 Nov 2020 16:44:11 +0530 siddhant gupta wrote:
Quoted 11 lines · Tom Parkin
Quoted 2 lines · Siddhant Gupta
Fix Column span alignment problem warnings in the file
Thanks for the patch, Siddhant.
Could you provide some information on how these warnings were triggered? Using Sphinx 2.4.4 I can't reproduce any warnings for
l2tp.rstusing the "make htmldocs" target.
Quoted 5 lines
I am currently using Sphinx v1.8.5 and I made use of command "make htmldocs >> doc_xxx.log 2>&1" for directing the errors into a file and the statements in the file showed me these warning, also to confirm those I tried using "rst2html" on
l2tp.rstfile and got same set of warnings.
No errors here either, Sphinx 2.2.2, unless Documentation/ has some explicit rule about this let's not reshuffle text for an old version of the compiler.
Quoted 13 lines · siddhant gupta
Quoted 11 lines · Tom Parkin
Quoted 2 lines · Siddhant Gupta
Fix Column span alignment problem warnings in the file
Thanks for the patch, Siddhant.
Could you provide some information on how these warnings were triggered? Using Sphinx 2.4.4 I can't reproduce any warnings for
l2tp.rstusing the "make htmldocs" target.
Quoted 5 lines
I am currently using Sphinx v1.8.5 and I made use of command "make htmldocs >> doc_xxx.log 2>&1" for directing the errors into a file and the statements in the file showed me these warning, also to confirm those I tried using "rst2html" on
l2tp.rstfile and got same set of warnings.
Thanks for confirming.
I tried 1.8.5 here in a new virtualenv and I didn't see warnings there either.
I can easily imagine different toolchains triggering different warnings, but it's frustrating we can't reproduce them.
I have no objection to merging the patch, more interested in catching similar problems in the future.
Quoted 67 lines
Quoted 67 lines
Quoted 67 lines
Signed-off-by Siddhant Gupta <[email protected]>--- Documentation/networking/l2tp.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-)Documentation/networking/l2tp.rst +13
-14@@ -171,7 +171,8 @@ DEBUG N Debug flags. ================== ======== === Attribute Required Use ================== ======== === -CONN_ID N Identifies the tunnel id to be queried. +CONN_ID N Identifies the tunnel id + to be queried. Ignored in DUMP requests. ================== ======== ===@@ -208,8 +209,8 @@ onto the new session. This is covered in "PPPoL2TP Sockets" later. ================== ======== === Attribute Required Use ================== ======== === -CONN_ID Y Identifies the parent tunnel id of the session - to be destroyed. +CONN_ID Y Identifies the parent tunnel id + of the session to be destroyed. SESSION_ID Y Identifies the session id to be destroyed. IFNAME N Identifies the session by interface name. If set, this overrides any CONN_ID and SESSION_ID@@ -222,13 +223,12 @@ IFNAME N Identifies the session by interface name. If ================== ======== === Attribute Required Use ================== ======== === -CONN_ID Y Identifies the parent tunnel id of the session - to be modified. +CONN_ID Y Identifies the parent tunnel + id of the session to be modified. SESSION_ID Y Identifies the session id to be modified. -IFNAME N Identifies the session by interface name. If - set, this overrides any CONN_ID and SESSION_ID - attributes. Currently supported for L2TPv3 - Ethernet sessions only. +IFNAME N Identifies the session by interface name. If set, + this overrides any CONN_ID and SESSION_ID + attributes. Currently supported for L2TPv3 Ethernet sessions only. DEBUG N Debug flags. RECV_SEQ N Enable rx data sequence numbers. SEND_SEQ N Enable tx data sequence numbers.@@ -243,10 +243,10 @@ RECV_TIMEOUT N Timeout to wait when reordering received ================== ======== === Attribute Required Use ================== ======== === -CONN_ID N Identifies the tunnel id to be queried. - Ignored for DUMP requests. -SESSION_ID N Identifies the session id to be queried. - Ignored for DUMP requests. +CONN_ID N Identifies the tunnel id + to be queried. Ignored for DUMP requests. +SESSION_ID N Identifies the session id + to be queried. Ignored for DUMP requests. IFNAME N Identifies the session by interface name. If set, this overrides any CONN_ID and SESSION_ID attributes. Ignored for DUMP --2.25.1
Signature · 4 lines
Tom Parkin Katalix Systems Ltd https://katalix.com Catalysts for your Embedded Linux software development