diff options
| author | Rich Salz <rsalz@akamai.com> | 2019-08-16 08:34:16 -0400 |
|---|---|---|
| committer | Pauli <paul.dale@oracle.com> | 2019-08-27 07:08:11 +1000 |
| commit | 485d336137f2afa62e378bc39dcfa37dcfb222da (patch) | |
| tree | a09e160c8cdc4378fb3d13a9c47989813d131904 /doc/man3/CRYPTO_THREAD_run_once.pod | |
| parent | 6d745d740d37d680ff696486218b650512bbbbc6 (diff) | |
Do not have duplicate section heads
Change find-doc-nits to complain if a section header is repeated,
within a parent header (i.e., duplicate =head2 within a =head1).
In almost all cases, we just remove the duplicate header, as
it was a "continuation" of the =head1 that was already in affect.
In some cases, just remove "=head1 NOTES", possibly moving text
around, because the "NOTES" were really important parts of the
DESCRIPTION section.
No =headX sections should end with a period.
All =head1 labels should be in all uppercase.
No sub-head (=head2, etc) should be in all uppercase.
Update find-doc-nits to reject the above.
Fixup an internal POD link
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Paul Yang <kaishen.yy@antfin.com>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/9631)
Diffstat (limited to 'doc/man3/CRYPTO_THREAD_run_once.pod')
| -rw-r--r-- | doc/man3/CRYPTO_THREAD_run_once.pod | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/doc/man3/CRYPTO_THREAD_run_once.pod b/doc/man3/CRYPTO_THREAD_run_once.pod index ee413e7672..ab7ff878be 100644 --- a/doc/man3/CRYPTO_THREAD_run_once.pod +++ b/doc/man3/CRYPTO_THREAD_run_once.pod @@ -99,6 +99,15 @@ crypto.h where use of CRYPTO_THREAD_* types and functions is required. =head1 EXAMPLES +You can find out if OpenSSL was configured with thread support: + + #include <openssl/opensslconf.h> + #if defined(OPENSSL_THREADS) + /* thread support enabled */ + #else + /* no thread support */ + #endif + This example safely initializes and uses a lock. #ifdef _WIN32 @@ -144,17 +153,6 @@ no longer in use and is unloaded. The simplest solution is to just "leak" the lock in applications and not repeatedly load/unload shared libraries that allocate locks. -=head1 NOTES - -You can find out if OpenSSL was configured with thread support: - - #include <openssl/opensslconf.h> - #if defined(OPENSSL_THREADS) - /* thread support enabled */ - #else - /* no thread support */ - #endif - =head1 SEE ALSO L<crypto(7)> |