RFC: commit_builder: add public interface that writes temporary commit to store #4127
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
yuja
commented
Jul 20, 2024
It's not wrong that String::clone_from() could potentially be cheaper.
I'm going to extract an inner builder that is free from &mut MutableRepo lifetime.
…commit I'll add another write() method that doesn't consume self, which will have to clone self.commit.
This allows us to construct a builder, format description template with an intermediate commit, then write() a final commit object to the repo. I originally considered removing mut_repo from CommitBuilder at all, but rewriter APIs rely on that CommitBuilder has &mut_repo, and splitting them would make call sites uglier. The inner builder methods are based on &mut Self instead of Self, because it's easier to wrap, and users of the inner builder will bind it to a named variable anyway.
…store In order to render description template, we'll need a Commit object that represents the old state (with new tree and parents) before updating the commit description. The added functions will help generate an intermediate Commit object. Alternatively, we can create an in-memory Commit object with some fake CommitId. It should be lightweight, but might cause weird issue because the fake id wouldn't be found in the store. I think it's okay to write a temporary commit and rely on GC as we do for merge trees. However, I should note that temporary commits are more likely to be preserved as they are pinned by no-gc refs until "jj util gc".
I think this makes it clear that the builder doesn't add any rewrite records to the mut_repo.
martinvonz
approved these changes
Jul 23, 2024
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.
Checklist
If applicable:
CHANGELOG.md