Commit 8e3d46e5 authored by Richard Levitte's avatar Richard Levitte
Browse files

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: default avatarTim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2906)
parent 6e470e19

doc/man3/UI_create_method.pod

+4 −19
Original line number Original line Diff line number Diff line
@@ -85,28 +85,13 @@ by closing the channel to the tty, maybe by destroying a dialog box. 




=back

=back





All of these functions are expected to return one of these values:

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

=over 4

has been cancelled (by pressing Ctrl-C, for example).



Only the flusher or the reader are expected to return -1.

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

If returned by another of the functions, it's treated as if 0 was

If returned by another of the functions, it's treated as if 0 was

returned.

returned.





=back



Regarding the writer and the reader, don't assume the former should

Regarding the writer and the reader, don't assume the former should

only write and don't assume the latter should only read.

only write and don't assume the latter should only read.

This depends on the needs of the method.

This depends on the needs of the method.