summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/ERR_remove_state.pod
diff options
context:
space:
mode:
authorschwarze <>2016-11-02 15:23:41 +0000
committerschwarze <>2016-11-02 15:23:41 +0000
commit878e440382fa65ddbadca1d2784ef1210f0ff652 (patch)
treed746bbb5cfe6d085f48965873fc3db01fe55f4d6 /src/lib/libcrypto/doc/ERR_remove_state.pod
parent0f15bae599b571173b77a87f7c4949ff89c55a23 (diff)
downloadopenbsd-878e440382fa65ddbadca1d2784ef1210f0ff652.tar.gz
openbsd-878e440382fa65ddbadca1d2784ef1210f0ff652.tar.bz2
openbsd-878e440382fa65ddbadca1d2784ef1210f0ff652.zip
convert ERR manuals from pod to mdoc; while reading this,
i wtfed, laughed, puked, and cried in more or less that order...
Diffstat (limited to 'src/lib/libcrypto/doc/ERR_remove_state.pod')
-rw-r--r--src/lib/libcrypto/doc/ERR_remove_state.pod45
1 files changed, 0 insertions, 45 deletions
diff --git a/src/lib/libcrypto/doc/ERR_remove_state.pod b/src/lib/libcrypto/doc/ERR_remove_state.pod
deleted file mode 100644
index a4d38c17fd..0000000000
--- a/src/lib/libcrypto/doc/ERR_remove_state.pod
+++ /dev/null
@@ -1,45 +0,0 @@
1=pod
2
3=head1 NAME
4
5ERR_remove_thread_state, ERR_remove_state - free a thread's error queue
6
7=head1 SYNOPSIS
8
9 #include <openssl/err.h>
10
11 void ERR_remove_thread_state(const CRYPTO_THREADID *tid);
12
13Deprecated:
14
15 void ERR_remove_state(unsigned long pid);
16
17=head1 DESCRIPTION
18
19ERR_remove_thread_state() frees the error queue associated with thread B<tid>.
20If B<tid> == B<NULL>, the current thread will have its error queue removed.
21
22Since error queue data structures are allocated automatically for new
23threads, they must be freed when threads are terminated in order to
24avoid memory leaks.
25
26ERR_remove_state is deprecated and has been replaced by
27ERR_remove_thread_state. Since threads in OpenSSL are no longer identified
28by unsigned long values any argument to this function is ignored. Calling
29ERR_remove_state is equivalent to B<ERR_remove_thread_state(NULL)>.
30
31=head1 RETURN VALUE
32
33ERR_remove_thread_state and ERR_remove_state() return no value.
34
35=head1 SEE ALSO
36
37L<err(3)|err(3)>
38
39=head1 HISTORY
40
41ERR_remove_state() is available in all versions of SSLeay and OpenSSL. It
42was deprecated in OpenSSL 1.0.0 when ERR_remove_thread_state was introduced
43and thread IDs were introduced to identify threads instead of 'unsigned long'.
44
45=cut