[Openvpn-devel,v2] t_client.rc-sample: Add missing documentation for FPING_ARGS_x

Message ID 20260808072427.6344-1-gert@greenie.muc.de
State New
Headers
Series [Openvpn-devel,v2] t_client.rc-sample: Add missing documentation for FPING_ARGS_x |

Commit Message

Gert Doering Aug. 8, 2026, 7:24 a.m. UTC
  From: Frank Lichtenheld <frank@lichtenheld.com>

Also include some smaller misc documentation fixes.

Change-Id: Ib6956c3a8b332866a59b41c186cce4e0bc5f078f
Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
Acked-by: Arne Schwabe <arne-openvpn@rfc2549.org>
Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1791
---

This change was reviewed on Gerrit and approved by at least one
developer. I request to merge it to master.

Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1791
This mail reflects revision 2 of this Change.

Acked-by according to Gerrit (reflected above):
Arne Schwabe <arne-openvpn@rfc2549.org>
  

Patch

diff --git a/tests/t_client.rc-sample b/tests/t_client.rc-sample
index d07c376..defa4aa 100644
--- a/tests/t_client.rc-sample
+++ b/tests/t_client.rc-sample
@@ -8,9 +8,13 @@ 
 # define these - if empty, no tests will run
 #
 top_srcdir="${top_srcdir:-..}"
+
+# PKI args
 CA_CERT="${top_srcdir}/sample/sample-keys/ca.crt"
 CLIENT_KEY="${top_srcdir}/sample/sample-keys/client.key"
 CLIENT_CERT="${top_srcdir}/sample/sample-keys/client.crt"
+
+# Customize ping tests
 #FPING_EXTRA_ARGS="-t 1000"
 
 # Load EXPECT_IFCONFIG* parameters from cache
@@ -63,8 +67,8 @@ 
 
 #
 #
-# now define the individual tests - all variables suffixed with _1, _2 etc
-# will be used in test run "1", "2", etc.
+# now define the individual tests - all variables suffixed with _1, _2, _2n etc
+# will be used in test run "1", "2", "2n" etc.
 #
 # if something is not defined here, the corresponding test is not run
 #
@@ -86,6 +90,7 @@ 
 #
 # hook test options:
 #
+# FPING_ARGS_x      = "arguments to append to the fping command line"
 # CHECK_SKIP_x      = "commands to execute before openvpn, skip test on failure"
 # PREPARE_x         = "commands to execute before openvpn"
 # POSTINIT_CMD_x    = "commands to execute after openvpn but before ping"