diff options
author | Rich Salz <rsalz@akamai.com> | 2019-09-25 15:20:11 -0400 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2019-10-01 08:36:58 +0200 |
commit | e8769719c9bbe53d7af088111b7625671660d4db (patch) | |
tree | 222b64baed23d8f70f19928e58486851e5b7fc95 /doc/man5 | |
parent | 4dcb150ea30f9bbfa7946e6b39c30a86aca5ed02 (diff) |
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/man5')
-rw-r--r-- | doc/man5/config.pod | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/man5/config.pod b/doc/man5/config.pod index 5e950d740a..5509c740e5 100644 --- a/doc/man5/config.pod +++ b/doc/man5/config.pod @@ -13,9 +13,9 @@ files for the B<x509> utility. OpenSSL applications can also use the CONF library for their own purposes. A configuration file is divided into a number of sections. Each section -starts with a line B<[ section_name ]> and ends when a new section is +starts with a line C<[section_name]> and ends when a new section is started or end of file is reached. A section name can consist of -alphanumeric characters and underscores. +alphanumeric characters and underscores. The brackets are required. The first section of a configuration file is special and is referred to as the B<default> section. This section is usually unnamed and spans from the |