summaryrefslogtreecommitdiff
path: root/lib/libcrypto
diff options
context:
space:
mode:
authorMichael McConville <mmcc@cvs.openbsd.org>2016-03-12 21:31:23 +0000
committerMichael McConville <mmcc@cvs.openbsd.org>2016-03-12 21:31:23 +0000
commitb79ee23e66b1285c71ac7b0db7df12fa6700e5d9 (patch)
tree4cccbf70612db1c67490420222827118012435c3 /lib/libcrypto
parent3eab1cafd6b7ceec8f7fb32f68ce2784a66bf065 (diff)
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@
Diffstat (limited to 'lib/libcrypto')
-rw-r--r--lib/libcrypto/doc/DH_new.pod2
-rw-r--r--lib/libcrypto/doc/DH_set_method.pod2
-rw-r--r--lib/libcrypto/doc/DSA_SIG_new.pod2
-rw-r--r--lib/libcrypto/doc/DSA_new.pod2
-rw-r--r--lib/libcrypto/doc/DSA_set_method.pod2
-rw-r--r--lib/libcrypto/doc/ERR_load_strings.pod2
-rw-r--r--lib/libcrypto/doc/RAND_cleanup.pod4
-rw-r--r--lib/libcrypto/doc/RSA_blinding_on.pod2
-rw-r--r--lib/libcrypto/doc/RSA_new.pod2
-rw-r--r--lib/libcrypto/doc/RSA_set_method.pod2
-rw-r--r--lib/libcrypto/doc/X509_new.pod5
11 files changed, 4 insertions, 23 deletions
diff --git a/lib/libcrypto/doc/DH_new.pod b/lib/libcrypto/doc/DH_new.pod
index d6c3ca82b5f..0fdb7b9680c 100644
--- a/lib/libcrypto/doc/DH_new.pod
+++ b/lib/libcrypto/doc/DH_new.pod
@@ -25,8 +25,6 @@ If the allocation fails, DH_new() returns B<NULL> and sets an error code that
can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a
pointer to the newly allocated structure.
-DH_free() returns no value.
-
=head1 SEE ALSO
L<dh(3)|dh(3)>, L<ERR_get_error(3)|ERR_get_error(3)>,
diff --git a/lib/libcrypto/doc/DH_set_method.pod b/lib/libcrypto/doc/DH_set_method.pod
index 2a4c2735cb7..d82fe7377a2 100644
--- a/lib/libcrypto/doc/DH_set_method.pod
+++ b/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
B<DH_METHOD>s.
-DH_set_default_method() returns no value.
-
DH_set_method() returns non-zero if the provided B<meth> was successfully set as
the method for B<dh> (including unloading the ENGINE handle if the previous
method was supplied by an ENGINE).
diff --git a/lib/libcrypto/doc/DSA_SIG_new.pod b/lib/libcrypto/doc/DSA_SIG_new.pod
index 3ac61400381..77aa649db05 100644
--- a/lib/libcrypto/doc/DSA_SIG_new.pod
+++ b/lib/libcrypto/doc/DSA_SIG_new.pod
@@ -26,8 +26,6 @@ error code that can be obtained by
L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a pointer
to the newly allocated structure.
-DSA_SIG_free() returns no value.
-
=head1 SEE ALSO
L<dsa(3)|dsa(3)>, L<ERR_get_error(3)|ERR_get_error(3)>,
diff --git a/lib/libcrypto/doc/DSA_new.pod b/lib/libcrypto/doc/DSA_new.pod
index 48e9b82a09c..e1e30b9a079 100644
--- a/lib/libcrypto/doc/DSA_new.pod
+++ b/lib/libcrypto/doc/DSA_new.pod
@@ -27,8 +27,6 @@ code that can be obtained by
L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a pointer
to the newly allocated structure.
-DSA_free() returns no value.
-
=head1 SEE ALSO
L<dsa(3)|dsa(3)>, L<ERR_get_error(3)|ERR_get_error(3)>,
diff --git a/lib/libcrypto/doc/DSA_set_method.pod b/lib/libcrypto/doc/DSA_set_method.pod
index 31f444d7512..bc57a3e8e2d 100644
--- a/lib/libcrypto/doc/DSA_set_method.pod
+++ b/lib/libcrypto/doc/DSA_set_method.pod
@@ -103,8 +103,6 @@ struct
DSA_OpenSSL() and DSA_get_default_method() return pointers to the respective
B<DSA_METHOD>s.
-DSA_set_default_method() returns no value.
-
DSA_set_method() returns non-zero if the provided B<meth> was successfully set
as the method for B<dsa> (including unloading the ENGINE handle if the previous
method was supplied by an ENGINE).
diff --git a/lib/libcrypto/doc/ERR_load_strings.pod b/lib/libcrypto/doc/ERR_load_strings.pod
index 5acdd0edbc5..e9c5cf0fc56 100644
--- a/lib/libcrypto/doc/ERR_load_strings.pod
+++ b/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/lib/libcrypto/doc/RAND_cleanup.pod b/lib/libcrypto/doc/RAND_cleanup.pod
index 3a8f0749a8d..10cb39ce7ad 100644
--- a/lib/libcrypto/doc/RAND_cleanup.pod
+++ b/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<rand(3)|rand(3)>
diff --git a/lib/libcrypto/doc/RSA_blinding_on.pod b/lib/libcrypto/doc/RSA_blinding_on.pod
index 33990207f79..f96e3cf7c96 100644
--- a/lib/libcrypto/doc/RSA_blinding_on.pod
+++ b/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<rsa(3)|rsa(3)>, L<rand(3)|rand(3)>
diff --git a/lib/libcrypto/doc/RSA_new.pod b/lib/libcrypto/doc/RSA_new.pod
index 41e5e60340d..0c85dc1d625 100644
--- a/lib/libcrypto/doc/RSA_new.pod
+++ b/lib/libcrypto/doc/RSA_new.pod
@@ -26,8 +26,6 @@ If the allocation fails, RSA_new() returns B<NULL> and sets an error code that
can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a
pointer to the newly allocated structure.
-RSA_free() returns no value.
-
=head1 SEE ALSO
L<ERR_get_error(3)|ERR_get_error(3)>, L<rsa(3)|rsa(3)>,
diff --git a/lib/libcrypto/doc/RSA_set_method.pod b/lib/libcrypto/doc/RSA_set_method.pod
index 7f687c87189..3f50a89e5c4 100644
--- a/lib/libcrypto/doc/RSA_set_method.pod
+++ b/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/lib/libcrypto/doc/X509_new.pod b/lib/libcrypto/doc/X509_new.pod
index fd5fc65ce15..a36808b825c 100644
--- a/lib/libcrypto/doc/X509_new.pod
+++ b/lib/libcrypto/doc/X509_new.pod
@@ -6,6 +6,8 @@ X509_new, X509_free - X509 certificate ASN1 allocation functions
=head1 SYNOPSIS
+ #include <openssl/x509.h>
+
X509 *X509_new(void);
void X509_free(X509 *a);
@@ -17,6 +19,7 @@ X509 structure, which represents an X509 certificate.
X509_new() allocates and initializes a X509 structure.
X509_free() frees up the B<X509> structure B<a>.
+If B<a> is a B<NULL> pointer, no action occurs.
=head1 RETURN VALUES
@@ -24,8 +27,6 @@ If the allocation fails, X509_new() returns B<NULL> and sets an error
code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
Otherwise it returns a pointer to the newly allocated structure.
-X509_free() returns no value.
-
=head1 SEE ALSO
L<ERR_get_error(3)|ERR_get_error(3)>, L<d2i_X509(3)|d2i_X509(3)>