Document how jj and git interpret DiffSpec - #28
Open
Techcable wants to merge 2 commits into
Open
Conversation
Rev(rev) is a direct passthrough to git's single positional diff argument — not something this crate parses or classifies. The working-copy-inclusion behavior for a lone revision is a consequence of that passthrough. It always diffs against the working tree, not the revision against its parent. Document this on GitApi::diff_text and in the git.md guide. Note that this DiffSpec interpretation is stable, and changing it would be semver-breaking change. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Rev is passed straight through to jj diff -r, so it diffs the revset against its parent(s), not the working copy — unlike vcs_git's Rev, which always includes working-copy changes for a single revision. Note that this DiffSpec interpretation is stable, semver-guarded behavior. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Techcable
changed the title
This file contains hidden or 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
1 participant
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 & why
Document how git and jj each interpret a
DiffSpecpassed todiff_textand friends.Guarantee that this interpretation is stable, and changing it would be a semver-breaking change.
Checklist
cargo fmt --allcargo clippy --workspace --all-targets --all-features -- -D warningsis cleancargo test --workspace --all-featurespasses (andcargo test -- --ignoredif youtouched a real-binary path)
CHANGELOG.md[Unreleased]is updated when the change isuser-facing (
Added/Changed/Fixed)docs/guide set) if behavior or API changedCargo.toml