Skip to contentSkip to conversation

doc: fix literal block in tls-options.rst

PATCH In review Heiko Hund 3 participants 4 messages May 11, 2022 – May 28, 2022

lore
Share & tools
lore

Heiko Hund

author
#0 lore raw

PATCH 1/1 doc: fix literal block in tls-options.rst

---
 doc/man-sections/tls-options.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
doc/man-sections/tls-options.rst +2 -2
index c06ee335..d51aff77 100644
@@ -487,8 +487,8 @@ certificates and keys: https://github.com/OpenVPN/easy-rsa
 
 --tls-crypt-v2 keyfile
 
-  Valid syntax:
-  ::
+  Valid syntax::
+
      tls-crypt-v2 keyfile
      tls-crypt-v2 keyfile force-cookie
      tls-crypt-v2 keyfile allow-noncookie
Signature · 1 line
2.32.0
#1 lore raw

Am 11.05.22 um 14:10 schrieb Heiko Hund:

Quoted 10 lines
---
  doc/man-sections/tls-options.rst | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)
doc/man-sections/tls-options.rst +0 -0
index c06ee335..d51aff77 100644

doc/man-sections/tls-options.rst certificates and keys: https://github.com/OpenVPN/easy-rsa · line 494

Quoted 10 lines
doc/man-sections/tls-options.rst +2 -2
@@ -487,8 +487,8 @@ certificates and keys: https://github.com/OpenVPN/easy-rsa
 
  --tls-crypt-v2 keyfile
 
-  Valid syntax:
-  ::
+  Valid syntax::
+
       tls-crypt-v2 keyfile
       tls-crypt-v2 keyfile force-cookie
       tls-crypt-v2 keyfile allow-noncookie

I don't understand this to be honest. I don't have a good about rst but all other instances of Valid syntax use the form like what was before the patch, e.g.

Valid syntax:
::

    peer-fingerprint AD:B0:95:D8:09:...

So why exactly does this one need to be different?

Arne

author
#2 lore raw
Quoted 7 lines · On Freitag, 13. Mai 2022 10:55:32 CEST Arne Schwabe wrote:

Am 11.05.22 um 14:10 schrieb Heiko Hund:

Quoted 1 line

+ Valid syntax::

I don't understand this to be honest. I don't have a good about rst but all other instances of Valid syntax use the form like what was before the patch, e.g.

Quoted 5 lines
   Valid syntax:

     peer-fingerprint AD:B0:95:D8:09:...

So why exactly does this one need to be different?

It doesn't need to. :: on an end of line are replaced by a single : and serve the same formatting purpose as :: on a separate line followed by a blank line:

https://docutils.sourceforge.io/docs/user/rst/quickref.html#literal-blocks

Thought it is easier on the eye here, because it is possible. The actual problem is that a blank line after the :: is missing. Let me know if I should send a version with :: separate.

Cheers
Heiko

Acked-by on v1 1/1
#3 lore raw
In reply to Heiko Hund

I think this was duly discussed, fixed a real formatting issue (blank line missing), and whether or not "::" should be on a separate line or not can be clarified separately. For now, fix the issue.

(I have no idea about .rst, but the explanation + URL given sounds reasonable)

Your patch has been applied to the master branch.

commit ceeb37a6c728dc9bf4ae19637aa320f02806b6ff

Author: Heiko Hund
Date:   Wed May 11 14:10:38 2022 +0200
     doc: fix literal block in tls-options.rst

     Signed-off-by: Heiko Hund <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg24320.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering