Clarify the non-incremental nature of tree objects. #1401
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
ben
reviewed
Mar 25, 2020
Comment on lines
+347
to
+350
| To be clear clear, the tree object built for a commit references *all* of the files and directories visible at the commit | ||
| It does not only reference the content altered from the parent commit. | ||
| If the tree object for a commit fails to include a file that was present in its parent commit, that absence is interpreted as deletion of the file. | ||
|
|
There was a problem hiding this comment.
Oh yeah, I like the intent here, there's definitely information that was left unspecified.
Let's reword a bit. How about this?
Suggested change
| To be clear clear, the tree object built for a commit references *all* of the files and directories visible at the commit | |
| It does not only reference the content altered from the parent commit. | |
| If the tree object for a commit fails to include a file that was present in its parent commit, that absence is interpreted as deletion of the file. | |
| To be clear, a commit's tree structure represents the complete contents of the working directory at that moment in time. | |
| If the parent commit's tree includes a file that is not present in this commit's tree, that absence is interpreted as deletion of the file. | |
What do you think?
There was a problem hiding this comment.
Suggested change
| To be clear clear, the tree object built for a commit references *all* of the files and directories visible at the commit | |
| It does not only reference the content altered from the parent commit. | |
| If the tree object for a commit fails to include a file that was present in its parent commit, that absence is interpreted as deletion of the file. | |
| To be clear, a commit's tree structure represents the complete contents of the staging area at that moment in time. | |
| If the parent commit's tree includes a file that is not present in this commit's tree, that absence is interpreted as deletion of the file. | |
I thought a commit is a snapshot of the staging area (as opposed to the working directory). Please correct me if I'm wrong.
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.
The one confirming detail left out of the exposition.