Re: [Openvpn-devel] [PATCH] doc: fix literal block in tls-options.rst

2022-05-13 Thread Heiko Hund
On Freitag, 13. Mai 2022 10:55:32 CEST Arne Schwabe wrote:
> Am 11.05.22 um 14:10 schrieb Heiko Hund:
> > +  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.
> 
>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




___
Openvpn-devel mailing list
Openvpn-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openvpn-devel


Re: [Openvpn-devel] [PATCH] doc: fix literal block in tls-options.rst

2022-05-13 Thread Arne Schwabe

Am 11.05.22 um 14:10 schrieb Heiko Hund:

Signed-off-by: Heiko Hund 
---
  doc/man-sections/tls-options.rst | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/man-sections/tls-options.rst b/doc/man-sections/tls-options.rst
index c06ee335..d51aff77 100644
--- a/doc/man-sections/tls-options.rst
+++ b/doc/man-sections/tls-options.rst
@@ -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



___
Openvpn-devel mailing list
Openvpn-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openvpn-devel


[Openvpn-devel] [PATCH] doc: fix literal block in tls-options.rst

2022-05-11 Thread Heiko Hund
Signed-off-by: Heiko Hund 
---
 doc/man-sections/tls-options.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/man-sections/tls-options.rst b/doc/man-sections/tls-options.rst
index c06ee335..d51aff77 100644
--- a/doc/man-sections/tls-options.rst
+++ b/doc/man-sections/tls-options.rst
@@ -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
-- 
2.32.0



___
Openvpn-devel mailing list
Openvpn-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openvpn-devel