]> git.ipfire.org Git - thirdparty/util-linux.git/commit
Manual pages: Standardize on EXAMPLE as section title
authorMichael Kerrisk (man-pages) <mtk.manpages@gmail.com>
Tue, 19 May 2020 12:51:48 +0000 (14:51 +0200)
committerKarel Zak <kzak@redhat.com>
Wed, 20 May 2020 10:56:12 +0000 (12:56 +0200)
commitbc281b099187424e453b258957a552e8dc7952ff
tree0c6beefe6713cc51bd7f3a826f3181c18d615480
parenta8d0d330cf15ffe79307cd8a1689b19e7565f92e
Manual pages: Standardize on EXAMPLE as section title

There is quite some value (in terms of readability and user
expectations) if consistent names are used for the sections
within manual pages. This patch is one of a series to bring
about this consistency.

Currently we have EXAMPLE (10) or EXAMPLES (23).
Let's standardize on the EXAMPLE (which is also what is
suggested in man-pages(7)) and used consistently across
a large number of pages in the Linux man-pages project.

(I realize the choice to go EXAMPLE, rather than EXAMPLES,
may be debatable. If necessary, I'd write a patch that instead
goes the other way, but I'd prefer to follow man-pages(7).)

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
21 files changed:
disk-utils/partx.8
lib/terminal-colors.d.5
misc-utils/findmnt.8
misc-utils/logger.1
misc-utils/rename.1
misc-utils/uuidgen.1
misc-utils/wipefs.8
schedutils/ionice.1
sys-utils/chmem.8
sys-utils/flock.1
sys-utils/pivot_root.8
sys-utils/prlimit.1
sys-utils/readprofile.8
sys-utils/renice.1
sys-utils/rfkill.8
sys-utils/setarch.8
sys-utils/unshare.1
term-utils/agetty.8
text-utils/colcrt.1
text-utils/column.1
text-utils/hexdump.1