Skip to content

Commit 876f705

Browse files
authored
Use "vdev" instead of "devices" when referring to vdevs
Update documentation to use the correct terminology. Reviewed-by: Brian Behlendorf <[email protected]> Reviewed-by: Tony Hutter <[email protected]> Signed-off-by: trick2011 <[email protected]> Closes #17734 Closes #17755
1 parent 1178796 commit 876f705

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

cmd/zpool/zpool_main.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ get_usage(zpool_help_t idx)
456456
"<pool> <vdev> ...\n"));
457457
case HELP_ATTACH:
458458
return (gettext("\tattach [-fsw] [-o property=value] "
459-
"<pool> <device> <new-device>\n"));
459+
"<pool> <vdev> <new-device>\n"));
460460
case HELP_CLEAR:
461461
return (gettext("\tclear [[--power]|[-nF]] <pool> [device]\n"));
462462
case HELP_CREATE:
@@ -7644,17 +7644,17 @@ zpool_do_replace(int argc, char **argv)
76447644
}
76457645

76467646
/*
7647-
* zpool attach [-fsw] [-o property=value] <pool> <device>|<vdev> <new_device>
7647+
* zpool attach [-fsw] [-o property=value] <pool> <vdev> <new_device>
76487648
*
76497649
* -f Force attach, even if <new_device> appears to be in use.
76507650
* -s Use sequential instead of healing reconstruction for resilver.
76517651
* -o Set property=value.
76527652
* -w Wait for resilvering (mirror) or expansion (raidz) to complete
76537653
* before returning.
76547654
*
7655-
* Attach <new_device> to a <device> or <vdev>, where the vdev can be of type
7656-
* mirror or raidz. If <device> is not part of a mirror, then <device> will
7657-
* be transformed into a mirror of <device> and <new_device>. When a mirror
7655+
* Attach <new_device> to a <vdev>, where the vdev can be of type
7656+
* device, mirror or raidz. If <vdev> is not part of a mirror, then <vdev> will
7657+
* be transformed into a mirror of <vdev> and <new_device>. When a mirror
76587658
* is involved, <new_device> will begin life with a DTL of [0, now], and will
76597659
* immediately begin to resilver itself. For the raidz case, a expansion will
76607660
* commence and reflow the raidz data across all the disks including the

man/man8/zpool-attach.8

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,40 +39,40 @@
3939
.Cm attach
4040
.Op Fl fsw
4141
.Oo Fl o Ar property Ns = Ns Ar value Oc
42-
.Ar pool device new_device
42+
.Ar pool vdev new_device
4343
.
4444
.Sh DESCRIPTION
4545
Attaches
4646
.Ar new_device
4747
to the existing
48-
.Ar device .
48+
.Ar vdev .
4949
The behavior differs depending on if the existing
50-
.Ar device
50+
.Ar vdev
5151
is a RAID-Z device, or a mirror/plain device.
5252
.Pp
53-
If the existing device is a mirror or plain device
53+
If the existing vdev is a mirror or plain device
5454
.Pq e.g. specified as Qo Li sda Qc or Qq Li mirror-7 ,
55-
the new device will be mirrored with the existing device, a resilver will be
55+
the new device will be mirrored with the existing vdev, a resilver will be
5656
initiated, and the new device will contribute to additional redundancy once the
5757
resilver completes.
5858
If
59-
.Ar device
59+
.Ar vdev
6060
is not currently part of a mirrored configuration,
6161
.Ar device
6262
automatically transforms into a two-way mirror of
6363
.Ar device
6464
and
6565
.Ar new_device .
6666
If
67-
.Ar device
67+
.Ar vdev
6868
is part of a two-way mirror, attaching
6969
.Ar new_device
7070
creates a three-way mirror, and so on.
7171
In either case,
7272
.Ar new_device
7373
begins to resilver immediately and any running scrub is canceled.
7474
.Pp
75-
If the existing device is a RAID-Z device
75+
If the existing vdev is a RAID-Z device
7676
.Pq e.g. specified as Qq Ar raidz2-0 ,
7777
the new device will become part of that RAID-Z group.
7878
A "raidz expansion" will be initiated, and once the expansion completes,
@@ -112,7 +112,7 @@ the checksums of all blocks which have been copied during the expansion.
112112
Forces use of
113113
.Ar new_device ,
114114
even if it appears to be in use.
115-
Not all devices can be overridden in this manner.
115+
Not all vdevs can be overridden in this manner.
116116
.It Fl o Ar property Ns = Ns Ar value
117117
Sets the given pool properties.
118118
See the
@@ -121,7 +121,7 @@ manual page for a list of valid properties that can be set.
121121
The only property supported at the moment is
122122
.Sy ashift .
123123
.It Fl s
124-
When attaching to a mirror or plain device, the
124+
When attaching to a mirror or plain vdev, the
125125
.Ar new_device
126126
is reconstructed sequentially to restore redundancy as quickly as possible.
127127
Checksums are not verified during sequential reconstruction so a scrub is

0 commit comments

Comments
 (0)