diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-09-28 07:33:38 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-10-01 22:34:03 +0200 |
| commit | bbecf04e7861b6ab9ca1bd5ee5100bd49a347b4a (patch) | |
| tree | d89ecea12131a9d4bd1f914044e19c564de47cab /doc/internal | |
| parent | 723e9c8983f92bc256a7e8677cc02f05b47e227c (diff) | |
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)
Diffstat (limited to 'doc/internal')
| -rw-r--r-- | doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod | 9 | ||||
| -rw-r--r-- | doc/internal/man3/ossl_param_bld_init.pod | 2 |
2 files changed, 6 insertions, 5 deletions
diff --git a/doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod b/doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod index 8617c97581..7917c4c812 100644 --- a/doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod +++ b/doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod @@ -42,10 +42,11 @@ the processor along =end comment SPARSE_ARRAY_OF() returns the name for a sparse array of the specified -I<TYPE>. DEFINE_STACK_OF() creates set of functions for a sparse array of -I<TYPE>. This will mean that a pointer to type I<TYPE> is stored in each -element of a sparse array, the type is referenced by B<SPARSE_ARRAY_OF>(I<TYPE>) -and each function name begins with B<ossl_sa_I<TYPE>_>. For example: +B<I<TYPE>>. DEFINE_STACK_OF() creates set of functions for a sparse +array of B<I<TYPE>>. This will mean that a pointer to type B<I<TYPE>> +is stored in each element of a sparse array, the type is referenced by +B<SPARSE_ARRAY_OF>(B<I<TYPE>>) and each function name begins with +B<ossl_sa_I<TYPE>_>. For example: TYPE *ossl_sa_TYPE_get(SPARSE_ARRAY_OF(TYPE) *sa, ossl_uintmax_t idx); diff --git a/doc/internal/man3/ossl_param_bld_init.pod b/doc/internal/man3/ossl_param_bld_init.pod index fb439f24a6..5179a8d64a 100644 --- a/doc/internal/man3/ossl_param_bld_init.pod +++ b/doc/internal/man3/ossl_param_bld_init.pod @@ -48,7 +48,7 @@ ossl_param_bld_push_octet_ptr =head1 DESCRIPTION A collection of utility functions that simplify the creation of OSSL_PARAM -arrays. The B<TYPE> names are as per L<OSSL_PARAM_int(3)>. +arrays. The B<I<TYPE>> names are as per L<OSSL_PARAM_int(3)>. ossl_param_bld_init() initialises the OSSL_PARAM_BLD structure so that values can be added. |