Multiple man-pages: Move to appropriate section

[debdrup]

Motivation and Context

These manual pages belong in section 7 of the manual pages as that
section, according to intro(7) on both FreeBSD and Linux, is meant to
contain miscellaneous information pages whereas section 5 describes file
formats (a good example being vdev_id.conf in zfs/man/man5/).

While here, an errant space has also been removed.

Signed-off-by: Daniel Ebdrup Jensen [email protected]

How Has This Been Tested?

Mandoc has been run, but the change doesn't change a whole lot of roff formatting.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Performance enhancement (non-breaking change which improves efficiency)
• Code cleanup (non-breaking change which makes code smaller or more readable)
• Breaking change (fix or feature that would cause existing functionality to change)
• Library ABI change (libzfs, libzfs_core, libnvpair, libuutil and libzfsbootenv)
• Documentation (a change to man pages or other documentation)

Checklist:

• My code follows the OpenZFS code style requirements.
• I have updated the documentation accordingly.
• I have read the contributing document.
• I have added tests to cover my changes.
• I have run the ZFS Test Suite with this change applied.
• All commit messages are properly formatted and contain Signed-off-by.

[ghost]

I spotted a few missed cross references to the moved pages just in the diff context, so let's make sure to grep and get all of them.

[debdrup]

I spotted a few missed cross references to the moved pages just in the diff context, so let's make sure to grep and get all of them.

You're right, I missed quite a few.
Apparently my own grep wasn't thorough enough.
I'll fix 'em. :)

While here, I also noticed that I forgot some other things.

[ghost]

Thanks. There are still 3 files renamed without changes, so they still have the old section number in them:

• spl-module-parameters
• zfs-module-parameters
• zfs-events

[debdrup]

Thanks. There are still 3 files renamed without changes, so they still have the old section number in them:

* spl-module-parameters

* zfs-module-parameters

* zfs-events

Ah, good catch!

I have to admit that I wasn't aware of the .ST macro.
It doesn't seem reasonable to assume it has anything to do with .St as described here, nor is it mentioned in mdoc(7), nor roff(7), so I'm a bit confused about where it originates.

[ghost]

FYI there are a few other batches of manpage changes open right now such as #12125 and #12129 which may conflict a bit, but should also make the manpages much cleaner WRT mandoc style.

[nabijaczleweli]

Yeah, can we hold off on this until after #12125 and #12129 please? I touch all but two manpages (and rewrite some in parts or in full) in those and it was already a tremendous effort (and I don't say that lightly), and just rebasing that onto the new ztest.1 was non-obvious.

If you like, if you compile the list of renames from here I can run them myself after these land (which will be likely simpler to get right since most manpages properly .Xr now) and submit that?

[debdrup]

Yeah, can we hold off on this until after #12125 and #12129 please? I touch all but two manpages (and rewrite some in parts or in full) in those and it was already a tremendous effort (and I don't say that lightly), and just rebasing that onto the new ztest.1 was non-obvious.

Yeah, I can imagine, as that's quite a bit of work.

If you like, if you compile the list of renames from here I can run them myself after these land (which will be likely simpler to get right since most manpages properly .Xr now) and submit that?

Sure, I don't mind as long as it gets done, that's what I care about. :)

The files are:

• zpool-features.5
• spl-module-parameters.5
• zfs-module-parameters.5
• zfs-events.5
• zfsconcepts.8
• zfsprops.8
• zpoolconcepts.8
• zpoolprops.8

This can also be seen by looking the subtractions in man5/Makefile.am and man8/Makefile.am here.

Can I get a Co-authored-by: Daniel Ebdrup Jensen <debdrup at FreeBSD.org>?

[nabijaczleweli]

Sure thing

[behlendorf]

@debdrup it'd be great to get your thoughts on the right location for some of these man pages. @nabijaczleweli posted a nice detailed #12196 (comment) which goes over rationals for various locations.