mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-03-07 19:38:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Make the OSSL_HTTP manual conform with man-pages(7)

Browse Source 
Details from man-pages(7) that are used:

    Formatting conventions for manual pages describing functions

        ...
        Variable names should, like argument names, be specified in italics.
        ...

    Formatting conventions (general)

        ...
        Special macros, which are usually in uppercase, are in bold.
        Exception: don't boldface NULL.
        ...

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/13847)
This commit is contained in:
Richard Levitte 2021-01-12 16:05:55 +01:00
parent ab21608952
commit ad2cc1a08e
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/man3/OSSL_HTTP_transfer.pod
View File

@ -198,15 +198,15 @@ where IPv6 addresses should be enclosed in square brackets C<[> and C<]>.
The port component is optional and defaults to "443" for HTTPS, else "80".
If the I<pport_num> argument is NULL the port specification
can be in mnemonic form such as "http" like with L<BIO_set_conn_port(3)>, else
it must be in numerical form and its integer value is assigned to B<*pport_num>.
it must be in numerical form and its integer value is assigned to I<*pport_num>.
The path component is also optional and defaults to "/".
On success the function assigns via each non-NULL result pointer argument
I<phost>, I<pport>, I<pport_num>, I<ppath>, and I<pssl>
the respective url component.
On error, B<*phost>, B<*pport>, and B<*ppath> are assigned to NULL,
On error, I<*phost>, I<*pport>, and I<*ppath> are assigned to NULL,
else they are guaranteed to contain non-NULL string pointers.
It is the reponsibility of the caller to free them using L<OPENSSL_free(3)>.
A string returned via B<*ppath> is guaranteed to begin with a C</> character.
A string returned via I<*ppath> is guaranteed to begin with a C</> character.
=head1 NOTES