]> git.ipfire.org Git - thirdparty/util-linux.git/commit
Manual pages: order ENVIRONMENT / FILES / CONFORMING TO consistently
authorMichael Kerrisk (man-pages) <mtk.manpages@gmail.com>
Thu, 21 May 2020 07:28:49 +0000 (09:28 +0200)
committerKarel Zak <kzak@redhat.com>
Fri, 22 May 2020 08:25:52 +0000 (10:25 +0200)
commit380fd9aa95d7d59e50e37b5231d5a8daeab78d35
treee711c7f7cb9148b5c1d5f5e75d9bcef2982c55f8
parent67e63c12635f0edc7600c4fd1ab44e03ae9552f1
Manual pages: order ENVIRONMENT / FILES / CONFORMING TO consistently

There is value in ensuring that manual page sections use consistently
named sections, as far as possible, and also that sections have a
consistent order within manual pages. This is one of a series of patches
to place manual page sections in a consistent order.

In this patch, we ensure that the ENVIRONMENT, FILES, and CONFORMING TO
sections are always placed toward the end of the page, just above NOTES.

One page is not fixed by this patch: term-utils/agetty.8. This page
is a mess of unusual section names, and probably requires an individual
edit.

Testing that no gross editing mistake (causing accidental loss or addition
of text) was performed as follows:

    $ cat $(grep '\.SH' -l $(find . -name '*.[1-9]') |sort) | sort > a
    [Apply patch]
    $ cat $(grep '\.SH' -l $(find . -name '*.[1-9]') |sort) | sort > b
    $ diff a b
    $ echo $?
    0

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
disk-utils/fsck.8
lib/terminal-colors.d.5
sys-utils/losetup.8
sys-utils/mount.8
sys-utils/umount.8