d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove unnecesary "Ns" macros and add missing command example to zpool(8).

Browse Source 
Reported by:	Nobuyuki Koganemaru <kogane@FreeBSD.org>
MFC after:	3 days
This commit is contained in:
mm 2011-12-02 19:56:46 +00:00
parent 15257e476a
commit aad7cc1b2b
2 changed files with 67 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
cddl/contrib/opensolaris/cmd/zfs/zfs.8
View File

@ -2198,7 +2198,7 @@ Generate a stream package that sends all intermediary snapshots from the
.Ar snapshot . For example,
.Ic -I @a fs@d
is similar to
.Ic -i @a fs@b; -i @b fs@c; -i @c fs@d Ns .
.Ic -i @a fs@b; -i @b fs@c; -i @c fs@d .
The incremental source snapshot may be specified as with the
.Fl i
option.
@ -2414,7 +2414,7 @@ may be specified as a comma-separated list. Permission names are the same as
.Tn ZFS
subcommand and property names. See the property list below. Property set names,
which begin with an at sign
.Pq Sy @ Ns ,
.Pq Sy @ ,
may be specified. See the
.Fl s
form below for details.
@ -2536,7 +2536,7 @@ commands for the specified file system and its descendents. Sets are evaluated
dynamically, so changes to a set are immediately reflected. Permission sets
follow the same naming restrictions as ZFS file systems, but the name must
begin with an "at sign"
.Pq Sy @ Ns ,
.Pq Sy @ ,
and can be no more than 64 characters long.
.It Xo
.Nm

120
cddl/contrib/opensolaris/cmd/zpool/zpool.8
View File

