[Openvpn-devel] doc: fix indentation in protocol-options.rst

Message ID 20210921121519.18912-1-a@unstable.cc
State Accepted
Headers show
Series
  • [Openvpn-devel] doc: fix indentation in protocol-options.rst
Related show

Commit Message

Antonio Quartulli Sept. 21, 2021, 12:15 p.m.
The bullet points are not proeprly indented and they trigger
the following error/warning:

rst2man.py openvpn.8.rst > openvpn.8
man-sections/protocol-options.rst:62: (ERROR/3) Unexpected indentation.
man-sections/protocol-options.rst:67: (WARNING/2) Block quote 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/protocol-options.rst:62: (ERROR/3) Unexpected indentation.
man-sections/protocol-options.rst:67: (WARNING/2) Block quote ends without a blank line; unexpected unindent.

Fix indentation and add white lines as expected.

Signed-off-by: Antonio Quartulli <a@unstable.cc>
---
 doc/man-sections/protocol-options.rst | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

Comments

Gert Doering Sept. 21, 2021, 1:50 p.m. | #1
Acked-by: Gert Doering <gert@greenie.muc.de>

.. that's what you get when I get something to copy-paste into a .rst
file, instead of a proper patch :-P :-)

Your patch has been applied to the master branch.

commit 1b054afa9916fb0e2020ca3f04dbed6b345f8662
Author: Antonio Quartulli
Date:   Tue Sep 21 14:15:19 2021 +0200

     doc: fix indentation in protocol-options.rst

     Signed-off-by: Antonio Quartulli <a@unstable.cc>
     Acked-by: Gert Doering <gert@greenie.muc.de>
     Message-Id: <20210921121519.18912-1-a@unstable.cc>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg22867.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/doc/man-sections/protocol-options.rst b/doc/man-sections/protocol-options.rst
index 4125b263..c7aa6b0e 100644
--- a/doc/man-sections/protocol-options.rst
+++ b/doc/man-sections/protocol-options.rst
@@ -59,11 +59,14 @@  configured in a compatible way between both the local and remote side.
 --cipher alg
   This option should not be used any longer in TLS mode and still
   exists for two reasons:
-      * compatibility with old configurations still carrying it
-	around;
-      * allow users connecting to OpenVPN peers older than 2.6.0
-	to have ``--cipher`` configured the same way as the remote
-	counterpart. This can avoid MTU/frame size warnings.
+
+  * compatibility with old configurations still carrying it
+    around;
+
+  * allow users connecting to OpenVPN peers older than 2.6.0
+    to have ``--cipher`` configured the same way as the remote
+    counterpart. This can avoid MTU/frame size warnings.
+
   Before 2.4.0, this option was used to select the cipher to be
   configured on the data channel, however, later versions usually
   ignored this directive in favour of a negotiated cipher.