From d5b1a30c2f341fe358be04ccc3d1050769c01687 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Tue, 5 Apr 2022 22:00:17 +0200 Subject: [PATCH] Documentation improvements Signed-off-by: Gilles Peskine --- tests/ssl-opt.sh | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/tests/ssl-opt.sh b/tests/ssl-opt.sh index 82e2023c8..fb3b3f08e 100755 --- a/tests/ssl-opt.sh +++ b/tests/ssl-opt.sh @@ -323,7 +323,7 @@ adapt_cmd_for_psk () { # with a pre-shared key, skip it. If the test looks like it's already using # a pre-shared key, do nothing. # -# This code does not consider builds with ECDH-PSK or RSA-PSK. +# This code does not consider builds with ECDHE-PSK or RSA-PSK. # # Inputs: # * $CLI_CMD, $SRV_CMD, $PXY_CMD: client/server/proxy commands. @@ -862,6 +862,14 @@ find_in_both() { # # Analyze and possibly instrument $PXY_CMD, $CLI_CMD, $SRV_CMD to pass # extra arguments or go through wrappers. +# +# Inputs: +# * $@: supplemental options to run_test() (after the mandatory arguments). +# * $CLI_CMD, $PXY_CMD, $SRV_CMD: the client, proxy and server commands. +# * $DTLS: 1 if DTLS, otherwise 0. +# +# Outputs: +# * $CLI_CMD, $PXY_CMD, $SRV_CMD: may be tweaked. analyze_test_commands() { # if the test uses DTLS but no custom proxy, add a simple proxy # as it provides timing info that's useful to debug failures