From d692c27f466b0683d4f7dd5f72058e64e04f0cd4 Mon Sep 17 00:00:00 2001 From: mmcc <> Date: Sat, 12 Mar 2016 21:31:22 +0000 Subject: Remove sentences in RETURN VALUES sections saying that functions with void return types 'return no value'. This is obvious and therefore unneccessary to mention. We spare rewind(3)'s sentence because espie@ pointed out that it's a warning - the function masks a potential error. This commit also adds a sentence to X509_free clarifying that it's NULL-safe. This bit was discussed with doug@. ok martijn@, sentiment supported by schwarze@ --- src/lib/libc/stdlib/hcreate.3 | 9 ++------- src/lib/libc/stdlib/malloc.3 | 8 ++------ src/lib/libc/stdlib/qsort.3 | 8 ++------ src/lib/libc/stdlib/tsearch.3 | 8 ++------ src/lib/libcrypto/doc/DH_new.pod | 2 -- src/lib/libcrypto/doc/DH_set_method.pod | 2 -- src/lib/libcrypto/doc/DSA_SIG_new.pod | 2 -- src/lib/libcrypto/doc/DSA_new.pod | 2 -- src/lib/libcrypto/doc/DSA_set_method.pod | 2 -- src/lib/libcrypto/doc/ERR_load_strings.pod | 2 +- src/lib/libcrypto/doc/RAND_cleanup.pod | 4 ---- src/lib/libcrypto/doc/RSA_blinding_on.pod | 2 -- src/lib/libcrypto/doc/RSA_new.pod | 2 -- src/lib/libcrypto/doc/RSA_set_method.pod | 2 -- src/lib/libcrypto/doc/X509_new.pod | 3 +-- src/lib/libcrypto/man/ASN1_OBJECT_new.3 | 5 +---- src/lib/libcrypto/man/BUF_MEM_new.3 | 5 +---- src/lib/libssl/src/doc/crypto/DH_new.pod | 2 -- src/lib/libssl/src/doc/crypto/DH_set_method.pod | 2 -- src/lib/libssl/src/doc/crypto/DSA_SIG_new.pod | 2 -- src/lib/libssl/src/doc/crypto/DSA_new.pod | 2 -- src/lib/libssl/src/doc/crypto/DSA_set_method.pod | 2 -- src/lib/libssl/src/doc/crypto/ERR_load_strings.pod | 2 +- src/lib/libssl/src/doc/crypto/RAND_cleanup.pod | 4 ---- src/lib/libssl/src/doc/crypto/RSA_blinding_on.pod | 2 -- src/lib/libssl/src/doc/crypto/RSA_new.pod | 2 -- src/lib/libssl/src/doc/crypto/RSA_set_method.pod | 2 -- src/lib/libssl/src/doc/crypto/X509_new.pod | 3 +-- 28 files changed, 14 insertions(+), 79 deletions(-) (limited to 'src') diff --git a/src/lib/libc/stdlib/hcreate.3 b/src/lib/libc/stdlib/hcreate.3 index ea264b57c8..610d2f3f88 100644 --- a/src/lib/libc/stdlib/hcreate.3 +++ b/src/lib/libc/stdlib/hcreate.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hcreate.3,v 1.6 2010/07/28 09:00:20 ray Exp $ +.\" $OpenBSD: hcreate.3,v 1.7 2016/03/12 21:31:22 mmcc Exp $ .\" $NetBSD: hcreate.3,v 1.8 2010/05/01 06:18:03 jruoho Exp $ .\" .\" Copyright (c) 1999 The NetBSD Foundation, Inc. @@ -28,7 +28,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: July 28 2010 $ +.Dd $Mdocdate: March 12 2016 $ .Dt HCREATE 3 .Os .Sh NAME @@ -159,11 +159,6 @@ Otherwise, a value of 0 is returned and .Va errno is set to indicate the error. .Pp -The -.Fn hdestroy -functions -returns no value. -.Pp If successful, the .Fn hsearch function returns a pointer to a hash table entry matching diff --git a/src/lib/libc/stdlib/malloc.3 b/src/lib/libc/stdlib/malloc.3 index 2e820047d0..c0be3a177d 100644 --- a/src/lib/libc/stdlib/malloc.3 +++ b/src/lib/libc/stdlib/malloc.3 @@ -30,9 +30,9 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $OpenBSD: malloc.3,v 1.93 2016/02/05 15:09:09 schwarze Exp $ +.\" $OpenBSD: malloc.3,v 1.94 2016/03/12 21:31:22 mmcc Exp $ .\" -.Dd $Mdocdate: February 5 2016 $ +.Dd $Mdocdate: March 12 2016 $ .Dt MALLOC 3 .Os .Sh NAME @@ -173,10 +173,6 @@ and set .Va errno to .Er ENOMEM . -.Pp -The -.Fn free -function returns no value. .Sh IDIOMS Consider .Fn calloc diff --git a/src/lib/libc/stdlib/qsort.3 b/src/lib/libc/stdlib/qsort.3 index 36eaed879b..f753777780 100644 --- a/src/lib/libc/stdlib/qsort.3 +++ b/src/lib/libc/stdlib/qsort.3 @@ -29,9 +29,9 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $OpenBSD: qsort.3,v 1.18 2015/01/29 01:46:31 schwarze Exp $ +.\" $OpenBSD: qsort.3,v 1.19 2016/03/12 21:31:22 mmcc Exp $ .\" -.Dd $Mdocdate: January 29 2015 $ +.Dd $Mdocdate: March 12 2016 $ .Dt QSORT 3 .Os .Sh NAME @@ -143,10 +143,6 @@ which is faster than .Fn heapsort . Memory availability and pre-existing order in the data can make this untrue. .Sh RETURN VALUES -The -.Fn qsort -function returns no value. -.Pp .Rv -std heapsort mergesort .Sh ERRORS The diff --git a/src/lib/libc/stdlib/tsearch.3 b/src/lib/libc/stdlib/tsearch.3 index 46d0bba10c..2027f163e4 100644 --- a/src/lib/libc/stdlib/tsearch.3 +++ b/src/lib/libc/stdlib/tsearch.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tsearch.3,v 1.19 2013/06/05 03:39:23 tedu Exp $ +.\" $OpenBSD: tsearch.3,v 1.20 2016/03/12 21:31:22 mmcc Exp $ .\" .\" Copyright (c) 1997 Todd C. Miller .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: June 5 2013 $ +.Dd $Mdocdate: March 12 2016 $ .Dt TSEARCH 3 .Os .Sh NAME @@ -111,10 +111,6 @@ if is .Dv NULL or the datum cannot be found. -.Pp -The -.Fn twalk -function returns no value. .Sh SEE ALSO .Xr bsearch 3 , .Xr lsearch 3 diff --git a/src/lib/libcrypto/doc/DH_new.pod b/src/lib/libcrypto/doc/DH_new.pod index d6c3ca82b5..0fdb7b9680 100644 --- a/src/lib/libcrypto/doc/DH_new.pod +++ b/src/lib/libcrypto/doc/DH_new.pod @@ -25,8 +25,6 @@ If the allocation fails, DH_new() returns B and sets an error code that can be obtained by L. Otherwise it returns a pointer to the newly allocated structure. -DH_free() returns no value. - =head1 SEE ALSO L, L, diff --git a/src/lib/libcrypto/doc/DH_set_method.pod b/src/lib/libcrypto/doc/DH_set_method.pod index 2a4c2735cb..d82fe7377a 100644 --- a/src/lib/libcrypto/doc/DH_set_method.pod +++ b/src/lib/libcrypto/doc/DH_set_method.pod @@ -89,8 +89,6 @@ DH_set_default_method() is used. DH_OpenSSL() and DH_get_default_method() return pointers to the respective Bs. -DH_set_default_method() returns no value. - DH_set_method() returns non-zero if the provided B was successfully set as the method for B (including unloading the ENGINE handle if the previous method was supplied by an ENGINE). diff --git a/src/lib/libcrypto/doc/DSA_SIG_new.pod b/src/lib/libcrypto/doc/DSA_SIG_new.pod index 3ac6140038..77aa649db0 100644 --- a/src/lib/libcrypto/doc/DSA_SIG_new.pod +++ b/src/lib/libcrypto/doc/DSA_SIG_new.pod @@ -26,8 +26,6 @@ error code that can be obtained by L. Otherwise it returns a pointer to the newly allocated structure. -DSA_SIG_free() returns no value. - =head1 SEE ALSO L, L, diff --git a/src/lib/libcrypto/doc/DSA_new.pod b/src/lib/libcrypto/doc/DSA_new.pod index 48e9b82a09..e1e30b9a07 100644 --- a/src/lib/libcrypto/doc/DSA_new.pod +++ b/src/lib/libcrypto/doc/DSA_new.pod @@ -27,8 +27,6 @@ code that can be obtained by L. Otherwise it returns a pointer to the newly allocated structure. -DSA_free() returns no value. - =head1 SEE ALSO L, L, diff --git a/src/lib/libcrypto/doc/DSA_set_method.pod b/src/lib/libcrypto/doc/DSA_set_method.pod index 31f444d751..bc57a3e8e2 100644 --- a/src/lib/libcrypto/doc/DSA_set_method.pod +++ b/src/lib/libcrypto/doc/DSA_set_method.pod @@ -103,8 +103,6 @@ struct DSA_OpenSSL() and DSA_get_default_method() return pointers to the respective Bs. -DSA_set_default_method() returns no value. - DSA_set_method() returns non-zero if the provided B was successfully set as the method for B (including unloading the ENGINE handle if the previous method was supplied by an ENGINE). diff --git a/src/lib/libcrypto/doc/ERR_load_strings.pod b/src/lib/libcrypto/doc/ERR_load_strings.pod index 5acdd0edbc..e9c5cf0fc5 100644 --- a/src/lib/libcrypto/doc/ERR_load_strings.pod +++ b/src/lib/libcrypto/doc/ERR_load_strings.pod @@ -38,7 +38,7 @@ to user libraries at runtime. =head1 RETURN VALUE -ERR_load_strings() returns no value. ERR_PACK() return the error code. +ERR_PACK() return the error code. ERR_get_next_error_library() returns a new library number. =head1 SEE ALSO diff --git a/src/lib/libcrypto/doc/RAND_cleanup.pod b/src/lib/libcrypto/doc/RAND_cleanup.pod index 3a8f0749a8..10cb39ce7a 100644 --- a/src/lib/libcrypto/doc/RAND_cleanup.pod +++ b/src/lib/libcrypto/doc/RAND_cleanup.pod @@ -14,10 +14,6 @@ RAND_cleanup - erase the PRNG state RAND_cleanup() erases the memory used by the PRNG. -=head1 RETURN VALUE - -RAND_cleanup() returns no value. - =head1 SEE ALSO L diff --git a/src/lib/libcrypto/doc/RSA_blinding_on.pod b/src/lib/libcrypto/doc/RSA_blinding_on.pod index 33990207f7..f96e3cf7c9 100644 --- a/src/lib/libcrypto/doc/RSA_blinding_on.pod +++ b/src/lib/libcrypto/doc/RSA_blinding_on.pod @@ -30,8 +30,6 @@ the blinding factor. RSA_blinding_on() returns 1 on success, and 0 if an error occurred. -RSA_blinding_off() returns no value. - =head1 SEE ALSO L, L diff --git a/src/lib/libcrypto/doc/RSA_new.pod b/src/lib/libcrypto/doc/RSA_new.pod index 41e5e60340..0c85dc1d62 100644 --- a/src/lib/libcrypto/doc/RSA_new.pod +++ b/src/lib/libcrypto/doc/RSA_new.pod @@ -26,8 +26,6 @@ If the allocation fails, RSA_new() returns B and sets an error code that can be obtained by L. Otherwise it returns a pointer to the newly allocated structure. -RSA_free() returns no value. - =head1 SEE ALSO L, L, diff --git a/src/lib/libcrypto/doc/RSA_set_method.pod b/src/lib/libcrypto/doc/RSA_set_method.pod index 7f687c8718..3f50a89e5c 100644 --- a/src/lib/libcrypto/doc/RSA_set_method.pod +++ b/src/lib/libcrypto/doc/RSA_set_method.pod @@ -142,8 +142,6 @@ the default method is used. RSA_PKCS1_SSLeay(), RSA_PKCS1_null_method(), RSA_get_default_method() and RSA_get_method() return pointers to the respective RSA_METHODs. -RSA_set_default_method() returns no value. - RSA_set_method() returns a pointer to the old RSA_METHOD implementation that was replaced. However, this return value should probably be ignored because if it was supplied by an ENGINE, the pointer could be invalidated diff --git a/src/lib/libcrypto/doc/X509_new.pod b/src/lib/libcrypto/doc/X509_new.pod index d38872335f..a36808b825 100644 --- a/src/lib/libcrypto/doc/X509_new.pod +++ b/src/lib/libcrypto/doc/X509_new.pod @@ -19,6 +19,7 @@ X509 structure, which represents an X509 certificate. X509_new() allocates and initializes a X509 structure. X509_free() frees up the B structure B. +If B is a B pointer, no action occurs. =head1 RETURN VALUES @@ -26,8 +27,6 @@ If the allocation fails, X509_new() returns B and sets an error code that can be obtained by L. Otherwise it returns a pointer to the newly allocated structure. -X509_free() returns no value. - =head1 SEE ALSO L, L diff --git a/src/lib/libcrypto/man/ASN1_OBJECT_new.3 b/src/lib/libcrypto/man/ASN1_OBJECT_new.3 index 5b81b2bded..526e1d869b 100644 --- a/src/lib/libcrypto/man/ASN1_OBJECT_new.3 +++ b/src/lib/libcrypto/man/ASN1_OBJECT_new.3 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: September 9 2015 $ +.Dd $Mdocdate: March 12 2016 $ .Dt ASN1_OBJECT_NEW 3 .Os .Sh NAME @@ -47,9 +47,6 @@ returns and sets an error code that can be obtained by .Xr ERR_get_error 3 . Otherwise it returns a pointer to the newly allocated structure. -.Pp -.Fn ASN1_OBJECT_free -returns no value. .Sh SEE ALSO .Xr d2i_ASN1_OBJECT 3 , .Xr ERR_get_error 3 , diff --git a/src/lib/libcrypto/man/BUF_MEM_new.3 b/src/lib/libcrypto/man/BUF_MEM_new.3 index f87e4f8257..10258b7aaf 100644 --- a/src/lib/libcrypto/man/BUF_MEM_new.3 +++ b/src/lib/libcrypto/man/BUF_MEM_new.3 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: September 22 2015 $ +.Dd $Mdocdate: March 12 2016 $ .Dt BUF_MEM_NEW 3 .Os .Sh NAME @@ -89,9 +89,6 @@ returns the buffer or .Dv NULL on error. .Pp -.Fn BUF_MEM_free -returns no value. -.Pp .Fn BUF_MEM_grow returns zero on error or the new size (i.e. .Fa len Ns ). diff --git a/src/lib/libssl/src/doc/crypto/DH_new.pod b/src/lib/libssl/src/doc/crypto/DH_new.pod index d6c3ca82b5..0fdb7b9680 100644 --- a/src/lib/libssl/src/doc/crypto/DH_new.pod +++ b/src/lib/libssl/src/doc/crypto/DH_new.pod @@ -25,8 +25,6 @@ If the allocation fails, DH_new() returns B and sets an error code that can be obtained by L. Otherwise it returns a pointer to the newly allocated structure. -DH_free() returns no value. - =head1 SEE ALSO L, L, diff --git a/src/lib/libssl/src/doc/crypto/DH_set_method.pod b/src/lib/libssl/src/doc/crypto/DH_set_method.pod index 2a4c2735cb..d82fe7377a 100644 --- a/src/lib/libssl/src/doc/crypto/DH_set_method.pod +++ b/src/lib/libssl/src/doc/crypto/DH_set_method.pod @@ -89,8 +89,6 @@ DH_set_default_method() is used. DH_OpenSSL() and DH_get_default_method() return pointers to the respective Bs. -DH_set_default_method() returns no value. - DH_set_method() returns non-zero if the provided B was successfully set as the method for B (including unloading the ENGINE handle if the previous method was supplied by an ENGINE). diff --git a/src/lib/libssl/src/doc/crypto/DSA_SIG_new.pod b/src/lib/libssl/src/doc/crypto/DSA_SIG_new.pod index 3ac6140038..77aa649db0 100644 --- a/src/lib/libssl/src/doc/crypto/DSA_SIG_new.pod +++ b/src/lib/libssl/src/doc/crypto/DSA_SIG_new.pod @@ -26,8 +26,6 @@ error code that can be obtained by L. Otherwise it returns a pointer to the newly allocated structure. -DSA_SIG_free() returns no value. - =head1 SEE ALSO L, L, diff --git a/src/lib/libssl/src/doc/crypto/DSA_new.pod b/src/lib/libssl/src/doc/crypto/DSA_new.pod index 48e9b82a09..e1e30b9a07 100644 --- a/src/lib/libssl/src/doc/crypto/DSA_new.pod +++ b/src/lib/libssl/src/doc/crypto/DSA_new.pod @@ -27,8 +27,6 @@ code that can be obtained by L. Otherwise it returns a pointer to the newly allocated structure. -DSA_free() returns no value. - =head1 SEE ALSO L, L, diff --git a/src/lib/libssl/src/doc/crypto/DSA_set_method.pod b/src/lib/libssl/src/doc/crypto/DSA_set_method.pod index 31f444d751..bc57a3e8e2 100644 --- a/src/lib/libssl/src/doc/crypto/DSA_set_method.pod +++ b/src/lib/libssl/src/doc/crypto/DSA_set_method.pod @@ -103,8 +103,6 @@ struct DSA_OpenSSL() and DSA_get_default_method() return pointers to the respective Bs. -DSA_set_default_method() returns no value. - DSA_set_method() returns non-zero if the provided B was successfully set as the method for B (including unloading the ENGINE handle if the previous method was supplied by an ENGINE). diff --git a/src/lib/libssl/src/doc/crypto/ERR_load_strings.pod b/src/lib/libssl/src/doc/crypto/ERR_load_strings.pod index 5acdd0edbc..e9c5cf0fc5 100644 --- a/src/lib/libssl/src/doc/crypto/ERR_load_strings.pod +++ b/src/lib/libssl/src/doc/crypto/ERR_load_strings.pod @@ -38,7 +38,7 @@ to user libraries at runtime. =head1 RETURN VALUE -ERR_load_strings() returns no value. ERR_PACK() return the error code. +ERR_PACK() return the error code. ERR_get_next_error_library() returns a new library number. =head1 SEE ALSO diff --git a/src/lib/libssl/src/doc/crypto/RAND_cleanup.pod b/src/lib/libssl/src/doc/crypto/RAND_cleanup.pod index 3a8f0749a8..10cb39ce7a 100644 --- a/src/lib/libssl/src/doc/crypto/RAND_cleanup.pod +++ b/src/lib/libssl/src/doc/crypto/RAND_cleanup.pod @@ -14,10 +14,6 @@ RAND_cleanup - erase the PRNG state RAND_cleanup() erases the memory used by the PRNG. -=head1 RETURN VALUE - -RAND_cleanup() returns no value. - =head1 SEE ALSO L diff --git a/src/lib/libssl/src/doc/crypto/RSA_blinding_on.pod b/src/lib/libssl/src/doc/crypto/RSA_blinding_on.pod index 33990207f7..f96e3cf7c9 100644 --- a/src/lib/libssl/src/doc/crypto/RSA_blinding_on.pod +++ b/src/lib/libssl/src/doc/crypto/RSA_blinding_on.pod @@ -30,8 +30,6 @@ the blinding factor. RSA_blinding_on() returns 1 on success, and 0 if an error occurred. -RSA_blinding_off() returns no value. - =head1 SEE ALSO L, L diff --git a/src/lib/libssl/src/doc/crypto/RSA_new.pod b/src/lib/libssl/src/doc/crypto/RSA_new.pod index 41e5e60340..0c85dc1d62 100644 --- a/src/lib/libssl/src/doc/crypto/RSA_new.pod +++ b/src/lib/libssl/src/doc/crypto/RSA_new.pod @@ -26,8 +26,6 @@ If the allocation fails, RSA_new() returns B and sets an error code that can be obtained by L. Otherwise it returns a pointer to the newly allocated structure. -RSA_free() returns no value. - =head1 SEE ALSO L, L, diff --git a/src/lib/libssl/src/doc/crypto/RSA_set_method.pod b/src/lib/libssl/src/doc/crypto/RSA_set_method.pod index 7f687c8718..3f50a89e5c 100644 --- a/src/lib/libssl/src/doc/crypto/RSA_set_method.pod +++ b/src/lib/libssl/src/doc/crypto/RSA_set_method.pod @@ -142,8 +142,6 @@ the default method is used. RSA_PKCS1_SSLeay(), RSA_PKCS1_null_method(), RSA_get_default_method() and RSA_get_method() return pointers to the respective RSA_METHODs. -RSA_set_default_method() returns no value. - RSA_set_method() returns a pointer to the old RSA_METHOD implementation that was replaced. However, this return value should probably be ignored because if it was supplied by an ENGINE, the pointer could be invalidated diff --git a/src/lib/libssl/src/doc/crypto/X509_new.pod b/src/lib/libssl/src/doc/crypto/X509_new.pod index d38872335f..a36808b825 100644 --- a/src/lib/libssl/src/doc/crypto/X509_new.pod +++ b/src/lib/libssl/src/doc/crypto/X509_new.pod @@ -19,6 +19,7 @@ X509 structure, which represents an X509 certificate. X509_new() allocates and initializes a X509 structure. X509_free() frees up the B structure B. +If B is a B pointer, no action occurs. =head1 RETURN VALUES @@ -26,8 +27,6 @@ If the allocation fails, X509_new() returns B and sets an error code that can be obtained by L. Otherwise it returns a pointer to the newly allocated structure. -X509_free() returns no value. - =head1 SEE ALSO L, L -- cgit v1.2.3-55-g6feb