* [PATCH] Documentation: networking: Fix Column span alignment warnings in l2tp.rst
@ 2020-11-17 9:52 Siddhant Gupta
2020-11-18 10:23 ` Tom Parkin
0 siblings, 1 reply; 5+ messages in thread
From: Siddhant Gupta @ 2020-11-17 9:52 UTC (permalink / raw)
To: davem, kuba, corbet
Cc: netdev, linux-doc, linux-kernel, mamtashukla555, himadrispandya
Fix Column span alignment problem warnings in the file
Signed-off-by: Siddhant Gupta <siddhantgupta416@gmail.com>
---
Documentation/networking/l2tp.rst | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/Documentation/networking/l2tp.rst b/Documentation/networking/l2tp.rst
index 498b382d25a0..0c0ac4e70586 100644
--- a/Documentation/networking/l2tp.rst
+++ b/Documentation/networking/l2tp.rst
@@ -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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation: networking: Fix Column span alignment warnings in l2tp.rst
2020-11-17 9:52 [PATCH] Documentation: networking: Fix Column span alignment warnings in l2tp.rst Siddhant Gupta
@ 2020-11-18 10:23 ` Tom Parkin
2020-11-18 11:14 ` siddhant gupta
0 siblings, 1 reply; 5+ messages in thread
From: Tom Parkin @ 2020-11-18 10:23 UTC (permalink / raw)
To: Siddhant Gupta
Cc: davem, kuba, corbet, netdev, linux-doc, linux-kernel,
mamtashukla555, himadrispandya
[-- Attachment #1: Type: text/plain, Size: 4104 bytes --]
On Tue, Nov 17, 2020 at 15:22:07 +0530, Siddhant Gupta wrote:
> 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.
> Signed-off-by: Siddhant Gupta <siddhantgupta416@gmail.com>
> ---
> Documentation/networking/l2tp.rst | 26 +++++++++++++-------------
> 1 file changed, 13 insertions(+), 13 deletions(-)
>
> diff --git a/Documentation/networking/l2tp.rst b/Documentation/networking/l2tp.rst
> index 498b382d25a0..0c0ac4e70586 100644
> --- a/Documentation/networking/l2tp.rst
> +++ b/Documentation/networking/l2tp.rst
> @@ -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
>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation: networking: Fix Column span alignment warnings in l2tp.rst
2020-11-18 10:23 ` Tom Parkin
@ 2020-11-18 11:14 ` siddhant gupta
2020-11-18 20:09 ` Jakub Kicinski
2020-11-19 9:45 ` Tom Parkin
0 siblings, 2 replies; 5+ messages in thread
From: siddhant gupta @ 2020-11-18 11:14 UTC (permalink / raw)
To: Tom Parkin
Cc: davem, kuba, corbet, netdev, linux-doc, linux-kernel,
Mamta Shukla, Himadri Pandya
On Wed, 18 Nov 2020 at 15:53, Tom Parkin <tparkin@katalix.com> wrote:
>
> On Tue, Nov 17, 2020 at 15:22:07 +0530, Siddhant Gupta wrote:
> > 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.
>
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.
> > Signed-off-by: Siddhant Gupta <siddhantgupta416@gmail.com>
> > ---
> > Documentation/networking/l2tp.rst | 26 +++++++++++++-------------
> > 1 file changed, 13 insertions(+), 13 deletions(-)
> >
> > diff --git a/Documentation/networking/l2tp.rst b/Documentation/networking/l2tp.rst
> > index 498b382d25a0..0c0ac4e70586 100644
> > --- a/Documentation/networking/l2tp.rst
> > +++ b/Documentation/networking/l2tp.rst
> > @@ -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
> >
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation: networking: Fix Column span alignment warnings in l2tp.rst
2020-11-18 11:14 ` siddhant gupta
@ 2020-11-18 20:09 ` Jakub Kicinski
2020-11-19 9:45 ` Tom Parkin
1 sibling, 0 replies; 5+ messages in thread
From: Jakub Kicinski @ 2020-11-18 20:09 UTC (permalink / raw)
To: siddhant gupta
Cc: Tom Parkin, davem, corbet, netdev, linux-doc, linux-kernel,
Mamta Shukla, Himadri Pandya
On Wed, 18 Nov 2020 16:44:11 +0530 siddhant gupta wrote:
> On Wed, 18 Nov 2020 at 15:53, Tom Parkin <tparkin@katalix.com> wrote:
> >
> > On Tue, Nov 17, 2020 at 15:22:07 +0530, Siddhant Gupta wrote:
> > > 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.
> >
>
> 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.
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.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation: networking: Fix Column span alignment warnings in l2tp.rst
2020-11-18 11:14 ` siddhant gupta
2020-11-18 20:09 ` Jakub Kicinski
@ 2020-11-19 9:45 ` Tom Parkin
1 sibling, 0 replies; 5+ messages in thread
From: Tom Parkin @ 2020-11-19 9:45 UTC (permalink / raw)
To: siddhant gupta
Cc: davem, kuba, corbet, netdev, linux-doc, linux-kernel,
Mamta Shukla, Himadri Pandya
[-- Attachment #1: Type: text/plain, Size: 5301 bytes --]
On Wed, Nov 18, 2020 at 16:44:11 +0530, siddhant gupta wrote:
> On Wed, 18 Nov 2020 at 15:53, Tom Parkin <tparkin@katalix.com> wrote:
> >
> > On Tue, Nov 17, 2020 at 15:22:07 +0530, Siddhant Gupta wrote:
> > > 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.
> >
>
> 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.
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.
> > > Signed-off-by: Siddhant Gupta <siddhantgupta416@gmail.com>
> > > ---
> > > Documentation/networking/l2tp.rst | 26 +++++++++++++-------------
> > > 1 file changed, 13 insertions(+), 13 deletions(-)
> > >
> > > diff --git a/Documentation/networking/l2tp.rst b/Documentation/networking/l2tp.rst
> > > index 498b382d25a0..0c0ac4e70586 100644
> > > --- a/Documentation/networking/l2tp.rst
> > > +++ b/Documentation/networking/l2tp.rst
> > > @@ -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
> > >
--
Tom Parkin
Katalix Systems Ltd
https://katalix.com
Catalysts for your Embedded Linux software development
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2020-11-19 9:45 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-11-17 9:52 [PATCH] Documentation: networking: Fix Column span alignment warnings in l2tp.rst Siddhant Gupta
2020-11-18 10:23 ` Tom Parkin
2020-11-18 11:14 ` siddhant gupta
2020-11-18 20:09 ` Jakub Kicinski
2020-11-19 9:45 ` Tom Parkin
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).