diff options
| author | PW Hu <jlu.hpw@foxmail.com> | 2021-10-09 15:21:00 +0800 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2021-10-22 11:40:29 +0200 |
| commit | ef3889e7a2e21e9acea3bc0927c22f962da36eed (patch) | |
| tree | 8ff52f29db992db341ac4b6457e6ba60bd2b1486 /doc | |
| parent | d9f8032ea6c414fbcf91ed541059dd6c32a9abc6 (diff) | |
Fix some documentation errors related to return values
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16794)
(cherry picked from commit f1d077f1108b1bc2334350a4d53a46e29e082910)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/ENGINE_add.pod | 5 | ||||
| -rw-r--r-- | doc/man3/ERR_load_strings.pod | 4 |
2 files changed, 4 insertions, 5 deletions
diff --git a/doc/man3/ENGINE_add.pod b/doc/man3/ENGINE_add.pod index c9279e871f..982a4001b7 100644 --- a/doc/man3/ENGINE_add.pod +++ b/doc/man3/ENGINE_add.pod @@ -604,8 +604,7 @@ B<ENGINE> implementations. All ENGINE_register_TYPE() functions return 1 on success or 0 on error. -ENGINE_register_complete() and ENGINE_register_all_complete() return 1 on success -or 0 on error. +ENGINE_register_complete() and ENGINE_register_all_complete() always return 1. ENGINE_ctrl() returns a positive value on success or others on error. @@ -616,7 +615,7 @@ ENGINE_ctrl_cmd() and ENGINE_ctrl_cmd_string() return 1 on success or 0 on error ENGINE_new() returns a valid B<ENGINE> structure on success or NULL if an error occurred. -ENGINE_free() returns 1 on success or 0 on error. +ENGINE_free() always returns 1. ENGINE_up_ref() returns 1 on success or 0 on error. diff --git a/doc/man3/ERR_load_strings.pod b/doc/man3/ERR_load_strings.pod index 56d31e6611..55f4cb244e 100644 --- a/doc/man3/ERR_load_strings.pod +++ b/doc/man3/ERR_load_strings.pod @@ -9,7 +9,7 @@ arbitrary error strings #include <openssl/err.h> - void ERR_load_strings(int lib, ERR_STRING_DATA str[]); + int ERR_load_strings(int lib, ERR_STRING_DATA *str); int ERR_get_next_error_library(void); @@ -38,7 +38,7 @@ to user libraries at run time. =head1 RETURN VALUES -ERR_load_strings() returns no value. ERR_PACK() return the error code. +ERR_load_strings() returns 1 for success and 0 for failure. ERR_PACK() returns the error code. ERR_get_next_error_library() returns zero on failure, otherwise a new library number. |