diff options
| author | Richard Levitte <levitte@openssl.org> | 2021-01-12 15:44:43 +0100 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2021-01-13 23:39:59 +0100 |
| commit | 879365e6d4a53d80e83bbe468fcf2cdd02d30ba1 (patch) | |
| tree | 7c7819e06f0d12b26685b8d2b88d49e1cacb66cc /doc/man3/ASYNC_WAIT_CTX_new.pod | |
| parent | 0f2380066de6436c0e8debfad1391db134ad4c25 (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/ASYNC_WAIT_CTX_new.pod')
| -rw-r--r-- | doc/man3/ASYNC_WAIT_CTX_new.pod | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/man3/ASYNC_WAIT_CTX_new.pod b/doc/man3/ASYNC_WAIT_CTX_new.pod index f1d6a02219..d6e5d38a12 100644 --- a/doc/man3/ASYNC_WAIT_CTX_new.pod +++ b/doc/man3/ASYNC_WAIT_CTX_new.pod @@ -192,12 +192,12 @@ ASYNC_WAIT_CTX_get_status() returns the engine status. =head1 NOTES -On Windows platforms the openssl/async.h header is dependent on some -of the types customarily made available by including windows.h. The +On Windows platforms the F<< <openssl/async.h> >> header is 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 -windows.h prior to async.h. +F<< <windows.h> >> prior to F<< <openssl/async.h> >>. =head1 SEE ALSO |