]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/commit
Reorganize zfs(8) man page into sections
authorRoss Williams <ross@ross-williams.net>
Tue, 12 Nov 2019 19:17:40 +0000 (14:17 -0500)
committerBrian Behlendorf <behlendorf1@llnl.gov>
Tue, 12 Nov 2019 19:17:40 +0000 (11:17 -0800)
commit870fc32fc94fcc5108868b4a64cb694c72dc2e21
treebbc7c6c89008b609bddac037dd7d479b85f59e96
parent1f2f46be9576964c90ca25805c9741d56bbaccdf
Reorganize zfs(8) man page into sections

Most subcommands got their own manpages (e.g. create). Some related
commands grouped into a single manpage and symlinks created (e.g. set,
get, and inherit). I did this when topics were either too short to
warrant their own file or so interrelated that a user would want to
refer between commands in the same file.

Corrected .Sx internal references to .Xr cross refs; lots of .Sx
references from when text was all in zfs.8 needed to be changed to
.Xr zfs-$SUBCOMMAND 8 cross references.

Divided subcommand list in zfs(8) into sections of related
functionality. This required writing new descriptions for some
commands.

Preserved ".Os Linux", `.Os` macro parsing behavior differs between
mandoc from the "BSD" mandoc package (available on Ubuntu) and man
from Ubuntu's man-db package, which calls groff to format the manpages.

Groff handles the `.Os` macro differently and wrongly, defaulting
it to "BSD" in `/usr/share/groff/*/tmac/mdoc/doc-common`, instead of
getting the default from `uname`.

A future set of changes will introduce build-time preprocessing of
manpages for platform-specific documentation and can insert the
correct operating system name.

Added SEE ALSO sections, the newly-divided zfs-*.8 subcommand man
pages needed their own SEE ALSO sections pointing to related
subcommands and, in some cases, documentation from other packages
(e.g. zfs-share.8).

Reviewed-by: Matt Ahrens <matt@delphix.com>
Reviewed-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
Reviewed-by: Sean Eric Fagan <sef@ixsystems.com>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ross Williams <ross@ross-williams.net>
Closes #9559
36 files changed:
man/man8/Makefile.am
man/man8/zfs-allow.8 [new file with mode: 0644]
man/man8/zfs-bookmark.8 [new file with mode: 0644]
man/man8/zfs-change-key.8 [new symlink]
man/man8/zfs-clone.8 [new file with mode: 0644]
man/man8/zfs-create.8 [new file with mode: 0644]
man/man8/zfs-destroy.8 [new file with mode: 0644]
man/man8/zfs-diff.8 [new file with mode: 0644]
man/man8/zfs-get.8 [new symlink]
man/man8/zfs-groupspace.8 [new symlink]
man/man8/zfs-hold.8 [new file with mode: 0644]
man/man8/zfs-inherit.8 [new symlink]
man/man8/zfs-list.8 [new file with mode: 0644]
man/man8/zfs-load-key.8 [new file with mode: 0644]
man/man8/zfs-mount.8 [new file with mode: 0644]
man/man8/zfs-project.8 [new file with mode: 0644]
man/man8/zfs-projectspace.8 [new symlink]
man/man8/zfs-promote.8 [new file with mode: 0644]
man/man8/zfs-receive.8 [new file with mode: 0644]
man/man8/zfs-recv.8 [new symlink]
man/man8/zfs-redact.8 [new symlink]
man/man8/zfs-release.8 [new symlink]
man/man8/zfs-rename.8 [new file with mode: 0644]
man/man8/zfs-rollback.8 [new file with mode: 0644]
man/man8/zfs-send.8 [new file with mode: 0644]
man/man8/zfs-set.8 [new file with mode: 0644]
man/man8/zfs-share.8 [new file with mode: 0644]
man/man8/zfs-snapshot.8 [new file with mode: 0644]
man/man8/zfs-unallow.8 [new symlink]
man/man8/zfs-unload-key.8 [new symlink]
man/man8/zfs-unmount.8 [new symlink]
man/man8/zfs-upgrade.8 [new file with mode: 0644]
man/man8/zfs-userspace.8 [new file with mode: 0644]
man/man8/zfs.8
man/man8/zfsconcepts.8 [new file with mode: 0644]
man/man8/zfsprops.8 [new file with mode: 0644]