diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-09-28 05:48:54 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-09-28 06:33:16 +0200 |
| commit | c18d2d94c8a27c1dcc5036bebdfcce92874a297c (patch) | |
| tree | f62d857f0130ae408c70919a4be63f156f220457 /doc/man7/bio.pod | |
| parent | Make doc/man7/ and doc/internal/man3/ conform with man-pages(7) (diff) | |
| download | openssl-c18d2d94c8a27c1dcc5036bebdfcce92874a297c.tar.xz openssl-c18d2d94c8a27c1dcc5036bebdfcce92874a297c.zip | |
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)
Diffstat (limited to '')
| -rw-r--r-- | doc/man7/bio.pod | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/man7/bio.pod b/doc/man7/bio.pod index 1d3276b730..84892e71ac 100644 --- a/doc/man7/bio.pod +++ b/doc/man7/bio.pod @@ -49,8 +49,8 @@ BIO_free() on it other than the discarded return value. Normally the I<type> argument is supplied by a function which returns a pointer to a BIO_METHOD. There is a naming convention for such functions: -a source/sink BIO is normally called BIO_s_*() and a filter BIO -BIO_f_*(); +a source/sink BIO is normally called B<BIO_s_I<*>>() and a filter BIO +B<BIO_f_I<*>>(); =head1 EXAMPLES |