[Openvpn-devel] Fix description of --client-disconnect calling convention in manpage.

Message ID 20200909122926.9523-1-gert@greenie.muc.de
State Accepted
Headers show
Series
  • [Openvpn-devel] Fix description of --client-disconnect calling convention in manpage.
Related show

Commit Message

Gert Doering Sept. 9, 2020, 12:29 p.m.
The man page claimed that --client-disconnect "is passed the same
pathname as the corresponding --client-connect command", which is
not what the code does.  Fix.

Reported-By: hvenev in Trac
Trac: #884

Signed-off-by: Gert Doering <gert@greenie.muc.de>
---
 doc/man-sections/script-options.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

Antonio Quartulli Sept. 11, 2020, 12:35 p.m. | #1
Hi,

On 09/09/2020 14:29, Gert Doering wrote:
> The man page claimed that --client-disconnect "is passed the same
> pathname as the corresponding --client-connect command", which is
> not what the code does.  Fix.
> 
> Reported-By: hvenev in Trac
> Trac: #884
> 
> Signed-off-by: Gert Doering <gert@greenie.muc.de>

Checked the code and I agree with Gert fix to the documentation.
No additional argument is passed.

Acked-by: Antonio Quartulli <a@unstable.cc>
Gert Doering Sept. 11, 2020, 12:43 p.m. | #2
Patch has been applied to the master and release/2.5 branch.

For 2.4, the textual change was applied to doc/openvpn.8, with
nroff formatting.

commit 50c7700da09a1f83474e18f8709d59dbc4b509e2 (master)
commit 79910a3d2d78ec8c1b9becbd169eb9074fb242dd (release/2.5)
commit 9481cca682112b502f83afe537164fcdb0606e55 (release/2.4)
Author: Gert Doering
Date:   Wed Sep 9 14:29:26 2020 +0200

     Fix description of --client-disconnect calling convention in manpage.

     Signed-off-by: Gert Doering <gert@greenie.muc.de>
     Acked-by: Antonio Quartulli <a@unstable.cc>
     Message-Id: <20200909122926.9523-1-gert@greenie.muc.de>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg20929.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/doc/man-sections/script-options.rst b/doc/man-sections/script-options.rst
index b4bbf52f..a4df6732 100644
--- a/doc/man-sections/script-options.rst
+++ b/doc/man-sections/script-options.rst
@@ -157,9 +157,8 @@  SCRIPT HOOKS
   where some of the related client-connect functions returned an error
   status.
 
-  The ``--client-disconnect`` command is passed the same pathname as the
-  corresponding ``--client-connect`` command as its last argument (after
-  any arguments specified in ``cmd``).
+  The ``--client-disconnect`` command is not passed any extra arguments
+  (only those arguments specified in cmd, if any).
 
 --down cmd
   Run command ``cmd`` after TUN/TAP device close (post ``--user`` UID