Fix some documentation errors related to return values
authorPW Hu <jlu.hpw@foxmail.com>
Sat, 9 Oct 2021 07:21:00 +0000 (15:21 +0800)
committerTomas Mraz <tomas@openssl.org>
Fri, 22 Oct 2021 09:39:04 +0000 (11:39 +0200)
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16794)

doc/man3/ENGINE_add.pod
doc/man3/ERR_load_strings.pod

index c9279e871fc247a8add30929f35e86879709e969..982a4001b74a638ac469b73d61791328a77910a0 100644 (file)
@@ -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.
 
index 56d31e6611fd6a25fc89ebd16b930508e89f4af6..55f4cb244ec90ffd64b48abefe9e73efe0784461 100644 (file)
@@ -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.