Skip to content

Commit

Permalink
describe: warn user that describing multiple commits is experimental
Browse files Browse the repository at this point in the history
I think it might be nice to have this in the upcoming release, but I'd
like to warn people that their changes will be lost if they aren't
careful, and to not rely on the syntax being fixed just yet.
  • Loading branch information
ilyagr committed Aug 4, 2024
1 parent 38478bc commit 672c713
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

* Added revset functions `author_date` and `committer_date`.

* `jj describe` can now update the description of multiple commits.
* `jj describe` can now update the description of multiple commits (experimental).

### Fixed bugs

Expand Down
9 changes: 7 additions & 2 deletions cli/src/description_util.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,13 @@ pub fn edit_multiple_descriptions(
let mut bulk_message = String::new();

bulk_message.push_str(indoc! {r#"
JJ: Enter or edit commit descriptions after the `JJ: describe` lines.
JJ: Enter or edit commit descriptions after the `JJ: describe` lines.
JJ: Warning: Describing multiple commits at once is currently
JJ: **experimental**.
JJ: - The text you enter will be lost on a syntax error.
JJ: - The syntax may change in the future.
"#});
for (commit_id, temp_commit) in commits.iter() {
let commit_hash = short_commit_hash(commit_id);
Expand Down
12 changes: 12 additions & 0 deletions cli/tests/test_describe_command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,11 @@ fn test_describe_multiple_commits() {
std::fs::read_to_string(test_env.env_root().join("editor0")).unwrap(), @r###"
JJ: Enter or edit commit descriptions after the `JJ: describe` lines.
JJ: Warning: Describing multiple commits at once is currently
JJ: **experimental**.
JJ: - The text you enter will be lost on a syntax error.
JJ: - The syntax may change in the future.
JJ: describe 8d650510daad -------
JJ: describe 41659b846096 -------
Expand All @@ -238,6 +243,13 @@ fn test_describe_multiple_commits() {
&edit_script,
indoc! {"
write
JJ: Enter or edit commit descriptions after the `JJ: describe` lines.
JJ: Warning: Describing multiple commits at once is currently
JJ: **experimental**.
JJ: - The text you enter will be lost on a syntax error.
JJ: - The syntax may change in the future.
JJ: describe 8d650510daad -------
description from editor of @-
Expand Down

0 comments on commit 672c713

Please sign in to comment.