Skip to contentSkip to conversation

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

PATCH In review Gert Doering 2 participants 3 messages Sep 9, 2020 – Sep 11, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Fix description of --client-disconnect calling convention in manpage.

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

---
 doc/man-sections/script-options.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
doc/man-sections/script-options.rst +2 -3
index b4bbf52f..a4df6732 100644
@@ -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
Signature · 1 line
2.26.2
Acked-by on v1 1/1
#1 lore raw

Hi,

Quoted 8 lines · Gert Doering

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

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

Signature · 1 line
Antonio Quartulli
#2 lore raw
In reply to Gert Doering

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 <[email protected]...>
     Acked-by: Antonio Quartulli <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg20929.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering