cli: workspace update-stale: set description on recovery commit #4738
Conversation
The recover commit we create in some cases (when an operation has been lost) doesn't currently have a description. That makes it easy to miss that it's special.
martinvonz
force-pushed
the
push-pukplruotqxy
branch
from
539df7f
to
d308020
Compare
There was a problem hiding this comment.
Thank you!
I think I see many of these commits, and I didn't know what they are about. Now I know, and I will know which commits this applies to.
If all the commits I think are related to this actually are caused by this, this seems to happen more often than I'd expect with concurrency. I'm not sure why so many operations would fail to be recorded.
| @@ -125,6 +125,16 @@ fn create_and_check_out_recovery_commit( | |||
| vec![commit_id.clone()], | |||
| commit.tree_id().clone(), | |||
| ) | |||
| .set_description( | |||
| "recovery commit from `jj workspace update-stale` | |||
There was a problem hiding this comment.
(Optional)
The first line is a bit inconspicuous and doesn't make it clear that the commit is machine-generated. Perhaps add JJ AUTO-RECOVERY: before it? Then, people will know that something strange happened, and what to search for and ask about.
We could also try it as is and see how many of these commits get generated and how in conspicuous they are.
BTW, I'm not sure everyone agrees, but I generally like the idea of having jj use JJ SOMETHING: as a marker for some text that is special to jj, extending the JJ: syntax we use in description editor (I don't mean to do this religiously, but it makes sense to me here).
There was a problem hiding this comment.
I don't have a strong feeling, but it would be nice if the description looked unusual. User might push the recovery commit by mistake if it looked like a normal commit.
There was a problem hiding this comment.
Maybe we should prefix it with JJ: and use that private commits feature to ensure that commits starting with JJ: don’t get pushed by default.
| @@ -125,6 +125,16 @@ fn create_and_check_out_recovery_commit( | |||
| vec![commit_id.clone()], | |||
| commit.tree_id().clone(), | |||
| ) | |||
| .set_description( | |||
| "recovery commit from `jj workspace update-stale` | |||
There was a problem hiding this comment.
I don't have a strong feeling, but it would be nice if the description looked unusual. User might push the recovery commit by mistake if it looked like a normal commit.
Checklist
If applicable:
CHANGELOG.md