diff options
author | Alexander Richter <67486332+Procyhon@users.noreply.github.com> | 2021-05-26 21:17:08 +0200 |
---|---|---|
committer | Alexander Richter <67486332+Procyhon@users.noreply.github.com> | 2021-05-27 22:42:50 +0200 |
commit | 6deb1bc2aea34320fd0b463257332cfa06475aa1 (patch) | |
tree | 30ded36e5daa08d31db18c627bda3f1553645f4e /pkg/domain/utils | |
parent | 8f71881a63b5b5422efe523d10d360650ecf9c67 (diff) | |
download | podman-6deb1bc2aea34320fd0b463257332cfa06475aa1.tar.gz podman-6deb1bc2aea34320fd0b463257332cfa06475aa1.tar.bz2 podman-6deb1bc2aea34320fd0b463257332cfa06475aa1.zip |
Manpage syntax proposal
I looked at the man pages and found that while they are consistent in their basic concept, many things concerning formatting are not.
For example, it is not consistent that options are behind an H4 header.
The biggest criticism, however, is how commands and options are handled when referencing them in a text.
There is no clear structure between the man pages regarding this. Sometimes backticks are used and sometimes they are written in italic.
Also, the formatting regarding the appearance of the commands is not consistent either.
I would like to propose a uniform formatting and, if accepted, apply it to all man pages.
Uniformity is very important to me and it should be clear to the user when reading several man pages what exactly their content and references are about.
Signed-off-by: Alexander Richter <67486332+Procyhon@users.noreply.github.com>
Diffstat (limited to 'pkg/domain/utils')
0 files changed, 0 insertions, 0 deletions