]> git.ipfire.org Git - thirdparty/util-linux.git/commit - misc-utils/lsblk.8
Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE consistently
authorMichael Kerrisk (man-pages) <mtk.manpages@gmail.com>
Thu, 21 May 2020 07:28:32 +0000 (09:28 +0200)
committerKarel Zak <kzak@redhat.com>
Fri, 22 May 2020 08:25:50 +0000 (10:25 +0200)
commit67e63c12635f0edc7600c4fd1ab44e03ae9552f1
tree8fe8faf7c225ae2fe1315c04056edf7ba989b8ce
parentade04bb89cafe3d00feffceab75ce7354482ff7d
Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE 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 NOTES, HISTORY, BUGS, and EXAMPLE
sections are always placed near the end of the page, just above
AUTHORS, COPYRIGHT, SEE ALSO, and AVAILABILITY.

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>
32 files changed:
disk-utils/mkswap.8
disk-utils/raw.8
disk-utils/sfdisk.8
lib/terminal-colors.d.5
login-utils/last.1
login-utils/lslogins.1
misc-utils/cal.1
misc-utils/findmnt.8
misc-utils/kill.1
misc-utils/logger.1
misc-utils/look.1
misc-utils/lsblk.8
misc-utils/mcookie.1
misc-utils/rename.1
misc-utils/whereis.1
schedutils/ionice.1
sys-utils/flock.1
sys-utils/fstab.5
sys-utils/ipcs.1
sys-utils/losetup.8
sys-utils/mount.8
sys-utils/prlimit.1
sys-utils/readprofile.8
sys-utils/renice.1
sys-utils/swapon.8
sys-utils/tunelp.8
term-utils/script.1
text-utils/col.1
text-utils/colcrt.1
text-utils/column.1
text-utils/hexdump.1
text-utils/ul.1