btrfs-progs: docs: update conventions

Rename to asciidoc as that's the format we use for manual page source.

Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2020-06-08 14:31:34 +02:00
parent b79683252a
commit 62ee9a50bf
1 changed files with 16 additions and 3 deletions

View File

@ -1,3 +1,6 @@
Convention and style used for manual pages
------------------------------------------
Manual pages structure:
- add references to all external commands mentioned anywhere in the text to the
@ -13,14 +16,14 @@ Manual pages structure:
- subcommands are in alphabetical order
- long command output or shell examples: verbatim output
- a new paragraph, 2 spaces at the beginning of the line
- a new paragraph, 2 spaces at the beginning of the line, or the comment block
Quotation in subcommands:
- exact syntax: monotype `usage=0`
- reference to arguments etc: 'italics'
- command reference: bold *btrfs fi show*
- command reference: bold *btrfs filesystem show*
- subcommand names should be spelled in full, ie. 'filesystem' instead of 'fi'
- section references: italics 'EXAMPLES'
- argument name in option description: caps in angle brackets <NAME>
@ -33,6 +36,16 @@ Quotation in subcommands:
- mandatory argument: angle brackets <path>
- optional parameter with argument: [-p <path>]
Other:
- NOTE: at the beginning of the line, is rendered as a separate paragraph and
should be used only for important information
- WARNING: at the beginning of the line, is rendered as a separate paragraph
and most likely more visible than NOTE, use for critical information that
may cause harm, irreversible state or performance problems
- should point reader to other part of documentation to seek more details
References:
- full asciidoc syntax: http://asciidoc.org/userguide.html