[Openvpn-devel,v2] man/protocol-options: add missing ending metachar

Message ID 20210827145656.21646-1-a@unstable.cc
State Accepted
Headers show
Series
  • [Openvpn-devel,v2] man/protocol-options: add missing ending metachar
Related show

Commit Message

Antonio Quartulli Aug. 27, 2021, 2:56 p.m.
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.

Cc: David Sommerseth <davids@openvpn.net>
Signed-off-by: Antonio Quartulli <a@unstable.cc>
---

v2:
- Add the ' right after "migrate"

 doc/man-sections/protocol-options.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Gert Doering Aug. 28, 2021, 1:59 p.m. | #1
Acked-by: Gert Doering <gert@greenie.muc.de>

"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 <a@unstable.cc>
     Acked-by: Gert Doering <gert@greenie.muc.de>
     Message-Id: <20210827145656.21646-1-a@unstable.cc>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg22779.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 5ae780e1..c701c563 100644
--- a/doc/man-sections/protocol-options.rst
+++ b/doc/man-sections/protocol-options.rst
@@ -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