[Openvpn-devel] doc/ciper-negotiation.rst: avoid warning by fixing indentation

Message ID 20220110144013.7233-1-a@unstable.cc
State Accepted
Headers show
Series [Openvpn-devel] doc/ciper-negotiation.rst: avoid warning by fixing indentation | expand

Commit Message

Antonio Quartulli Jan. 10, 2022, 3:40 a.m. UTC
Indentation is wrong and triggers the following:

rst2man.py openvpn.8.rst > openvpn.8
man-sections/cipher-negotiation.rst:20: (WARNING/2) Definition list ends without a blank line; unexpected unindent.
rst2man.py openvpn-examples.5.rst > openvpn-examples.5
rst2html.py openvpn.8.rst > openvpn.8.html
man-sections/cipher-negotiation.rst:20: (WARNING/2) Definition list ends without a blank line; unexpected unindent.

Get rid of it.

Signed-off-by: Antonio Quartulli <a@unstable.cc>
---
 doc/man-sections/cipher-negotiation.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Arne Schwabe Jan. 10, 2022, 3:43 a.m. UTC | #1
Am 10.01.22 um 15:40 schrieb Antonio Quartulli:
> Indentation is wrong and triggers the following:
> 
> rst2man.py openvpn.8.rst > openvpn.8
> man-sections/cipher-negotiation.rst:20: (WARNING/2) Definition list ends without a blank line; unexpected unindent.
> rst2man.py openvpn-examples.5.rst > openvpn-examples.5
> rst2html.py openvpn.8.rst > openvpn.8.html
> man-sections/cipher-negotiation.rst:20: (WARNING/2) Definition list ends without a blank line; unexpected unindent.
> 
> Get rid of it.
> 
> Signed-off-by: Antonio Quartulli <a@unstable.cc>
> ---
>   doc/man-sections/cipher-negotiation.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/man-sections/cipher-negotiation.rst b/doc/man-sections/cipher-negotiation.rst
> index efa4c6c9..9bcaed0a 100644
> --- a/doc/man-sections/cipher-negotiation.rst
> +++ b/doc/man-sections/cipher-negotiation.rst
> @@ -16,7 +16,7 @@ with a AUTH_FAILED message (as seen in client log):
>       AUTH: Received control message: AUTH_FAILED,Data channel cipher negotiation failed (no shared cipher)
>   
>   OpenVPN 2.5 and later will only allow the ciphers specified in ``--data-ciphers``.
> - If ``--data-ciphers`` is not set the default is :code:`AES-256-GCM:AES-128-GCM`.
> +If ``--data-ciphers`` is not set the default is :code:`AES-256-GCM:AES-128-GCM`.
>   In 2.6 and later the default is changed to
>   :code:`AES-256-GCM:AES-128-GCM:CHACHA20-POLY1305` when Chacha20-Poly1305 is available.
>   

Acked-By: Arne Schwabe <arne@rfc2549.org>
Gert Doering Jan. 10, 2022, 6:01 a.m. UTC | #2
Your patch has been applied to the master branch.

(Fixed the subject on the fly - "s/ciper/cipher/")

commit 19835c940d2d52b121ffceb08aabc86c12d3beb9
Author: Antonio Quartulli
Date:   Mon Jan 10 15:40:13 2022 +0100

     doc/cipher-negotiation.rst: avoid warning by fixing indentation

     Signed-off-by: Antonio Quartulli <a@unstable.cc>
     Acked-by: Arne Schwabe <arne@rfc2549.org>
     Message-Id: <20220110144013.7233-1-a@unstable.cc>
     URL: https://www.mail-archive.com/search?l=mid&q=20220110144013.7233-1-a@unstable.cc
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/doc/man-sections/cipher-negotiation.rst b/doc/man-sections/cipher-negotiation.rst
index efa4c6c9..9bcaed0a 100644
--- a/doc/man-sections/cipher-negotiation.rst
+++ b/doc/man-sections/cipher-negotiation.rst
@@ -16,7 +16,7 @@  with a AUTH_FAILED message (as seen in client log):
     AUTH: Received control message: AUTH_FAILED,Data channel cipher negotiation failed (no shared cipher)
 
 OpenVPN 2.5 and later will only allow the ciphers specified in ``--data-ciphers``.
- If ``--data-ciphers`` is not set the default is :code:`AES-256-GCM:AES-128-GCM`.
+If ``--data-ciphers`` is not set the default is :code:`AES-256-GCM:AES-128-GCM`.
 In 2.6 and later the default is changed to
 :code:`AES-256-GCM:AES-128-GCM:CHACHA20-POLY1305` when Chacha20-Poly1305 is available.