@ -195,7 +195,7 @@ are supported:
.Bl -tag
.It Sy disk
A block device, typically located under
.Pa /dev Ns .
.Pa /dev .
.Tn ZFS
can use individual slices or partitions, though the recommended mode of
operation is to use whole disks. A disk can be specified by a full path to the
@ -221,13 +221,14 @@ bytes and can withstand
.Pq Em N-1
devices failing before data integrity is compromised.
.It Sy raidz
.No ( or Sy raidz1 raidz2 raidz3 Ns ).
(or
.Sy raidz1 raidz2 raidz3 ) .
A variation on
.Sy RAID-5
that allows for better distribution of parity and eliminates the
.Qq Sy RAID-5 No write hole
(in which data and parity become inconsistent after a power loss). Data and
parity is striped across all disks within a
.Qq Sy RAID-5
write hole (in which data and parity become inconsistent after a power loss).
Data and parity is striped across all disks within a
.No raidz
group.
.Pp
@ -251,7 +252,7 @@ type specifies a triple-parity
group. The
.Sy raidz No vdev
type is an alias for
.Sy raidz1 Ns .
.Sy raidz1 .
.Pp
A
.No raidz
@ -322,6 +323,9 @@ are used to distinguish where a group ends and another begins. For example, the
following creates two root
.No vdev Ns s,
each a mirror of two disks:
.Bd -literal -offset 2n
.Li # Ic zpool create mypool mirror da0 da1 mirror da2 da3
.Ed
.Ss Device Failure and Recovery
.Tn ZFS
supports a rich set of mechanisms for handling device failure and data
@ -421,7 +425,7 @@ hardware-dependent and might not be supported on all platforms.
.Ss Hot Spares
.Tn ZFS
allows devices to be associated with pools as
.Qq hot spares Ns .
.Qq hot spares .
These devices are not actively used in the pool, but when an active device
fails, it is automatically replaced by a hot spare. To create a pool with hot
spares, specify a
@ -537,12 +541,13 @@ Number of blocks within the pool that are not allocated.
A unique identifier for the pool.
.It Sy health
The current health of the pool. Health can be
.Qq Sy ONLINE Ns ,
.Qq Sy DEGRADED Ns ,
.Qq Sy FAULTED Ns ,
.Qq Sy OFFLINE Ns ,
.Qq Sy REMOVED Ns , or
.Qq Sy UNAVAIL Ns .
.Qq Sy ONLINE ,
.Qq Sy DEGRADED ,
.Qq Sy FAULTED ,
.Qq Sy OFFLINE ,
.Qq Sy REMOVED ,
or
.Qq Sy UNAVAIL .
.It Sy size
Total size of the storage pool.
.It Sy used
@ -577,7 +582,7 @@ is not a persistent property. It is valid only while the system is up.
Setting
.Sy altroot
defaults to using
.Cm cachefile=none Ns ,
.Cm cachefile=none ,
though this may be overridden using an explicit setting.
.El
.Pp
@ -585,7 +590,7 @@ The following property can only be set at import time:
.Bl -tag -width 2n
.It Sy readonly Ns = Ns Cm on No | Cm off
If set to
.Cm on Ns ,
.Cm on ,
pool will be imported in read-only mode with the following restrictions:
.Bl -bullet -offset 2n
.It
@ -606,7 +611,7 @@ command:
.Bl -tag -width 2n
.It Sy autoexpand Ns = Ns Cm on No | Cm off
Controls automatic pool expansion when the underlying LUN is grown. If set to
.Qq Cm on Ns ,
.Qq Cm on ,
the pool will be resized according to the size of the expanded
device. If the device is part of a mirror or
.No raidz
@ -614,20 +619,20 @@ then all devices within that
.No mirror/ Ns No raidz
group must be expanded before the new space is made available to
the pool. The default behavior is
.Qq off Ns .
.Qq off .
This property can also be referred to by its shortened column name,
.Sy expand Ns .
.Sy expand .
.It Sy autoreplace Ns = Ns Cm on No | Cm off
Controls automatic device replacement. If set to
.Qq Cm off Ns ,
.Qq Cm off ,
device replacement must be initiated by the administrator by using the
.Qq Nm Cm replace
command. If set to
.Qq Cm on Ns ,
.Qq Cm on ,
any new device, found in the same
physical location as a device that previously belonged to the pool, is
automatically formatted and replaced. The default behavior is
.Qq Cm off Ns .
.Qq Cm off .
This property can also be referred to by its shortened column name, "replace".
.It Sy bootfs Ns = Ns Ar pool Ns / Ns Ar dataset
Identifies the default bootable dataset for the root pool. This property is
@ -650,7 +655,7 @@ creates a temporary pool that is never cached, and the special value
Threshold for the number of block ditto copies. If the reference count for a
deduplicated block increases above this number, a new ditto copy of this block
is automatically stored. Deafult setting is
.Cm 0 Ns .
.Cm 0 .
.It Sy delegation Ns = Ns Cm on No | Cm off
Controls whether a non-privileged user is granted access based on the dataset
permissions defined on the dataset. See
@ -694,7 +699,7 @@ decreased. The preferred method of updating pools is with the
command, though this property can be used when a specific version is needed
for backwards compatibility. This property can be any number between 1 and the
current version reported by
.Qo Ic zpool upgrade -v Qc Ns .
.Qo Ic zpool upgrade -v Qc .
.El
.Sh SUBCOMMANDS
All subcommands that modify state are logged persistently to the pool in their
@ -731,7 +736,7 @@ subcommand.
.Bl -tag -width indent
.It Fl f
Forces use of
.Ar vdev Ns ,
.Ar vdev ,
even if they appear in use or specify a conflicting replication level.
Not all devices can be overridden in this manner.
.It Fl n
@ -762,7 +767,8 @@ configuration. If
is not currently part of a mirrored configuration,
.Ar device
automatically transforms into a two-way mirror of
.Ar device No and Ar new_device Ns . If
.Ar device No and Ar new_device .
If
.Ar device
is part of a two-way mirror, attaching
.Ar new_device
@ -772,7 +778,7 @@ begins to resilver immediately.
.Bl -tag -width indent
.It Fl f
Forces use of
.Ar new_device Ns ,
.Ar new_device ,
even if its appears to be in use. Not all devices can be overridden in this
manner.
.El
@ -846,7 +852,7 @@ is specified.
Unless the
.Fl R
option is specified, the default mount point is
.Qq Pa /pool Ns .
.Qq Pa /pool .
The mount point must not exist or must be empty, or else the
root dataset cannot be mounted. This can be overridden with the
.Fl m
@ -890,9 +896,11 @@ or
if
.Sy altroot
is specified. The mount point must be an absolute path,
.Qq Cm legacy Ns , or Qq Cm none Ns .
.Qq Cm legacy ,
or
.Qq Cm none .
For more information on dataset mount points, see
.Xr zfs 8 Ns \&.
.Xr zfs 8 .
.El
.It Xo
.Nm
@ -1000,7 +1008,7 @@ performed.
Lists pools available to import. If the
.Fl d
option is not specified, this command searches for devices in
.Qq Pa /dev Ns .
.Qq Pa /dev .
The
.Fl d
option can be specified multiple times, and all directories are searched. If
@ -1028,7 +1036,7 @@ pool property. This
is used instead of searching for devices.
.It Fl d Ar dir
Searches for devices or files in
.Ar dir Ns .
.Ar dir .
The
.Fl d
option can be specified multiple times.
@ -1078,7 +1086,7 @@ pool property. This
is used instead of searching for devices.
.It Fl d Ar dir
Searches for devices or files in
.Ar dir Ns .
.Ar dir .
The
.Fl d
option can be specified multiple times. This option is incompatible with the
@ -1141,7 +1149,7 @@ Imports a specific pool. A pool can be identified by its name or the numeric
identifier. If
.Ar newpool
is specified, the pool is imported using the name
.Ar newpool Ns .
.Ar newpool .
Otherwise, it is imported with the same name as its exported name.
.Pp
If a device is removed from a system without running
@ -1171,7 +1179,7 @@ pool property. This
is used instead of searching for devices.
.It Fl d Ar dir
Searches for devices or files in
.Ar dir Ns .
.Ar dir .
The
.Fl d
option can be specified multiple times. This option is incompatible with the
@ -1236,11 +1244,11 @@ Print a timestamp.
Use modifier
.Cm d
for standard date format. See
.Xr date 1 Ns .
.Xr date 1 .
Use modifier
.Cm u
for unixtime
.Pq equals Qq Ic date +%s Ns .
.Pq equals Qq Ic date +%s .
.It Fl v
Verbose statistics. Reports usage statistics for individual
.No vdev Ns s
@ -1256,7 +1264,7 @@ within the pool, in addition to the pool-wide statistics.
Removes
.Tn ZFS
label information from the specified
.Ar device Ns .
.Ar device .
The
.Ar device
must not be part of an active pool configuration.
@ -1295,24 +1303,24 @@ instead of arbitrary space.
Comma-separated list of properties to display. See the
.Qq Sx Properties
section for a list of valid properties. The default list is
.Sy name Ns ,
.Sy size Ns ,
.Sy used Ns ,
.Sy available Ns ,
.Sy capacity Ns ,
.Sy health Ns ,
.Sy altroot Ns .
.Sy name ,
.Sy size ,
.Sy used ,
.Sy available ,
.Sy capacity ,
.Sy health ,
.Sy altroot .
.It Fl T Cm d Ns | Ns Cm u
Print a timestamp.
.Pp
Use modifier
.Cm d
for standard date format. See
.Xr date 1 Ns .
.Xr date 1 .
Use modifier
.Cm u
for unixtime
.Pq equals Qq Ic date +%s Ns .
.Pq equals Qq Ic date +%s .
.El
.It Xo
.Nm
@ -1380,11 +1388,11 @@ devices cannot be removed from a pool.
Replaces
.Ar old_device
with
.Ar new_device Ns .
.Ar new_device .
This is equivalent to attaching
.Ar new_device Ns ,
.Ar new_device ,
waiting for it to resilver, and then detaching
.Ar old_device Ns .
.Ar old_device .
.Pp
The size of
.Ar new_device
@ -1397,7 +1405,7 @@ configuration.
is required if the pool is not redundant. If
.Ar new_device
is not specified, it defaults to
.Ar old_device Ns .
.Ar old_device .
This form of replacement is useful after an existing disk has failed and has
been physically replaced. In this case, the new disk may have the same
.Pa /dev
@ -1407,7 +1415,7 @@ recognizes this.
.Bl -tag -width indent
.It Fl f
Forces use of
.Ar new_device Ns ,
.Ar new_device ,
even if its appears to be in use. Not all devices can be overridden in this
manner.
.El
@ -1420,7 +1428,7 @@ manner.
.Pp
Begins a scrub. The scrub examines all data in the specified pools to verify
that it checksums correctly. For replicated (mirror or
.No raidz Ns )
.No raidz )
devices,
.Tn ZFS
automatically repairs any damage discovered during the scrub. The
@ -1565,11 +1573,11 @@ Print a timestamp.
Use modifier
.Cm d
for standard date format. See
.Xr date 1 Ns .
.Xr date 1 .
Use modifier
.Cm u
for unixtime
.Pq equals Qq Ic date +%s Ns .
.Pq equals Qq Ic date +%s .
.El
.It Xo
.Nm
@ -1649,7 +1657,7 @@ recommended, a pool based on files can be useful for experimental purposes.
.It Sy Example 5 No Adding a Mirror to a Tn ZFS No Storage Pool
.Pp
The following command adds two mirrored disks to the pool
.Em tank Ns ,
.Em tank ,
assuming the pool is already made up of two-way mirrors. The additional space
is immediately available to any datasets within the pool.
.Bd -literal -offset 2n
@ -1793,7 +1801,7 @@ subcommand as follows:
.It Sy Example 15 No Removing a Mirrored Log Device
.Pp
The following command removes the mirrored log device
.Em mirror-2 Ns .
.Em mirror-2 .
.Pp
Given this configuration:
.Bd -literal -offset 2n