]> git.ipfire.org Git - thirdparty/openssl.git/commit - doc/man3/OSSL_PARAM_BLD.pod
Funtion name with variable part in doc/man7/ and doc/internal/man3/
authorRichard Levitte <levitte@openssl.org>
Sat, 28 Sep 2019 03:48:54 +0000 (05:48 +0200)
committerRichard Levitte <levitte@openssl.org>
Sat, 28 Sep 2019 04:33:16 +0000 (06:33 +0200)
commitc18d2d94c8a27c1dcc5036bebdfcce92874a297c
treef62d857f0130ae408c70919a4be63f156f220457
parentdfabee82be84f8ac80eede5d552058fbcdf4928d
Funtion name with variable part in doc/man7/ and doc/internal/man3/

We have a few pages where part of function names can be considered
variable.  There are no normative guidelines for such a case, but if
we draw from the formatting convention of variable and argument names,
we can draw the conclusion that this variable part should be italized,
within already given conventions.  In other words, we need to help the
POD processor along in cases like these:

    SPARSE_ARRAY_OF(TYPE)
    ossl_sa_TYPE_num()

These need explicit formatting:

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

Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/10034)
doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod
doc/internal/man3/ossl_param_bld_init.pod
doc/man7/bio.pod