openssl/doc
Richard Levitte c18d2d94c8 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)
2019-09-28 06:33:16 +02:00
..
HOWTO
internal/man3 Funtion name with variable part in doc/man7/ and doc/internal/man3/ 2019-09-28 06:33:16 +02:00
man1 Ensure man1 POD files start with openssl- 2019-09-26 08:10:47 +02:00
man3 OSSL_PARAM functions: change to allow the data field to be NULL 2019-09-27 19:03:34 +02:00
man5 Add fips module integrity check 2019-09-15 19:55:10 +10:00
man7 Funtion name with variable part in doc/man7/ and doc/internal/man3/ 2019-09-28 06:33:16 +02:00
dir-locals.example.el
fingerprints.txt
openssl-c-indent.el
README

README  This file

fingerprints.txt
        PGP fingerprints of authorised release signers

standards.txt
        Moved to the web, https://www.openssl.org/docs/standards.html

HOWTO/
        A few how-to documents; not necessarily up-to-date

man1/
        The openssl command-line tools; start with openssl.pod

man3/
        The SSL library and the crypto library

man5/
        File formats

man7/
        Overviews; start with crypto.pod and ssl.pod, for example
        Algorithm specific EVP_PKEY documentation.

Formatted versions of the manpages (apps,ssl,crypto) can be found at
        https://www.openssl.org/docs/manpages.html