Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple man-pages: Move to appropriate section #12149

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1 +1 @@
SUBDIRS = man1 man5 man8
SUBDIRS = man1 man5 man7 man8
4 changes: 0 additions & 4 deletions man/man5/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
dist_man_MANS = \
vdev_id.conf.5 \
zpool-features.5 \
spl-module-parameters.5 \
zfs-module-parameters.5 \
zfs-events.5

if BUILD_LINUX
# The man pager in most Linux distros defaults to BSD instead of Linux
Expand Down
19 changes: 19 additions & 0 deletions man/man7/Makefile.am
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
dist_man_MANS = \
spl-module-parameters.7 \
zfsconcepts.7 \
zfsprops.7 \
zfs-events.7 \
zfs-module-parameters.7 \
zpoolconcepts.7
zpoolprops.7 \
zpool-features.7

if BUILD_LINUX
# The man pager in most Linux distros defaults to BSD instead of Linux
# when .Os is blank, but leaving it blank makes things a lot easier on
# FreeBSD when OpenZFS is vendored in the base system.
install-data-hook:
cd $(DESTDIR)$(mandir)/man5; \
debdrup marked this conversation as resolved.
Show resolved Hide resolved
$(SED) ${ac_inplace} -e 's/^\.Os$$/.Os Linux/' \
$(dist_man_MANS)
endif
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 0 additions & 4 deletions man/man8/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ dist_man_MANS = \
vdev_id.8 \
zdb.8 \
zfs.8 \
zfsconcepts.8 \
zfsprops.8 \
zfs-allow.8 \
zfs-bookmark.8 \
zfs-change-key.8 \
Expand Down Expand Up @@ -48,8 +46,6 @@ dist_man_MANS = \
zgenhostid.8 \
zinject.8 \
zpool.8 \
zpoolconcepts.8 \
zpoolprops.8 \
zpool-add.8 \
zpool-attach.8 \
zpool-checkpoint.8 \
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfs-bookmark.8
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ a redaction bookmark.
.Pp
This feature must be enabled to be used.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags and the
.Sy bookmarks
feature.
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfs-receive.8
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ To use this flag, the storage pool must have the
.Sy extensible_dataset
feature enabled.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags.
.It Fl u
File system that is associated with the received stream is not mounted.
Expand Down
8 changes: 4 additions & 4 deletions man/man8/zfs-send.8
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ The receiving system must have the
.Sy large_blocks
pool feature enabled as well.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags and the
.Sy large_blocks
feature.
Expand Down Expand Up @@ -159,7 +159,7 @@ received as an encrypted dataset, since encrypted datasets cannot use the
.Sy embedded_data
feature.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags and the
.Sy embedded_data
feature.
Expand Down Expand Up @@ -302,7 +302,7 @@ The receiving system must have the
.Sy large_blocks
pool feature enabled as well.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags and the
.Sy large_blocks
feature.
Expand Down Expand Up @@ -364,7 +364,7 @@ received as an encrypted dataset, since encrypted datasets cannot use the
.Sy embedded_data
feature.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on ZFS feature flags and the
.Sy embedded_data
feature.
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zgenhostid.8
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ and ovewrite the file if it exists
.Xr genhostid 1 ,
.Xr hostid 1 ,
.Xr sethostid 3 ,
.Xr spl-module-parameters 5
.Xr spl-module-parameters 7
.Sh HISTORY
.Nm
emulates the
Expand Down
6 changes: 3 additions & 3 deletions man/man8/zpool-create.8
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ with the
.Fl o
option.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details about feature properties.
.It Fl f
Forces use of
Expand Down Expand Up @@ -189,11 +189,11 @@ See the
manual page for a list of valid properties that can be set.
.It Fl o Ar compatibility Ns = Ns Ar off | legacy | file Bq , Ns Ar file Ns ...
Specifies compatibility feature sets. See
.Xr zpool-features 5
.Xr zpool-features 7
for more information about compatibility feature sets.
.It Fl o Ar feature@feature Ns = Ns Ar value
Sets the given pool feature. See the
.Xr zpool-features 5
.Xr zpool-features 7
section for a list of valid features that can be set.
Value can be either disabled or enabled.
.It Fl O Ar file-system-property Ns = Ns Ar value
Expand Down
6 changes: 3 additions & 3 deletions man/man8/zpool-events.8
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ are consumed by the
and used to automate administrative tasks such as replacing a failed device
with a hot spare. For more information about the subclasses and event payloads
that can be generated see the
.Xr zfs-events 5
.Xr zfs-events 7
man page.
.Bl -tag -width Ds
.It Fl c
Expand All @@ -67,5 +67,5 @@ Print the entire payload for each event.
.Sh SEE ALSO
.Xr zed 8 ,
.Xr zpool-wait 8 ,
.Xr zfs-events 5 ,
.Xr zfs-module-parameters 5
.Xr zfs-events 7 ,
.Xr zfs-module-parameters 7
2 changes: 1 addition & 1 deletion man/man8/zpool-get.8
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ values.
.Sh SEE ALSO
.Xr zpoolprops 8 ,
This conversation was marked as resolved.
Show resolved Hide resolved
.Xr zpool-list 8 ,
.Xr zpool-features 5
.Xr zpool-features 7
2 changes: 1 addition & 1 deletion man/man8/zpool-remove.8
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ If an IO error is encountered during the removal process it will be
cancelled. The
.Sy device_removal
feature flag must be enabled to remove a top-level vdev, see
.Xr zpool-features 5 .
.Xr zpool-features 7 .
.Pp
A mirrored top-level device (log or data) can be removed by specifying the top-level mirror for the
same.
Expand Down
8 changes: 4 additions & 4 deletions man/man8/zpool-upgrade.8
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ property).
.Xc
Displays legacy ZFS versions supported by the current software.
See
.Xr zpool-features 5
.Xr zpool-features 7
for a description of feature flags features supported by the current software.
.It Xo
.Nm zpool
Expand All @@ -78,14 +78,14 @@ Enables all supported features on the given pool.
If the pool has specified compatibility feature sets using the
.Fl o Ar compatibility
property, only the features present in all requested compatibility sets will be
enabled. If this property is set to
enabled. If this property is set to
.Ar legacy
then no upgrade will take place.
.Pp
Once this is done, the pool will no longer be accessible on systems that do not
support feature flags.
See
.Xr zpool-features 5
.Xr zpool-features 7
for details on compatibility with systems that support feature flags, but do not
support all features enabled on the pool.
.Bl -tag -width Ds
Expand All @@ -102,7 +102,7 @@ supported legacy version number.
.El
.El
.Sh SEE ALSO
.Xr zpool-features 5 ,
.Xr zpool-features 7 ,
.Xr zpoolconcepts 8 ,
.Xr zpoolprops 8 ,
This conversation was marked as resolved.
Show resolved Hide resolved
.Xr zpool-history 8
12 changes: 6 additions & 6 deletions man/man8/zpool.8
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ are consumed by the
and used to automate administrative tasks such as replacing a failed device
with a hot spare. For more information about the subclasses and event payloads
that can be generated see the
.Xr zfs-events 5
.Xr zfs-events 7
man page.
.It Xr zpool-history 8
Displays the command history of the specified pool(s) or all pools if no pool is
Expand Down Expand Up @@ -559,9 +559,9 @@ is not set, it is assumed that the user is allowed to run
.Sh INTERFACE STABILITY
.Sy Evolving
.Sh SEE ALSO
.Xr zfs-events 5 ,
.Xr zfs-module-parameters 5 ,
.Xr zpool-features 5 ,
.Xr zfs-events 7 ,
.Xr zfs-module-parameters 7 ,
.Xr zpool-features 7 ,
.Xr zed 8 ,
.Xr zfs 8 ,
.Xr zpool-add 8 ,
Expand Down Expand Up @@ -595,5 +595,5 @@ is not set, it is assumed that the user is allowed to run
.Xr zpool-trim 8 ,
.Xr zpool-upgrade 8 ,
.Xr zpool-wait 8 ,
.Xr zpoolconcepts 8 ,
.Xr zpoolprops 8
.Xr zpoolconcepts 7 ,
.Xr zpoolprops 7