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:49 +0200 |
| commit | 851abe78b4ea7b8f238a652cd911420cd0950ff6 (patch) | |
| tree | 9b8b478d6248b4484c8bc43f658adc264ee62f88 | |
| parent | 69211b0fce408537bdfec7dd4cc5814b3c4eda8c (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)
| -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 369900c248..74589538b2 100644 --- a/doc/man3/ENGINE_add.pod +++ b/doc/man3/ENGINE_add.pod @@ -597,8 +597,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. @@ -609,7 +608,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 3167f27150..8c708584c0 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 runtime. =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. |