diff options
| author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-09-18 10:36:15 +0200 |
|---|---|---|
| committer | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-09-24 14:34:56 +0200 |
| commit | 4e0723bc93373da6affd1c2ce7dcad39281ebb9b (patch) | |
| tree | 191e5a89b0fa876cfc975fec83db5143c01bf205 /util/perl | |
| parent | 1061baf64662aaa16e9e086f469126e1819e0805 (diff) | |
| download | openssl-new-4e0723bc93373da6affd1c2ce7dcad39281ebb9b.tar.gz | |
Test.pm: Some clarifications added to the documentation
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12893)
Diffstat (limited to 'util/perl')
| -rw-r--r-- | util/perl/OpenSSL/Test.pm | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/util/perl/OpenSSL/Test.pm b/util/perl/OpenSSL/Test.pm index b40283fe34..c44eca301c 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<run>, C<pipe> or C<cmdstr>. -The options that C<cmd> can take are in the form of hash values: +The options that C<cmd> (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<run> executes the command returned by CODEREF and return either the -resulting output (if the option C<capture> is set true) or a boolean +resulting standard output (if the option C<capture> is set true) or a boolean indicating if the command succeeded or not. The options that C<run> can take are in the form of hash values: @@ -398,10 +399,10 @@ The options that C<run> can take are in the form of hash values: =item B<capture =E<gt> 0|1> -If true, the command will be executed with a perl backtick, and C<run> will -return the resulting output as an array of lines. If false or not given, -the command will be executed with C<system()>, and C<run> 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<run> will return the resulting standard output as an array of lines. +If false or not given, the command will be executed with C<system()>, +and C<run> will return 1 if the command was successful or 0 if it wasn't. =item B<prefix =E<gt> EXPR> @@ -417,6 +418,7 @@ particularly useful together with B<capture>. =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<with> further down. |