Skip to contentSkip to conversation

man/protocol-options: add missing ending metachar

PATCH Superseded Antonio Quartulli 2 participants 3 messages Aug 27, 2021 – Aug 28, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 man/protocol-options: add missing ending metachar

A code string terminating character (`) is missing, thus leading to the following warning:

man-sections/protocol-options.rst:99: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.

Add missing char at the end of the code word.

---
 doc/man-sections/protocol-options.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/man-sections/protocol-options.rst +1 -1
index 5ae780e1..05366011 100644
@@ -99,7 +99,7 @@ configured in a compatible way between both the local and remote side.
   Especially :code:`stub-v2` is essentially identical to no compression and
   no compression framing as its header indicates IP version 5 in a tun setup
   and can (ab)used to complete disable compression to clients. (See the
-  :code:`migrate option below)
+  :code:`migrate option below`)
 
   If the ``algorithm`` parameter is :code:`stub`, :code:`stub-v2` or empty,
   compression will be turned off, but the packet framing for compression
Signature · 1 line
2.31.1
#1 lore raw

PATCH v2 1/1 man/protocol-options: add missing ending metachar

A code string terminating character (`) is missing, thus leading to the following warning:

man-sections/protocol-options.rst:99: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.

Add missing char at the end of the code word.

---

v2:
- Add the ' right after "migrate"

 doc/man-sections/protocol-options.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/man-sections/protocol-options.rst +1 -1
index 5ae780e1..c701c563 100644
@@ -99,7 +99,7 @@ configured in a compatible way between both the local and remote side.
   Especially :code:`stub-v2` is essentially identical to no compression and
   no compression framing as its header indicates IP version 5 in a tun setup
   and can (ab)used to complete disable compression to clients. (See the
-  :code:`migrate option below)
+  :code:`migrate` option below)
 
   If the ``algorithm`` parameter is :code:`stub`, :code:`stub-v2` or empty,
   compression will be turned off, but the packet framing for compression
Signature · 1 line
2.31.1
Acked-by on v2 1/1
#2 lore raw

"obviously correct" :-)

Your patch has been applied to the master branch.

commit 5a5d11a0dea51e709b44dfabc1ec97b5f3c5b222 (master)

Author: Antonio Quartulli
Date:   Fri Aug 27 16:56:56 2021 +0200
     man/protocol-options: add missing ending metachar

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

--
kind regards,

Gert Doering