Document the new -testmode option to the speed command

Reviewed-by: Neil Horman <nhorman@openssl.org>
Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/25153)
This commit is contained in:
Matt Caswell 2024-08-09 14:43:01 +01:00 committed by Tomas Mraz
parent 9309b0b8c7
commit 1867aac808

View File

@ -27,6 +27,7 @@ B<openssl speed>
[B<-bytes> I<num>]
[B<-mr>]
[B<-mlock>]
[B<-testmode>]
{- $OpenSSL::safe::opt_r_synopsis -}
{- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
[I<algorithm> ...]
@ -130,6 +131,12 @@ Produce the summary in a mechanical, machine-readable, format.
Lock memory into RAM for more deterministic measurements.
=item B<-testmode>
Runs the speed command in testmode. Runs only 1 iteration of each algorithm test
regardless of any B<-seconds> value. In the event that any operation fails then
the speed command will return with a failure result.
{- $OpenSSL::safe::opt_r_item -}
{- $OpenSSL::safe::opt_engine_item -}
@ -158,6 +165,8 @@ The B<-engine> option was deprecated in OpenSSL 3.0.
DSA512 was removed in OpenSSL 3.2.
The B<-testmode> option was added in OpenSSL 3.4.
=head1 COPYRIGHT
Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.