c/mirror_zfs
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_zfs.git synced 2026-01-25 10:12:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

man: describe zfs-rewrite method and properties

Browse Source 
We've heard anecdotes that suggest some
confusion/surprise/disappointment that a changed recordsize is not
applied during rewrite. Until such time as we actually can do that, we
can at least explicitly mention it at something that doesn't work.

Sponsored-by: Klara, Inc.
Sponsored-by: Wasabi Technology, Inc.
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Alexander Motin <alexander.motin@TrueNAS.com>
Reviewed-by: Allan Jude <allan@klarasystems.com>
Signed-off-by: Rob Norris <rob.norris@klarasystems.com>
Closes #17898
This commit is contained in:
Rob Norris 2025-11-08 01:01:59 +11:00 committed by Brian Behlendorf
parent 055e908d47
commit 7b121388fb
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
man/man8/zfs-rewrite.8
View File

@ -20,8 +20,9 @@
.\" CDDL HEADER END .\" CDDL HEADER END
.\" .\"
.\" Copyright (c) 2025 iXsystems, Inc. .\" Copyright (c) 2025 iXsystems, Inc.
.\" Copyright (c) 2025, Klara, Inc.
.\" .\"
.Dd July 23, 2025 .Dd November 5, 2025
.Dt ZFS-REWRITE 8 .Dt ZFS-REWRITE 8
.Os .Os
. .
@ -39,9 +40,10 @@
.Sh DESCRIPTION .Sh DESCRIPTION
Rewrite blocks of specified Rewrite blocks of specified
.Ar file .Ar file
as is without modification at a new location and possibly with new as is without modification at a new location and possibly with new properties,
properties, such as checksum, compression, dedup, copies, etc,
as if they were atomically read and written back. as if they were atomically read and written back.
.No See Sx NOTES .
for more information about property changes that may be applied during rewrite.
.Bl -tag -width "-r" .Bl -tag -width "-r"
.It Fl P .It Fl P
Perform physical rewrite, preserving logical birth time of blocks. Perform physical rewrite, preserving logical birth time of blocks.
@ -64,6 +66,20 @@ Print names of all successfully rewritten files.
Don't cross file system mount points when recursing. Don't cross file system mount points when recursing.
.El .El
.Sh NOTES .Sh NOTES
Rewrite works by replacing an existing block with a new block of the same
logical size.
Changed dataset properties that operate on the data or metadata without
changing the logical size will be applied.
These include
.Sy checksum ,
.Sy compression ,
.Sy dedup
and
.Sy copies .
Changes to properties that affect the size of a logical block, like
.Sy recordsize ,
will have no effect.
.Pp
Rewrite of cloned blocks and blocks that are part of any snapshots, Rewrite of cloned blocks and blocks that are part of any snapshots,
same as some property changes may increase pool space usage. same as some property changes may increase pool space usage.
Holes that were never written or were previously zero-compressed are Holes that were never written or were previously zero-compressed are