netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Tom Parkin <tparkin@katalix.com>
To: siddhant gupta <siddhantgupta416@gmail.com>
Cc: davem@davemloft.net, kuba@kernel.org, corbet@lwn.net,
	netdev@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Mamta Shukla <mamtashukla555@gmail.com>,
	Himadri Pandya <himadrispandya@gmail.com>
Subject: Re: [PATCH] Documentation: networking: Fix Column span alignment warnings in l2tp.rst
Date: Thu, 19 Nov 2020 09:45:48 +0000	[thread overview]
Message-ID: <20201119094548.GA3927@katalix.com> (raw)
In-Reply-To: <CA+imup-3pT47CVL7GZn_vJtHGngNexBR060y2gRfw2v5Gr8P0Q@mail.gmail.com>

[-- 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 --]

      parent reply	other threads:[~2020-11-19  9:45 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 message]

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=20201119094548.GA3927@katalix.com \
    --to=tparkin@katalix.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=himadrispandya@gmail.com \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mamtashukla555@gmail.com \
    --cc=netdev@vger.kernel.org \
    --cc=siddhantgupta416@gmail.com \
    /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 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).