diff options
author | mmcc <> | 2016-03-12 21:31:22 +0000 |
---|---|---|
committer | mmcc <> | 2016-03-12 21:31:22 +0000 |
commit | d692c27f466b0683d4f7dd5f72058e64e04f0cd4 (patch) | |
tree | 41d48a54c09f49f4e37617cd4f79d217bf4250a8 /src/lib/libcrypto | |
parent | b5aa7e790e535fc940826232ac1bf67aeb800cb0 (diff) | |
download | openbsd-d692c27f466b0683d4f7dd5f72058e64e04f0cd4.tar.gz openbsd-d692c27f466b0683d4f7dd5f72058e64e04f0cd4.tar.bz2 openbsd-d692c27f466b0683d4f7dd5f72058e64e04f0cd4.zip |
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 'src/lib/libcrypto')
-rw-r--r-- | src/lib/libcrypto/doc/DH_new.pod | 2 | ||||
-rw-r--r-- | src/lib/libcrypto/doc/DH_set_method.pod | 2 | ||||
-rw-r--r-- | src/lib/libcrypto/doc/DSA_SIG_new.pod | 2 | ||||
-rw-r--r-- | src/lib/libcrypto/doc/DSA_new.pod | 2 | ||||
-rw-r--r-- | src/lib/libcrypto/doc/DSA_set_method.pod | 2 | ||||
-rw-r--r-- | src/lib/libcrypto/doc/ERR_load_strings.pod | 2 | ||||
-rw-r--r-- | src/lib/libcrypto/doc/RAND_cleanup.pod | 4 | ||||
-rw-r--r-- | src/lib/libcrypto/doc/RSA_blinding_on.pod | 2 | ||||
-rw-r--r-- | src/lib/libcrypto/doc/RSA_new.pod | 2 | ||||
-rw-r--r-- | src/lib/libcrypto/doc/RSA_set_method.pod | 2 | ||||
-rw-r--r-- | src/lib/libcrypto/doc/X509_new.pod | 3 | ||||
-rw-r--r-- | src/lib/libcrypto/man/ASN1_OBJECT_new.3 | 5 | ||||
-rw-r--r-- | src/lib/libcrypto/man/BUF_MEM_new.3 | 5 |
13 files changed, 4 insertions, 31 deletions
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<NULL> and sets an error code that | |||
25 | can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a | 25 | can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a |
26 | pointer to the newly allocated structure. | 26 | pointer to the newly allocated structure. |
27 | 27 | ||
28 | DH_free() returns no value. | ||
29 | |||
30 | =head1 SEE ALSO | 28 | =head1 SEE ALSO |
31 | 29 | ||
32 | L<dh(3)|dh(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, | 30 | L<dh(3)|dh(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, |
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. | |||
89 | DH_OpenSSL() and DH_get_default_method() return pointers to the respective | 89 | DH_OpenSSL() and DH_get_default_method() return pointers to the respective |
90 | B<DH_METHOD>s. | 90 | B<DH_METHOD>s. |
91 | 91 | ||
92 | DH_set_default_method() returns no value. | ||
93 | |||
94 | DH_set_method() returns non-zero if the provided B<meth> was successfully set as | 92 | DH_set_method() returns non-zero if the provided B<meth> was successfully set as |
95 | the method for B<dh> (including unloading the ENGINE handle if the previous | 93 | the method for B<dh> (including unloading the ENGINE handle if the previous |
96 | method was supplied by an ENGINE). | 94 | 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 | |||
26 | L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a pointer | 26 | L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a pointer |
27 | to the newly allocated structure. | 27 | to the newly allocated structure. |
28 | 28 | ||
29 | DSA_SIG_free() returns no value. | ||
30 | |||
31 | =head1 SEE ALSO | 29 | =head1 SEE ALSO |
32 | 30 | ||
33 | L<dsa(3)|dsa(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, | 31 | L<dsa(3)|dsa(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, |
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 | |||
27 | L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a pointer | 27 | L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a pointer |
28 | to the newly allocated structure. | 28 | to the newly allocated structure. |
29 | 29 | ||
30 | DSA_free() returns no value. | ||
31 | |||
32 | =head1 SEE ALSO | 30 | =head1 SEE ALSO |
33 | 31 | ||
34 | L<dsa(3)|dsa(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, | 32 | L<dsa(3)|dsa(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, |
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 | |||
103 | DSA_OpenSSL() and DSA_get_default_method() return pointers to the respective | 103 | DSA_OpenSSL() and DSA_get_default_method() return pointers to the respective |
104 | B<DSA_METHOD>s. | 104 | B<DSA_METHOD>s. |
105 | 105 | ||
106 | DSA_set_default_method() returns no value. | ||
107 | |||
108 | DSA_set_method() returns non-zero if the provided B<meth> was successfully set | 106 | DSA_set_method() returns non-zero if the provided B<meth> was successfully set |
109 | as the method for B<dsa> (including unloading the ENGINE handle if the previous | 107 | as the method for B<dsa> (including unloading the ENGINE handle if the previous |
110 | method was supplied by an ENGINE). | 108 | 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. | |||
38 | 38 | ||
39 | =head1 RETURN VALUE | 39 | =head1 RETURN VALUE |
40 | 40 | ||
41 | ERR_load_strings() returns no value. ERR_PACK() return the error code. | 41 | ERR_PACK() return the error code. |
42 | ERR_get_next_error_library() returns a new library number. | 42 | ERR_get_next_error_library() returns a new library number. |
43 | 43 | ||
44 | =head1 SEE ALSO | 44 | =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 | |||
14 | 14 | ||
15 | RAND_cleanup() erases the memory used by the PRNG. | 15 | RAND_cleanup() erases the memory used by the PRNG. |
16 | 16 | ||
17 | =head1 RETURN VALUE | ||
18 | |||
19 | RAND_cleanup() returns no value. | ||
20 | |||
21 | =head1 SEE ALSO | 17 | =head1 SEE ALSO |
22 | 18 | ||
23 | L<rand(3)|rand(3)> | 19 | L<rand(3)|rand(3)> |
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. | |||
30 | 30 | ||
31 | RSA_blinding_on() returns 1 on success, and 0 if an error occurred. | 31 | RSA_blinding_on() returns 1 on success, and 0 if an error occurred. |
32 | 32 | ||
33 | RSA_blinding_off() returns no value. | ||
34 | |||
35 | =head1 SEE ALSO | 33 | =head1 SEE ALSO |
36 | 34 | ||
37 | L<rsa(3)|rsa(3)>, L<rand(3)|rand(3)> | 35 | L<rsa(3)|rsa(3)>, L<rand(3)|rand(3)> |
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<NULL> and sets an error code that | |||
26 | can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a | 26 | can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a |
27 | pointer to the newly allocated structure. | 27 | pointer to the newly allocated structure. |
28 | 28 | ||
29 | RSA_free() returns no value. | ||
30 | |||
31 | =head1 SEE ALSO | 29 | =head1 SEE ALSO |
32 | 30 | ||
33 | L<ERR_get_error(3)|ERR_get_error(3)>, L<rsa(3)|rsa(3)>, | 31 | L<ERR_get_error(3)|ERR_get_error(3)>, L<rsa(3)|rsa(3)>, |
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. | |||
142 | RSA_PKCS1_SSLeay(), RSA_PKCS1_null_method(), RSA_get_default_method() | 142 | RSA_PKCS1_SSLeay(), RSA_PKCS1_null_method(), RSA_get_default_method() |
143 | and RSA_get_method() return pointers to the respective RSA_METHODs. | 143 | and RSA_get_method() return pointers to the respective RSA_METHODs. |
144 | 144 | ||
145 | RSA_set_default_method() returns no value. | ||
146 | |||
147 | RSA_set_method() returns a pointer to the old RSA_METHOD implementation | 145 | RSA_set_method() returns a pointer to the old RSA_METHOD implementation |
148 | that was replaced. However, this return value should probably be ignored | 146 | that was replaced. However, this return value should probably be ignored |
149 | because if it was supplied by an ENGINE, the pointer could be invalidated | 147 | 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. | |||
19 | X509_new() allocates and initializes a X509 structure. | 19 | X509_new() allocates and initializes a X509 structure. |
20 | 20 | ||
21 | X509_free() frees up the B<X509> structure B<a>. | 21 | X509_free() frees up the B<X509> structure B<a>. |
22 | If B<a> is a B<NULL> pointer, no action occurs. | ||
22 | 23 | ||
23 | =head1 RETURN VALUES | 24 | =head1 RETURN VALUES |
24 | 25 | ||
@@ -26,8 +27,6 @@ If the allocation fails, X509_new() returns B<NULL> and sets an error | |||
26 | code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. | 27 | code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. |
27 | Otherwise it returns a pointer to the newly allocated structure. | 28 | Otherwise it returns a pointer to the newly allocated structure. |
28 | 29 | ||
29 | X509_free() returns no value. | ||
30 | |||
31 | =head1 SEE ALSO | 30 | =head1 SEE ALSO |
32 | 31 | ||
33 | L<ERR_get_error(3)|ERR_get_error(3)>, L<d2i_X509(3)|d2i_X509(3)> | 32 | L<ERR_get_error(3)|ERR_get_error(3)>, L<d2i_X509(3)|d2i_X509(3)> |
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 @@ | |||
1 | .Dd $Mdocdate: September 9 2015 $ | 1 | .Dd $Mdocdate: March 12 2016 $ |
2 | .Dt ASN1_OBJECT_NEW 3 | 2 | .Dt ASN1_OBJECT_NEW 3 |
3 | .Os | 3 | .Os |
4 | .Sh NAME | 4 | .Sh NAME |
@@ -47,9 +47,6 @@ returns | |||
47 | and sets an error code that can be obtained by | 47 | and sets an error code that can be obtained by |
48 | .Xr ERR_get_error 3 . | 48 | .Xr ERR_get_error 3 . |
49 | Otherwise it returns a pointer to the newly allocated structure. | 49 | Otherwise it returns a pointer to the newly allocated structure. |
50 | .Pp | ||
51 | .Fn ASN1_OBJECT_free | ||
52 | returns no value. | ||
53 | .Sh SEE ALSO | 50 | .Sh SEE ALSO |
54 | .Xr d2i_ASN1_OBJECT 3 , | 51 | .Xr d2i_ASN1_OBJECT 3 , |
55 | .Xr ERR_get_error 3 , | 52 | .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 @@ | |||
1 | .Dd $Mdocdate: September 22 2015 $ | 1 | .Dd $Mdocdate: March 12 2016 $ |
2 | .Dt BUF_MEM_NEW 3 | 2 | .Dt BUF_MEM_NEW 3 |
3 | .Os | 3 | .Os |
4 | .Sh NAME | 4 | .Sh NAME |
@@ -89,9 +89,6 @@ returns the buffer or | |||
89 | .Dv NULL | 89 | .Dv NULL |
90 | on error. | 90 | on error. |
91 | .Pp | 91 | .Pp |
92 | .Fn BUF_MEM_free | ||
93 | returns no value. | ||
94 | .Pp | ||
95 | .Fn BUF_MEM_grow | 92 | .Fn BUF_MEM_grow |
96 | returns zero on error or the new size (i.e. | 93 | returns zero on error or the new size (i.e. |
97 | .Fa len Ns ). | 94 | .Fa len Ns ). |