Skip to content

Commit 4339b4e

Browse files
authored
zpool-labelclear.8: Warn that it's destructive
If I could go back in time, I would beg Sun engineers to pick a different name. For those of us who have not read the ZFS On-Disk Specification pdf, it is not at all obvious that clearing a "label" is such a bad thing. But changing the name would be a breaking change, so at least for now we can update the documentation. Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Reviewed-by: Tony Hutter <hutter2@llnl.gov> Signed-off-by: Shelvacu <git@shelvacu.com> Closes #18347
1 parent 7fdd2bf commit 4339b4e

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

man/man8/zpool-labelclear.8

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,15 @@ is a cache device, it also removes the L2ARC header
5050
The
5151
.Ar device
5252
must not be part of an active pool configuration.
53+
.Pp
54+
This overwrites pool metadata, making all data on the
55+
.Ar device
56+
inaccessible without specialized recovery tools.
57+
Unlike
58+
.Nm zpool Cm destroy ,
59+
this cannot be undone by ZFS tooling.
60+
Only use this when you don't care about the data on the
61+
.Ar device .
5362
.Bl -tag -width Ds
5463
.It Fl f
5564
Treat exported or foreign devices as inactive.

man/man8/zpool.8

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,9 @@ specified.
108108
Destroys the given pool, freeing up any devices for other use.
109109
.It Xr zpool-labelclear 8
110110
Removes ZFS label information from the specified
111-
.Ar device .
111+
.Ar device ,
112+
making all data inaccessible without specialized recovery tools.
113+
Cannot be undone with ZFS tooling.
112114
.El
113115
.
114116
.Ss Virtual Devices

0 commit comments

Comments
 (0)