summaryrefslogtreecommitdiffstats
path: root/doc/man3/CRYPTO_THREAD_run_once.pod
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2021-01-12 15:44:43 +0100
committerRichard Levitte <levitte@openssl.org>2021-01-13 23:39:59 +0100
commit879365e6d4a53d80e83bbe468fcf2cdd02d30ba1 (patch)
tree7c7819e06f0d12b26685b8d2b88d49e1cacb66cc /doc/man3/CRYPTO_THREAD_run_once.pod
parent0f2380066de6436c0e8debfad1391db134ad4c25 (diff)
Make header references conform with man-pages(7) in all manuals
Details from man-pages(7) that are used: Formatting conventions (general) ... Filenames (whether pathnames, or references to header files) are always in italics (e.g., <stdio.h>), except in the SYNOPSIS section, where in‐ cluded files are in bold (e.g., #include <stdio.h>). When referring to a standard header file include, specify the header file surrounded by angle brackets, in the usual C way (e.g., <stdio.h>). ... Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/13843)
Diffstat (limited to 'doc/man3/CRYPTO_THREAD_run_once.pod')
-rw-r--r--doc/man3/CRYPTO_THREAD_run_once.pod13
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/man3/CRYPTO_THREAD_run_once.pod b/doc/man3/CRYPTO_THREAD_run_once.pod
index a182359f47..3a46809efe 100644
--- a/doc/man3/CRYPTO_THREAD_run_once.pod
+++ b/doc/man3/CRYPTO_THREAD_run_once.pod
@@ -113,12 +113,13 @@ The other functions return 1 on success, or 0 on error.
=head1 NOTES
On Windows platforms the CRYPTO_THREAD_* types and functions in the
-openssl/crypto.h header are dependent on some of the types customarily
-made available by including windows.h. The application developer is
-likely to require control over when the latter is included, commonly as
-one of the first included headers. Therefore, it is defined as an
-application developer's responsibility to include windows.h prior to
-crypto.h where use of CRYPTO_THREAD_* types and functions is required.
+F<< <openssl/crypto.h> >> header are dependent on some of the types
+customarily made available by including F<< <windows.h> >>. The application
+developer is likely to require control over when the latter is included,
+commonly as one of the first included headers. Therefore, it is defined as an
+application developer's responsibility to include F<< <windows.h> >> prior to
+F<< <openssl/crypto.h> >> where use of CRYPTO_THREAD_* types and functions is
+required.
=head1 EXAMPLES