Skip to content

Commit e08e832

Browse files
authored
Expand zpool-remove.8 manpage with example results
Also fix comment cross-referencing to zpool.8. Reviewed-by: Brian Behlendorf <[email protected]> Reviewed-by: Alexander Motin <[email protected]> Signed-off-by: Steve Mokris <[email protected]> Closes #16777
1 parent 0d6306b commit e08e832

File tree

2 files changed

+69
-1
lines changed

2 files changed

+69
-1
lines changed

man/man8/zpool-remove.8

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Stops and cancels an in-progress removal of a top-level vdev.
109109
.El
110110
.
111111
.Sh EXAMPLES
112-
.\" These are, respectively, examples 14 from zpool.8
112+
.\" These are, respectively, examples 15 from zpool.8
113113
.\" Make sure to update them bidirectionally
114114
.Ss Example 1 : No Removing a Mirrored top-level (Log or Data) Device
115115
The following commands remove the mirrored log device
@@ -142,9 +142,43 @@ The command to remove the mirrored log
142142
.Ar mirror-2 No is :
143143
.Dl # Nm zpool Cm remove Ar tank mirror-2
144144
.Pp
145+
At this point, the log device no longer exists
146+
(both sides of the mirror have been removed):
147+
.Bd -literal -compact -offset Ds
148+
pool: tank
149+
state: ONLINE
150+
scan: none requested
151+
config:
152+
153+
NAME STATE READ WRITE CKSUM
154+
tank ONLINE 0 0 0
155+
mirror-0 ONLINE 0 0 0
156+
sda ONLINE 0 0 0
157+
sdb ONLINE 0 0 0
158+
mirror-1 ONLINE 0 0 0
159+
sdc ONLINE 0 0 0
160+
sdd ONLINE 0 0 0
161+
.Ed
162+
.Pp
145163
The command to remove the mirrored data
146164
.Ar mirror-1 No is :
147165
.Dl # Nm zpool Cm remove Ar tank mirror-1
166+
.Pp
167+
After
168+
.Ar mirror-1 No has been evacuated, the pool remains redundant, but
169+
the total amount of space is reduced:
170+
.Bd -literal -compact -offset Ds
171+
pool: tank
172+
state: ONLINE
173+
scan: none requested
174+
config:
175+
176+
NAME STATE READ WRITE CKSUM
177+
tank ONLINE 0 0 0
178+
mirror-0 ONLINE 0 0 0
179+
sda ONLINE 0 0 0
180+
sdb ONLINE 0 0 0
181+
.Ed
148182
.
149183
.Sh SEE ALSO
150184
.Xr zpool-add 8 ,

man/man8/zpool.8

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,9 +405,43 @@ The command to remove the mirrored log
405405
.Ar mirror-2 No is :
406406
.Dl # Nm zpool Cm remove Ar tank mirror-2
407407
.Pp
408+
At this point, the log device no longer exists
409+
(both sides of the mirror have been removed):
410+
.Bd -literal -compact -offset Ds
411+
pool: tank
412+
state: ONLINE
413+
scan: none requested
414+
config:
415+
416+
NAME STATE READ WRITE CKSUM
417+
tank ONLINE 0 0 0
418+
mirror-0 ONLINE 0 0 0
419+
sda ONLINE 0 0 0
420+
sdb ONLINE 0 0 0
421+
mirror-1 ONLINE 0 0 0
422+
sdc ONLINE 0 0 0
423+
sdd ONLINE 0 0 0
424+
.Ed
425+
.Pp
408426
The command to remove the mirrored data
409427
.Ar mirror-1 No is :
410428
.Dl # Nm zpool Cm remove Ar tank mirror-1
429+
.Pp
430+
After
431+
.Ar mirror-1 No has been evacuated, the pool remains redundant, but
432+
the total amount of space is reduced:
433+
.Bd -literal -compact -offset Ds
434+
pool: tank
435+
state: ONLINE
436+
scan: none requested
437+
config:
438+
439+
NAME STATE READ WRITE CKSUM
440+
tank ONLINE 0 0 0
441+
mirror-0 ONLINE 0 0 0
442+
sda ONLINE 0 0 0
443+
sdb ONLINE 0 0 0
444+
.Ed
411445
.
412446
.Ss Example 16 : No Displaying expanded space on a device
413447
The following command displays the detailed information for the pool

0 commit comments

Comments
 (0)