]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Make the OSSL_HTTP manual conform with man-pages(7)
authorRichard Levitte <levitte@openssl.org>
Tue, 12 Jan 2021 15:05:55 +0000 (16:05 +0100)
committerRichard Levitte <levitte@openssl.org>
Wed, 13 Jan 2021 22:33:16 +0000 (23:33 +0100)
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)

doc/man3/OSSL_HTTP_transfer.pod

index f78d96be1f6c15330636ab5b45d64dd904517f8b..4839b975a6a02797aae628f8fcde28fe7a1eb6a5 100644 (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