]> git.ipfire.org Git - thirdparty/openssl.git/commit - doc/man3/PEM_read_CMS.pod
Make manuals with TYPE conform with man-pages(7)
authorRichard Levitte <levitte@openssl.org>
Sat, 28 Sep 2019 05:33:38 +0000 (07:33 +0200)
committerRichard Levitte <levitte@openssl.org>
Tue, 1 Oct 2019 20:34:03 +0000 (22:34 +0200)
commitbbecf04e7861b6ab9ca1bd5ee5100bd49a347b4a
treed89ecea12131a9d4bd1f914044e19c564de47cab
parent723e9c8983f92bc256a7e8677cc02f05b47e227c
Make manuals with TYPE 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.
        ...

Furthermore, for TYPE used as a placeholder for types and correponding
part of function names, we extrapolate that it's both a type and a
variable, and should therefore be bold (typical for types and function
names) and italic (typical for variables).  POD processors don'e know
this, so we have to help them along.  Therefore:

   SPARSE_ARRAY_OF(TYPE)        => B<SPARSE_ARRAY_OF>(B<I<TYPE>>)
   ossl_sa_TYPE_num()           => B<ossl_sa_I<TYPE>_num>()
   TYPE                         => B<I<TYPE>>

There are some other less typical uses where one simply has to give
formatting some extra though.

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10041)
doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod
doc/internal/man3/ossl_param_bld_init.pod
doc/man3/DEFINE_STACK_OF.pod
doc/man3/OPENSSL_LH_COMPFUNC.pod
doc/man3/PEM_read_CMS.pod
doc/man3/PEM_read_bio_PrivateKey.pod
doc/man3/X509_dup.pod
doc/man3/d2i_X509.pod