| Message ID | 20220511121038.1002898-1-heiko@ist.eigentlich.net |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [Openvpn-devel] doc: fix literal block in tls-options.rst | expand |
Am 11.05.22 um 14:10 schrieb Heiko Hund: > Signed-off-by: Heiko Hund <heiko@ist.eigentlich.net> > --- > 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
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
Acked-by: Gert Doering <gert@greenie.muc.de> 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 <heiko@ist.eigentlich.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20220511121038.1002898-1-heiko@ist.eigentlich.net> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg24320.html Signed-off-by: Gert Doering <gert@greenie.muc.de> -- kind regards, Gert Doering
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
Signed-off-by: Heiko Hund <heiko@ist.eigentlich.net> --- doc/man-sections/tls-options.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)