diff options
| author | Rich Salz <rsalz@akamai.com> | 2019-09-25 21:20:11 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-10-01 08:36:58 +0200 |
| commit | e8769719c9bbe53d7af088111b7625671660d4db (patch) | |
| tree | 222b64baed23d8f70f19928e58486851e5b7fc95 /doc/man7/bio.pod | |
| parent | Add defines for __NR_getrandom for all Linux architectures (diff) | |
| download | openssl-e8769719c9bbe53d7af088111b7625671660d4db.tar.xz openssl-e8769719c9bbe53d7af088111b7625671660d4db.zip | |
Consistent formatting of flags with args
For documentation of all commands with "-flag arg" format them
consistently: "B<-flag> I<arg>", except when arg is literal
(for example "B<-inform> B<PEM>|B<DER>")
Update find-doc-nits to complain if badly formatted strings are found.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10022)
Diffstat (limited to 'doc/man7/bio.pod')
| -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 84892e71ac..63380bce57 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 B<BIO_s_I<*>>() and a filter BIO -B<BIO_f_I<*>>(); +a source/sink BIO typically starts with I<BIO_s_> and +a filter BIO with I<BIO_f_>. =head1 EXAMPLES |