grit: fix sort order of newly-created trees with sub-trees #186
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
Git has odd sorting requirements for tree entries. The
entries are sorted by name, but sub-trees sort as if they
had "/" at the end. That means when you add full paths to
the index like this:
index.add("foo.bar", "content")
index.add("foo/file", "content")
index.write_tree()
the resulting tree ends up sorted correctly (`foo` must come
after `foo.bar`, because `/` comes after `.`). But if you
provide individual sha1s, like this:
index.add("foo.bar", "content")
index.add("foo", [some_tree_sha1, "40000"])
index.write_tree()
we end up sorting the entries in the wrong order. Git
complains (and may provide incorrect answers for diffs,
since we rely on the sort order there).
The fix is fairly straightforward; we already take special
care to use a separate sorting key that includes the "/",
but we missed the case of a sub-tree being named explicitly
by its sha1.
Signed-off-by: Jeff King <[email protected]>
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.
Git has odd sorting requirements for tree entries. The entries are sorted by name, but sub-trees sort as if they had "/" at the end. That means when you add full paths to the index like this:
the resulting tree ends up sorted correctly (
foomust come afterfoo.bar, because/comes after.). But if you provide individual sha1s, like this:we end up sorting the entries in the wrong order. Git complains (and may provide incorrect answers for diffs, since we rely on the sort order there).
The fix is fairly straightforward; we already take special care to use a separate sorting key that includes the "/", but we missed the case of a sub-tree being named explicitly by its sha1.
I know Grit is in "deprecated mode", but this is a real bug that can cause corrupt objects to be created. It's probably worth including.