mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2024-11-27 05:21:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

UI docs: Rephrase the UI method function return value description

Browse Source 
It seems the =item isn't supposed to have pure numbers, or so tells me
perldoc.

Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2906)
This commit is contained in:
Richard Levitte 2017-03-11 10:51:04 +01:00
parent 6e470e1908
commit 8e3d46e58b
1 changed files with 4 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/man3/UI_create_method.pod
View File

@ -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.