diff options
author | tb <> | 2024-01-31 08:02:53 +0000 |
---|---|---|
committer | tb <> | 2024-01-31 08:02:53 +0000 |
commit | fb4609081cb6826359fd9a676b94a527a364b71e (patch) | |
tree | 0b6e439c34070ac9ec4b53aacdc883729e9722a5 /src/lib/libcrypto/man/OBJ_NAME_add.3 | |
parent | 6591873ca140c49434650ec8b1d34017955ca1db (diff) | |
download | openbsd-fb4609081cb6826359fd9a676b94a527a364b71e.tar.gz openbsd-fb4609081cb6826359fd9a676b94a527a364b71e.tar.bz2 openbsd-fb4609081cb6826359fd9a676b94a527a364b71e.zip |
Merge OBJ_NAME_do_all*(3) into EVP_CIPHER_do_all(3)
This is the only OBJ_NAME API that will remain after the next major bump.
The API is misnamed and really is about EVP, so move it to an EVP manual
documenting another API doing essentially the same thing. Remove most cross
references to OBJ_NAME_*.
Diffstat (limited to 'src/lib/libcrypto/man/OBJ_NAME_add.3')
-rw-r--r-- | src/lib/libcrypto/man/OBJ_NAME_add.3 | 45 |
1 files changed, 3 insertions, 42 deletions
diff --git a/src/lib/libcrypto/man/OBJ_NAME_add.3 b/src/lib/libcrypto/man/OBJ_NAME_add.3 index ad2ba80893..0b46010c49 100644 --- a/src/lib/libcrypto/man/OBJ_NAME_add.3 +++ b/src/lib/libcrypto/man/OBJ_NAME_add.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: OBJ_NAME_add.3,v 1.5 2023/09/01 12:13:13 schwarze Exp $ | 1 | .\" $OpenBSD: OBJ_NAME_add.3,v 1.6 2024/01/31 08:02:53 tb Exp $ |
2 | .\" | 2 | .\" |
3 | .\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org> | 3 | .\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org> |
4 | .\" | 4 | .\" |
@@ -14,7 +14,7 @@ | |||
14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | 14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | 15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
16 | .\" | 16 | .\" |
17 | .Dd $Mdocdate: September 1 2023 $ | 17 | .Dd $Mdocdate: January 31 2024 $ |
18 | .Dt OBJ_NAME_ADD 3 | 18 | .Dt OBJ_NAME_ADD 3 |
19 | .Os | 19 | .Os |
20 | .Sh NAME | 20 | .Sh NAME |
@@ -23,9 +23,7 @@ | |||
23 | .Nm OBJ_NAME_get , | 23 | .Nm OBJ_NAME_get , |
24 | .Nm OBJ_NAME_new_index , | 24 | .Nm OBJ_NAME_new_index , |
25 | .Nm OBJ_NAME_init , | 25 | .Nm OBJ_NAME_init , |
26 | .Nm OBJ_NAME_cleanup , | 26 | .Nm OBJ_NAME_cleanup |
27 | .Nm OBJ_NAME_do_all , | ||
28 | .Nm OBJ_NAME_do_all_sorted | ||
29 | .Nd global associative array | 27 | .Nd global associative array |
30 | .Sh SYNOPSIS | 28 | .Sh SYNOPSIS |
31 | .In openssl/objects.h | 29 | .In openssl/objects.h |
@@ -63,19 +61,6 @@ typedef struct { | |||
63 | const char *data; | 61 | const char *data; |
64 | } OBJ_NAME; | 62 | } OBJ_NAME; |
65 | .Ed | 63 | .Ed |
66 | .Pp | ||
67 | .Ft void | ||
68 | .Fo OBJ_NAME_do_all | ||
69 | .Fa "int type" | ||
70 | .Fa "void (*fn)(const OBJ_NAME *pair, void *arg)" | ||
71 | .Fa "void *arg" | ||
72 | .Fc | ||
73 | .Ft void | ||
74 | .Fo OBJ_NAME_do_all_sorted | ||
75 | .Fa "int type" | ||
76 | .Fa "void (*fn)(const OBJ_NAME *pair, void *arg)" | ||
77 | .Fa "void *arg" | ||
78 | .Fc | ||
79 | .Sh DESCRIPTION | 64 | .Sh DESCRIPTION |
80 | These functions implement a single, static associative array | 65 | These functions implement a single, static associative array |
81 | with the following properties: | 66 | with the following properties: |
@@ -264,25 +249,6 @@ If the | |||
264 | field is 0, the | 249 | field is 0, the |
265 | .Fa data | 250 | .Fa data |
266 | field contains the value; otherwise, it contains the alias target name. | 251 | field contains the value; otherwise, it contains the alias target name. |
267 | .Pp | ||
268 | .Fn OBJ_NAME_do_all | ||
269 | calls | ||
270 | .Fa fn | ||
271 | on every | ||
272 | .Fa pair | ||
273 | and alias in the array that has the given | ||
274 | .Fa type , | ||
275 | also passing the | ||
276 | .Fa arg | ||
277 | pointer. | ||
278 | .Fn OBJ_NAME_do_all_sorted | ||
279 | is similar except that it processes the pairs and aliases | ||
280 | in lexicographic order of their names as determined by | ||
281 | .Xr strcmp 3 , | ||
282 | ignoring any | ||
283 | .Fa cmp_func | ||
284 | that may be defined for the | ||
285 | .Fa type . | ||
286 | .Sh RETURN VALUES | 252 | .Sh RETURN VALUES |
287 | .Fn OBJ_NAME_add | 253 | .Fn OBJ_NAME_add |
288 | and | 254 | and |
@@ -339,8 +305,3 @@ that requires more cleanup than merely calling | |||
339 | .Xr free 3 | 305 | .Xr free 3 |
340 | on it, instances of the type need to begin with a magic number or string | 306 | on it, instances of the type need to begin with a magic number or string |
341 | that cannot occur at the beginning of a name. | 307 | that cannot occur at the beginning of a name. |
342 | .Pp | ||
343 | .Fn OBJ_NAME_do_all_sorted | ||
344 | is unable to report errors. | ||
345 | If memory allocations fails, it does nothing at all | ||
346 | without telling the caller about the problem. | ||