From: Richard Levitte <levitte@openssl.org>
Date: Tue, 12 Jan 2021 15:13:42 +0000 (+0100)
Subject: Make the OSSL_PROVIDER manual conform with man-pages(7)
X-Git-Tag: openssl-3.0.0-alpha11~109
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2645c94bb56120a6b7b7c34d70a2900aeda1637c;p=thirdparty%2Fopenssl.git

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

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/13845)
---

diff --git a/doc/man3/OSSL_PROVIDER.pod b/doc/man3/OSSL_PROVIDER.pod
index fa9d45b11d5..2baccfffaff 100644
--- a/doc/man3/OSSL_PROVIDER.pod
+++ b/doc/man3/OSSL_PROVIDER.pod
@@ -61,8 +61,8 @@ L<OSSL_LIB_CTX(3)> for further details.
 
 =head2 Functions
 
-OSSL_PROVIDER_set_default_search_path() specifies the default search B<path>
-that is to be used for looking for providers in the specified B<libctx>.
+OSSL_PROVIDER_set_default_search_path() specifies the default search I<path>
+that is to be used for looking for providers in the specified I<libctx>.
 If left unspecified, an environment variable and a fall back default value will
 be used instead.
 
@@ -138,7 +138,7 @@ OSSL_PROVIDER_add(), OSSL_PROVIDER_unload(), OSSL_PROVIDER_get_params() and
 OSSL_PROVIDER_get_capabilities() return 1 on success, or 0 on error.
 
 OSSL_PROVIDER_load() and OSSL_PROVIDER_try_load() return a pointer to a
-provider object on success, or B<NULL> on error.
+provider object on success, or NULL on error.
 
 OSSL_PROVIDER_available() returns 1 if the named provider is available,
 otherwise 0.