Skip to content

Update man docs to clarify behaviour when sending compressed sends and receiving with overridden compression #11690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 7, 2021

Conversation

manfromafar
Copy link
Contributor

Motivation and Context

Docs for send and receive do not explain behaviour 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.

In the future it might be nicer if the override on compression actually did decompress then recompress the data before writing it to disk

Description

Updated man docs to clarify behaviour

How Has This Been Tested?

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Library ABI change (libzfs, libzfs_core, libnvpair, libuutil and libzfsbootenv)
  • Documentation (a change to man pages or other documentation)

Checklist:

Add information to -c flag to specify that if set you cannot override the compression on the recv side with -o compress even though the dataset shows the correct compression being set.
Added documentation for interaction with streams sent with -c not having data recompressed on the receive side only having the compress property set
Carify -c will not recompress data on recv with -o compress

Signed-off-by: manfromafar <[email protected]>
@behlendorf behlendorf added Status: Code Review Needed Ready for review and testing Type: Documentation Indicates a requested change to the documentation labels Mar 5, 2021
@behlendorf behlendorf added Status: Accepted Ready to integrate (reviewed, tested) and removed Status: Code Review Needed Ready for review and testing labels Mar 5, 2021
@behlendorf
Copy link
Contributor

cc: @allanjude

Copy link
Contributor

@allanjude allanjude left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed By: Allan Jude [email protected]

@behlendorf behlendorf merged commit ecc277c into openzfs:master Mar 7, 2021
behlendorf pushed a commit that referenced this pull request Mar 8, 2021
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 <[email protected]>
Reviewed By: Allan Jude <[email protected]>
Signed-off-by: manfromafar <[email protected]>
Closes #11690
jsai20 pushed a commit to jsai20/zfs that referenced this pull request Mar 30, 2021
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 <[email protected]>
Reviewed By: Allan Jude <[email protected]>
Signed-off-by: manfromafar <[email protected]>
Closes openzfs#11690
adamdmoss pushed a commit to adamdmoss/zfs that referenced this pull request Apr 10, 2021
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 <[email protected]>
Reviewed By: Allan Jude <[email protected]>
Signed-off-by: manfromafar <[email protected]>
Closes openzfs#11690
sempervictus pushed a commit to sempervictus/zfs that referenced this pull request May 31, 2021
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 <[email protected]>
Reviewed By: Allan Jude <[email protected]>
Signed-off-by: manfromafar <[email protected]>
Closes openzfs#11690
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Accepted Ready to integrate (reviewed, tested) Type: Documentation Indicates a requested change to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants