The branch OpenSSL_1_1_0-stable has been updated
via 1639a910b97581ef3050d310e8e09d5a28eadca5 (commit)
from f31c714e923e76f54ff3b492f646662ef57f7d59 (commit)
- Log -----------------------------------------------------------------
commit 1639a910b97581ef3050d310e8e09d5a28eadca5
Author: Richard Levitte <[email protected]>
Date: Sat Mar 11 10:51:04 2017 +0100
UI docs: Rephrase the UI method function return value description
It seems the =item isn't supposed to have pure numbers, or so tells me
perldoc.
Reviewed-by: Tim Hudson <[email protected]>
(Merged from https://github.com/openssl/openssl/pull/2906)
(cherry picked from commit 8e3d46e58ba1b754f0c3fdddd47f7c451f0b2b23)
-----------------------------------------------------------------------
Summary of changes:
doc/crypto/UI_create_method.pod | 23 ++++-------------------
1 file changed, 4 insertions(+), 19 deletions(-)
diff --git a/doc/crypto/UI_create_method.pod b/doc/crypto/UI_create_method.pod
index c1d3088..1c40153 100644
--- a/doc/crypto/UI_create_method.pod
+++ b/doc/crypto/UI_create_method.pod
@@ -85,28 +85,13 @@ by closing the channel to the tty, maybe by destroying a
dialog box.
=back
-All of these functions are expected to return one of these values:
-
-=over 4
-
-=item 0
-
-on error.
-
-=item 1
-
-on success.
-
-=item -1
-
-on out-off-band events, for example if some prompting has been
-cancelled (by pressing Ctrl-C, for example).
-This is only expected to be returned by the flusher or the reader.
+All of these functions are expected to return 0 on error, 1 on
+success, or -1 on out-off-band events, for example if some prompting
+has been cancelled (by pressing Ctrl-C, for example).
+Only the flusher or the reader are expected to return -1.
If returned by another of the functions, it's treated as if 0 was
returned.
-=back
-
Regarding the writer and the reader, don't assume the former should
only write and don't assume the latter should only read.
This depends on the needs of the method.
_____
openssl-commits mailing list
To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-commits
