diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-09-27 13:26:22 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-09-28 06:33:16 +0200 |
| commit | dfabee82be84f8ac80eede5d552058fbcdf4928d (patch) | |
| tree | b4c59fbe849d95e57cad84078f88dc97ec6d549c /doc/man7/bio.pod | |
| parent | [KDF] Add KBKDF implementation for counter-mode HMAC (diff) | |
| download | openssl-dfabee82be84f8ac80eede5d552058fbcdf4928d.tar.xz openssl-dfabee82be84f8ac80eede5d552058fbcdf4928d.zip | |
Make doc/man7/ and doc/internal/man3/ conform with man-pages(7)
It's all in the details, from man-pages(7):
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.
...
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 | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/man7/bio.pod b/doc/man7/bio.pod index bc1fb1e45e..1d3276b730 100644 --- a/doc/man7/bio.pod +++ b/doc/man7/bio.pod @@ -47,7 +47,7 @@ in a memory leak. Calling BIO_free_all() on a single BIO has the same effect as calling BIO_free() on it other than the discarded return value. -Normally the B<type> argument is supplied by a function which returns a +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_*(); |