]> git.proxmox.com Git - mirror_zfs.git/commitdiff
Clarify compressed zfs send/recv behavior
authormanfromafar <jonsonb10@gmail.com>
Sun, 7 Mar 2021 17:39:16 +0000 (10:39 -0700)
committerGitHub <noreply@github.com>
Sun, 7 Mar 2021 17:39:16 +0000 (09:39 -0800)
Docs for send and receive do not explain behavior when sending a
compressed stream then receiving on a host that overrides compression
with -o compress=value.

The data from the send stream is written as it was from the send is
the compressed form but the compression algorithm set on the receiver
is the overridden version which causes some confusion as to what
algorithm was actually used.

Updated man docs to clarify behavior

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed By: Allan Jude <allanjude@freebsd.org>
Signed-off-by: manfromafar <manfromafar@outlook.com>
Closes #11690

man/man8/zfs-receive.8
man/man8/zfs-send.8

index ed5cbbdf0b792abaa474f433c469f58e9d184d2c..982e3b9616fcc7fddf3e99808a80868afae8973a 100644 (file)
@@ -261,6 +261,16 @@ causes the property to be inherited by all descendant datasets, as through
 was run on any descendant datasets that have this property set on the
 sending system.
 .Pp
+If the send stream was sent with 
+.Fl c
+then overriding the 
+.Sy compression 
+property will have no affect on received data but the  
+.Sy compression
+property will be set. To have the data recompressed on receive remove the 
+.Fl c 
+flag from the send stream.  
+.Pp
 Any editable property can be set at receive time. Set-once properties bound
 to the received data, such as
 .Sy normalization
index 1a241a52d54b63329639a0d4bd1032415930e206..91c1484c73f6c94de7dfd8309b35365a30a0a334 100644 (file)
@@ -189,7 +189,12 @@ feature is enabled on the sending system but the
 option is not supplied in conjunction with
 .Fl c ,
 then the data will be decompressed before sending so it can be split into
-smaller block sizes.
+smaller block sizes. Streams sent with 
+.Fl c
+will not have their data recompressed on the receiver side using
+.Fl o compress=value.
+The data will stay compressed as it was from the sender. The new compression
+property will be set for future data. 
 .It Fl w, -raw
 For encrypted datasets, send data exactly as it exists on disk. This allows
 backups to be taken even if encryption keys are not currently loaded. The