diff options
| author | tb <> | 2024-03-04 09:30:43 +0000 |
|---|---|---|
| committer | tb <> | 2024-03-04 09:30:43 +0000 |
| commit | 77adb65fa66009ad5786acbeac45de1e0e79a520 (patch) | |
| tree | d3dfff3df90cd3bc21c89ca887af3e8155b7962f | |
| parent | c127570e7e2a5f4b372620aa6ec3550d123e4092 (diff) | |
| download | openbsd-77adb65fa66009ad5786acbeac45de1e0e79a520.tar.gz openbsd-77adb65fa66009ad5786acbeac45de1e0e79a520.tar.bz2 openbsd-77adb65fa66009ad5786acbeac45de1e0e79a520.zip | |
Remove documentation of some CRYPTO_THREADID API
CRYPTO_THREADID_{cpm,cpy,current,hash}() are no longer public, so remove
their documentation.
| -rw-r--r-- | src/lib/libcrypto/man/CRYPTO_lock.3 | 60 |
1 files changed, 2 insertions, 58 deletions
diff --git a/src/lib/libcrypto/man/CRYPTO_lock.3 b/src/lib/libcrypto/man/CRYPTO_lock.3 index cb6224a700..4187a96bf3 100644 --- a/src/lib/libcrypto/man/CRYPTO_lock.3 +++ b/src/lib/libcrypto/man/CRYPTO_lock.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: CRYPTO_lock.3,v 1.1 2019/03/10 15:00:34 schwarze Exp $ | 1 | .\" $OpenBSD: CRYPTO_lock.3,v 1.2 2024/03/04 09:30:43 tb Exp $ |
| 2 | .\" OpenSSL doc/crypto/threads.pod fb552ac6 Sep 30 23:43:01 2009 +0000 | 2 | .\" OpenSSL doc/crypto/threads.pod fb552ac6 Sep 30 23:43:01 2009 +0000 |
| 3 | .\" | 3 | .\" |
| 4 | .\" Copyright (c) 2019 Ingo Schwarze <schwarze@openbsd.org> | 4 | .\" Copyright (c) 2019 Ingo Schwarze <schwarze@openbsd.org> |
| @@ -15,14 +15,10 @@ | |||
| 15 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | 15 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| 16 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | 16 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| 17 | .\" | 17 | .\" |
| 18 | .Dd $Mdocdate: March 10 2019 $ | 18 | .Dd $Mdocdate: March 4 2024 $ |
| 19 | .Dt CRYPTO_LOCK 3 | 19 | .Dt CRYPTO_LOCK 3 |
| 20 | .Os | 20 | .Os |
| 21 | .Sh NAME | 21 | .Sh NAME |
| 22 | .Nm CRYPTO_THREADID_current , | ||
| 23 | .Nm CRYPTO_THREADID_cmp , | ||
| 24 | .Nm CRYPTO_THREADID_cpy , | ||
| 25 | .Nm CRYPTO_THREADID_hash , | ||
| 26 | .Nm CRYPTO_lock , | 22 | .Nm CRYPTO_lock , |
| 27 | .Nm CRYPTO_w_lock , | 23 | .Nm CRYPTO_w_lock , |
| 28 | .Nm CRYPTO_w_unlock , | 24 | .Nm CRYPTO_w_unlock , |
| @@ -33,24 +29,6 @@ | |||
| 33 | .Sh SYNOPSIS | 29 | .Sh SYNOPSIS |
| 34 | .In openssl/crypto.h | 30 | .In openssl/crypto.h |
| 35 | .Ft void | 31 | .Ft void |
| 36 | .Fo CRYPTO_THREADID_current | ||
| 37 | .Fa "CRYPTO_THREADID *id" | ||
| 38 | .Fc | ||
| 39 | .Ft int | ||
| 40 | .Fo CRYPTO_THREADID_cmp | ||
| 41 | .Fa "const CRYPTO_THREADID *a" | ||
| 42 | .Fa "const CRYPTO_THREADID *b" | ||
| 43 | .Fc | ||
| 44 | .Ft void | ||
| 45 | .Fo CRYPTO_THREADID_cpy | ||
| 46 | .Fa "CRYPTO_THREADID *dest" | ||
| 47 | .Fa "const CRYPTO_THREADID *src" | ||
| 48 | .Fc | ||
| 49 | .Ft unsigned long | ||
| 50 | .Fo CRYPTO_THREADID_hash | ||
| 51 | .Fa "const CRYPTO_THREADID *id" | ||
| 52 | .Fc | ||
| 53 | .Ft void | ||
| 54 | .Fo CRYPTO_lock | 32 | .Fo CRYPTO_lock |
| 55 | .Fa "int mode" | 33 | .Fa "int mode" |
| 56 | .Fa "int type" | 34 | .Fa "int type" |
| @@ -75,18 +53,6 @@ | |||
| 75 | .Ed | 53 | .Ed |
| 76 | .Sh DESCRIPTION | 54 | .Sh DESCRIPTION |
| 77 | These functions are obsolete. | 55 | These functions are obsolete. |
| 78 | .Pp | ||
| 79 | .Fn CRYPTO_THREADID_current | ||
| 80 | stores a unique identifier of the currently executing thread | ||
| 81 | into the opaque object | ||
| 82 | .Fa id . | ||
| 83 | .Pp | ||
| 84 | .Fn CRYPTO_THREADID_cpy | ||
| 85 | copies the contents of | ||
| 86 | .Fa src | ||
| 87 | to | ||
| 88 | .Fa dest . | ||
| 89 | .Pp | ||
| 90 | .Fn CRYPTO_lock | 56 | .Fn CRYPTO_lock |
| 91 | locks or unlocks a mutex lock. | 57 | locks or unlocks a mutex lock. |
| 92 | .Pp | 58 | .Pp |
| @@ -135,20 +101,6 @@ and unlocks the lock number | |||
| 135 | .Fa type | 101 | .Fa type |
| 136 | again. | 102 | again. |
| 137 | .Sh RETURN VALUES | 103 | .Sh RETURN VALUES |
| 138 | .Fn CRYPTO_THREADID_cmp | ||
| 139 | returns 0 if | ||
| 140 | .Fa a | ||
| 141 | and | ||
| 142 | .Fa b | ||
| 143 | refer to the same thread or a non-zero value otherwise. | ||
| 144 | .Pp | ||
| 145 | .Fn CRYPTO_THREADID_hash | ||
| 146 | returns a numeric value usable as a hash-table key. | ||
| 147 | In the LibreSSL implementation, it is the value returned from | ||
| 148 | .Xr pthread_self 3 | ||
| 149 | for the thread | ||
| 150 | .Fa id . | ||
| 151 | .Pp | ||
| 152 | .Fn CRYPTO_add | 104 | .Fn CRYPTO_add |
| 153 | returns the new value of | 105 | returns the new value of |
| 154 | .Pf * Fa p . | 106 | .Pf * Fa p . |
| @@ -166,11 +118,3 @@ first appeared in SSLeay 0.6.0. | |||
| 166 | first appeared in SSLeay 0.6.2. | 118 | first appeared in SSLeay 0.6.2. |
| 167 | These functions have been available since | 119 | These functions have been available since |
| 168 | .Ox 2.4 . | 120 | .Ox 2.4 . |
| 169 | .Pp | ||
| 170 | .Fn CRYPTO_THREADID_current , | ||
| 171 | .Fn CRYPTO_THREADID_cmp , | ||
| 172 | .Fn CRYPTO_THREADID_cpy , | ||
| 173 | and | ||
| 174 | .Fn CRYPTO_THREADID_hash | ||
| 175 | first appeared in OpenSSL 1.0.0 and have been available since | ||
| 176 | .Ox 4.9 . | ||
