Subject: Re: [PATCH] Documentation: networking: Fix Column span alignment warnings in l2tp.rst

From: Tom Parkin <[email-masked]>
Date: Wed, 18 Nov 2020 10:23:07 +0000

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