CAP: Add examples of how to generate and apply diffs of xdr files #935
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Add examples of how to generate and apply diffs in XDR files in CAPs.
Why
Generating a diff is relatively self-explanatory and simple, but it is worth calling out to people we expect them to just use a git diff and not to generate an entire patch containing commits.
Applying a diff is relatively painful, especially for diffs that have been pasted into markdown files. Diffs in markdown files will almost always have whitespace inconsistencies that will cause the naked git apply command to error. It is capable of overlooking or fixing most whitespace errors and for folks who are unfamiliar with git apply the reject command is more useful because if there are conflicts it will leave the local space in a state that can be manually repaired.
This might be too prescriptive for folks who have their own workflows, but anyone who has their own workflow that differs from this basic workflow probably doesn't need to reference these commands, as long as the diffs they generate can be applied in this manner.