]> granicus.if.org Git - zfs/commitdiff
Refer to commands consistently in zpool-features.5
authorRichard Laager <rlaager@wiktel.com>
Mon, 15 Apr 2019 01:52:34 +0000 (20:52 -0500)
committerBrian Behlendorf <behlendorf1@llnl.gov>
Tue, 16 Apr 2019 17:01:31 +0000 (10:01 -0700)
This had a mix of command vs subcommand, quoted vs not quoted, and
bolded vs. not bolded command names.

Also, fix man page sections from 1M (Solaris) to 8 (Linux).

Reviewed-by: George Melikov <mail@gmelikov.ru>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Richard Laager <rlaager@wiktel.com>
Closes #8626

man/man5/zpool-features.5

index 919fb673daa6ff94ec3991317ebdbbc88651f4f5..275ca8234a657140864c496725a9bb15edc2b965 100644 (file)
@@ -23,7 +23,7 @@ zpool\-features \- ZFS pool feature descriptions
 ZFS pool on\-disk format versions are specified via "features" which replace
 the old on\-disk format numbers (the last supported on\-disk format number is
 28). To enable a feature on a pool use the \fBupgrade\fR subcommand of the
-\fBzpool\fR(8) command, or set the \fBfeature@\fR\fIfeature_name\fR property
+zpool(8) command, or set the \fBfeature@\fR\fIfeature_name\fR property
 to \fBenabled\fR.
 .sp
 .LP
@@ -103,7 +103,7 @@ Some features may make on\-disk format changes that do not interfere with other
 software's ability to read from the pool. These features are referred to as
 "read\-only compatible". If all unsupported features on a pool are read\-only
 compatible, the pool can be imported in read\-only mode by setting the
-\fBreadonly\fR property during import (see \fBzpool\fR(8) for details on
+\fBreadonly\fR property during import (see zpool(8) for details on
 importing pools).
 .SS "Unsupported features"
 .sp
@@ -243,9 +243,9 @@ giving approximately 10% better compression ratio.
 
 When the \fBlz4_compress\fR feature is set to \fBenabled\fR, the
 administrator can turn on \fBlz4\fR compression on any dataset on the
-pool using the \fBzfs\fR(8) command. Please note that doing so will
+pool using the zfs(8) command. Please note that doing so will
 immediately activate the \fBlz4_compress\fR feature on the underlying
-pool using the \fBzfs\fR(1M) command. Also, all newly written metadata
+pool using the zfs(8) command. Also, all newly written metadata
 will be compressed with \fBlz4\fR algorithm. Since this feature is not
 read-only compatible, this operation will render the pool unimportable
 on systems without support for the \fBlz4_compress\fR feature.
@@ -383,7 +383,7 @@ READ\-ONLY COMPATIBLE       no
 DEPENDENCIES   enabled_txg
 .TE
 
-This feature improves performance of incremental sends ("zfs send -i")
+This feature improves performance of incremental sends (\fBzfs send -i\fR)
 and receives for objects with many holes. The most common case of
 hole-filled objects is zvols.
 
@@ -452,10 +452,10 @@ READ\-ONLY COMPATIBLE     no
 DEPENDENCIES   none
 .TE
 
-This feature enables the "zpool remove" subcommand to remove top-level
+This feature enables the \fBzpool remove\fR subcommand to remove top-level
 vdevs, evacuating them to reduce the total size of the pool.
 
-This feature becomes \fBactive\fR when the "zpool remove" command is used
+This feature becomes \fBactive\fR when the \fBzpool remove\fR subcommand is used
 on a top-level vdev, and will never return to being \fBenabled\fR.
 
 .RE
@@ -477,7 +477,7 @@ reduce the memory used to track removed devices.  When indirect blocks
 are freed or remapped, we note that their part of the indirect mapping
 is "obsolete", i.e. no longer needed.
 
-This feature becomes \fBactive\fR when the "zpool remove" command is
+This feature becomes \fBactive\fR when the \fBzpool remove\fR subcommand is
 used on a top-level vdev, and will never return to being \fBenabled\fR.
 
 .RE
@@ -494,11 +494,11 @@ READ\-ONLY COMPATIBLE     yes
 DEPENDENCIES   none
 .TE
 
-This feature enables the "zpool checkpoint" subcommand that can
+This feature enables the \fBzpool checkpoint\fR subcommand that can
 checkpoint the state of the pool at the time it was issued and later
 rewind back to it or discard it.
 
-This feature becomes \fBactive\fR when the "zpool checkpoint" command
+This feature becomes \fBactive\fR when the \fBzpool checkpoint\fR subcommand
 is used to checkpoint the pool.
 The feature will only return back to being \fBenabled\fR when the pool
 is rewound or the checkpoint has been discarded.
@@ -592,8 +592,8 @@ cannot for whatever reason utilize the faster \fBskein\fR and
 \fBedonr\fR algorithms.
 
 When the \fBsha512\fR feature is set to \fBenabled\fR, the administrator
-can turn on the \fBsha512\fR checksum on any dataset using the
-\fBzfs set checksum=sha512\fR(1M) command.  This feature becomes
+can turn on the \fBsha512\fR checksum on any dataset using
+\fBzfs set checksum=sha512\fR. See zfs(8). This feature becomes
 \fBactive\fR once a \fBchecksum\fR property has been set to \fBsha512\fR,
 and will return to being \fBenabled\fR once all filesystems that have
 ever had their checksum set to \fBsha512\fR are destroyed.
@@ -626,8 +626,8 @@ block to be checksummed. Thus the produced checksums are unique to a
 given pool, preventing hash collision attacks on systems with dedup.
 
 When the \fBskein\fR feature is set to \fBenabled\fR, the administrator
-can turn on the \fBskein\fR checksum on any dataset using the
-\fBzfs set checksum=skein\fR(1M) command.  This feature becomes
+can turn on the \fBskein\fR checksum on any dataset using
+\fBzfs set checksum=skein\fR. See zfs(8). This feature becomes
 \fBactive\fR once a \fBchecksum\fR property has been set to \fBskein\fR,
 and will return to being \fBenabled\fR once all filesystems that have
 ever had their checksum set to \fBskein\fR are destroyed.
@@ -667,7 +667,7 @@ pool.
 
 When the \fBedonr\fR feature is set to \fBenabled\fR, the administrator
 can turn on the \fBedonr\fR checksum on any dataset using the
-\fBzfs set checksum=edonr\fR(1M) command.  This feature becomes
+\fBzfs set checksum=edonr\fR. See zfs(8). This feature becomes
 \fBactive\fR once a \fBchecksum\fR property has been set to \fBedonr\fR,
 and will return to being \fBenabled\fR once all filesystems that have
 ever had their checksum set to \fBedonr\fR are destroyed.
@@ -815,11 +815,11 @@ DEPENDENCIES      none
 This feature enables support for separate allocation classes.
 
 This feature becomes \fBactive\fR when a dedicated allocation class vdev
-(dedup or special) is created with zpool create or zpool add. With device
-removal, it can be returned to the \fBenabled\fR state if all the top-level
-vdevs from an allocation class are removed.
+(dedup or special) is created with the \fBzpool create\fR or \fBzpool add\fR
+subcommands. With device removal, it can be returned to the \fBenabled\fR
+state if all the dedicated allocation class vdevs are removed.
 
 .RE
 
 .SH "SEE ALSO"
-\fBzpool\fR(8)
+zpool(8)