From 4e0723bc93373da6affd1c2ce7dcad39281ebb9b Mon Sep 17 00:00:00 2001 From: "Dr. David von Oheimb" Date: Fri, 18 Sep 2020 10:36:15 +0200 Subject: [PATCH] Test.pm: Some clarifications added to the documentation Reviewed-by: Tomas Mraz Reviewed-by: Richard Levitte (Merged from https://github.com/openssl/openssl/pull/12893) --- util/perl/OpenSSL/Test.pm | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/util/perl/OpenSSL/Test.pm b/util/perl/OpenSSL/Test.pm index b40283fe349..c44eca301c3 100644 --- a/util/perl/OpenSSL/Test.pm +++ b/util/perl/OpenSSL/Test.pm @@ -221,7 +221,8 @@ used (currently only on Unix). It returns a CODEREF to be used by C, C or C. -The options that C can take are in the form of hash values: +The options that C (as well as its derivatives described below) can take +are in the form of hash values: =over 4 @@ -389,7 +390,7 @@ derivatives, anything else will most likely cause an error unless you know what you're doing. C executes the command returned by CODEREF and return either the -resulting output (if the option C is set true) or a boolean +resulting standard output (if the option C is set true) or a boolean indicating if the command succeeded or not. The options that C can take are in the form of hash values: @@ -398,10 +399,10 @@ The options that C can take are in the form of hash values: =item B 0|1> -If true, the command will be executed with a perl backtick, and C will -return the resulting output as an array of lines. If false or not given, -the command will be executed with C, and C will return 1 if -the command was successful or 0 if it wasn't. +If true, the command will be executed with a perl backtick, +and C will return the resulting standard output as an array of lines. +If false or not given, the command will be executed with C, +and C will return 1 if the command was successful or 0 if it wasn't. =item B EXPR> @@ -417,6 +418,7 @@ particularly useful together with B. =back +Usually 1 indicates that the command was successful and 0 indicates failure. For further discussion on what is considered a successful command or not, see the function C further down. -- 2.47.2