From 8e3d46e58ba1b754f0c3fdddd47f7c451f0b2b23 Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Sat, 11 Mar 2017 10:51:04 +0100 Subject: [PATCH] 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 (Merged from https://github.com/openssl/openssl/pull/2906) --- doc/man3/UI_create_method.pod | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/doc/man3/UI_create_method.pod b/doc/man3/UI_create_method.pod index c1d3088296..1c40153a3f 100644 --- a/doc/man3/UI_create_method.pod +++ b/doc/man3/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. -- GitLab