Skip to content
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

Clarify usage on rdiff(1) man page. #180

Merged
merged 2 commits into from Nov 25, 2019

Conversation

AaronM04
Copy link
Contributor

@AaronM04 AaronM04 commented Nov 17, 2019

No description provided.

AaronM04 and others added 2 commits Nov 17, 2019
Make the description more generalized and less application specific.
@dbaarda
Copy link
Member

@dbaarda dbaarda commented Nov 24, 2019

Is that clear enough for you, or do you want me to add a description of signature and delta files?

doc/rdiff.1 Outdated
\fBpatch\fP. To generate a \fIdelta-file\fP which can be used in combination
with \fIold-file\fP to re-generate \fInew-file\fP, use the \fBsignature\fP then
\fBdelta\fP subcommands. The \fIsignature-file\fP file can be discarded
afterward. To re-generate \fInew-file\fP, use the \fBpatch\fP
Copy link
Member

@dbaarda dbaarda Nov 24, 2019

Choose a reason for hiding this comment

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

I'm not sure how much this clarifies things, and feel like it could be better. The comment "The signature-file file can be discarded afterward" implies that the signature-file is not useful after a delta has been calculated, but there are use-cases where keeping it is useful (like calculating another delta-file for a different new-file later).

A signature-file is a small binary signature of the old-file that can be used to generate a delta-file against a new-file. It is small compared to the whole old-file, so it can be easily transferred and/or stored to calculate a delta-file remotely and/or later against a new-file without access to the original old-file.

A delta-file is a small binary diff file that can be applied to the old-file to update it to the new-file. The delta-files contain only the differences between the old-file and the new-file, so they are generally much smaller than the whole new-file, making them efficient to transfer and/or store to regenerate the new-file remotely and/or later by patching the old-file.

I'll have a crack at writing something better.

Copy link
Member

@dbaarda dbaarda Nov 25, 2019

Choose a reason for hiding this comment

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

As per AaronM04's reply my modified version of this seems OK, so I'm going to merge this now.

@dbaarda
Copy link
Member

@dbaarda dbaarda commented Nov 24, 2019

Sorry, I didn't realize my comment was stuck in a pending review until now, so I submitted it. Sorry for the confusion.

@AaronM04
Copy link
Contributor Author

@AaronM04 AaronM04 commented Nov 25, 2019

@dbaarda your update looks much clearer. Thanks!

Let me know if there's anything else I need to do.

@dbaarda dbaarda merged commit 6b0d1c6 into librsync:master Nov 25, 2019
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants