cli: rename obslog to evolution-log/evolog

It seems everyone agrees that `obslog` is not an intuitive name. There was some discussion about alternatives in #3592 and on #4146. The alternatives included `evolution`, `evolutionlog`, `evolog`, `rewritelog`, `revlog`, and `changelog`. It seemed like `evolution-log`/`evolog` was the most popular option. That also matches the command's current help text ("Show how a change has evolved over time").
jj-vcs · Aug 17, 2024 · ae5598e · ae5598e
1 parent 085e17e
commit ae5598e
Show file tree

Hide file tree

Showing 15 changed files with 86 additions and 86 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,9 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Deprecations
 
+* `jj obslog` is now called `jj evolution-log`/`jj evolog`. `jj obslog` remains
+  as an alias.
+
 ### New features
 
 * The following diff formats now include information about copies and moves:

diff --git a/cli/src/commands/obslog.rs → cli/src/commands/evolog.rs b/cli/src/commands/obslog.rs → cli/src/commands/evolog.rs
@@ -32,10 +32,8 @@ use crate::ui::Ui;
 ///
 /// Lists the previous commits which a change has pointed to. The current commit
 /// of a change evolves when the change is updated, rebased, etc.
-///
-/// Name is derived from Merciual's obsolescence markers.
 #[derive(clap::Args, Clone, Debug)]
-pub(crate) struct ObslogArgs {
+pub(crate) struct EvologArgs {
     #[arg(long, short, default_value = "@")]
     revision: RevisionArg,
     /// Limit number of revisions to show
@@ -69,10 +67,10 @@ pub(crate) struct ObslogArgs {
 }
 
 #[instrument(skip_all)]
-pub(crate) fn cmd_obslog(
+pub(crate) fn cmd_evolog(
     ui: &mut Ui,
     command: &CommandHelper,
-    args: &ObslogArgs,
+    args: &EvologArgs,
 ) -> Result<(), CommandError> {
     let workspace_command = command.workspace_helper(ui)?;
     let repo = workspace_command.repo().as_ref();

diff --git a/cli/src/commands/interdiff.rs b/cli/src/commands/interdiff.rs
@@ -27,7 +27,7 @@ use crate::ui::Ui;
 ///
 /// This excludes changes from other commits by temporarily rebasing `--from`
 /// onto `--to`'s parents. If you wish to compare the same change across
-/// versions, consider `jj obslog -p` instead.
+/// versions, consider `jj evolog -p` instead.
 #[derive(clap::Args, Clone, Debug)]
 #[command(group(ArgGroup::new("to_diff").args(&["from", "to"]).multiple(true).required(true)))]
 pub(crate) struct InterdiffArgs {

diff --git a/cli/src/commands/mod.rs b/cli/src/commands/mod.rs
@@ -26,6 +26,7 @@ mod diff;
 mod diffedit;
 mod duplicate;
 mod edit;
+mod evolog;
 mod file;
 mod fix;
 mod git;
@@ -36,7 +37,6 @@ mod merge;
 mod r#move;
 mod new;
 mod next;
-mod obslog;
 mod operation;
 mod parallelize;
 mod prev;
@@ -91,6 +91,8 @@ enum Command {
     Diffedit(diffedit::DiffeditArgs),
     Duplicate(duplicate::DuplicateArgs),
     Edit(edit::EditArgs),
+    #[command(alias = "obslog", visible_alias = "evolution-log")]
+    Evolog(evolog::EvologArgs),
     #[command(subcommand)]
     File(file::FileCommand),
     /// List files in a revision (DEPRECATED use `jj file list`)
@@ -117,7 +119,6 @@ enum Command {
     Move(r#move::MoveArgs),
     New(new::NewArgs),
     Next(next::NextArgs),
-    Obslog(obslog::ObslogArgs),
     #[command(subcommand)]
     #[command(visible_alias = "op")]
     Operation(operation::OperationCommand),
@@ -196,7 +197,7 @@ pub fn run_command(ui: &mut Ui, command_helper: &CommandHelper) -> Result<(), Co
         Command::Move(args) => r#move::cmd_move(ui, command_helper, args),
         Command::New(args) => new::cmd_new(ui, command_helper, args),
         Command::Next(args) => next::cmd_next(ui, command_helper, args),
-        Command::Obslog(args) => obslog::cmd_obslog(ui, command_helper, args),
+        Command::Evolog(args) => evolog::cmd_evolog(ui, command_helper, args),
         Command::Operation(args) => operation::cmd_operation(ui, command_helper, args),
         Command::Parallelize(args) => parallelize::cmd_parallelize(ui, command_helper, args),
         Command::Prev(args) => prev::cmd_prev(ui, command_helper, args),

diff --git a/cli/src/commit_templater.rs b/cli/src/commit_templater.rs
@@ -622,7 +622,7 @@ fn builtin_commit_methods<'repo>() -> CommitTemplateBuildMethodFnMap<'repo, Comm
             function.expect_no_arguments()?;
             let repo = language.repo;
             let out_property = self_property.map(|commit| {
-                // The given commit could be hidden in e.g. obslog.
+                // The given commit could be hidden in e.g. `jj evolog`.
                 let maybe_entries = repo.resolve_change_id(commit.change_id());
                 maybe_entries.map_or(0, |entries| entries.len()) > 1
             });

diff --git a/cli/tests/[email protected] b/cli/tests/[email protected]
@@ -35,6 +35,7 @@ This document contains the help content for the `jj` command-line program.
 * [`jj diffedit`↴](#jj-diffedit)
 * [`jj duplicate`↴](#jj-duplicate)
 * [`jj edit`↴](#jj-edit)
+* [`jj evolog`↴](#jj-evolog)
 * [`jj file`↴](#jj-file)
 * [`jj file chmod`↴](#jj-file-chmod)
 * [`jj file list`↴](#jj-file-list)
@@ -58,7 +59,6 @@ This document contains the help content for the `jj` command-line program.
 * [`jj log`↴](#jj-log)
 * [`jj new`↴](#jj-new)
 * [`jj next`↴](#jj-next)
-* [`jj obslog`↴](#jj-obslog)
 * [`jj operation`↴](#jj-operation)
 * [`jj operation abandon`↴](#jj-operation-abandon)
 * [`jj operation diff`↴](#jj-operation-diff)
@@ -120,6 +120,7 @@ To get started, see the tutorial at https://github.com/martinvonz/jj/blob/main/d
 * `diffedit` — Touch up the content changes in a revision with a diff editor
 * `duplicate` — Create a new change with the same content as an existing one
 * `edit` — Sets the specified revision as the working-copy revision
+* `evolog` — Show how a change has evolved over time
 * `file` — File operations
 * `fix` — Update files with formatting fixes or other changes
 * `git` — Commands for working with Git remotes and the underlying Git repo
@@ -128,7 +129,6 @@ To get started, see the tutorial at https://github.com/martinvonz/jj/blob/main/d
 * `log` — Show revision history
 * `new` — Create a new, empty change and (by default) edit it in the working copy
 * `next` — Move the working-copy commit to the child revision
-* `obslog` — Show how a change has evolved over time
 * `operation` — Commands for working with the operation log
 * `parallelize` — Parallelize revisions by making them siblings
 * `prev` — Change the working copy revision relative to the parent revision
@@ -693,6 +693,42 @@ For more information, see https://martinvonz.github.io/jj/latest/FAQ#how-do-i-re
 
 
 
+## `jj evolog`
+
+Show how a change has evolved over time
+
+Lists the previous commits which a change has pointed to. The current commit of a change evolves when the change is updated, rebased, etc.
+
+**Usage:** `jj evolog [OPTIONS]`
+
+###### **Options:**
+
+* `-r`, `--revision <REVISION>`
+
+  Default value: `@`
+* `-n`, `--limit <LIMIT>` — Limit number of revisions to show
+* `--no-graph` — Don't show the graph, show a flat list of revisions
+* `-T`, `--template <TEMPLATE>` — Render each revision using the given template
+
+   For the syntax, see https://github.com/martinvonz/jj/blob/main/docs/templates.md
+* `-p`, `--patch` — Show patch compared to the previous version of this change
+
+   If the previous version has different parents, it will be temporarily rebased to the parents of the new version, so the diff is not contaminated by unrelated changes.
+* `-s`, `--summary` — For each path, show only whether it was modified, added, or deleted
+* `--stat` — Show a histogram of the changes
+* `--types` — For each path, show only its type before and after
+
+   The diff is shown as two letters. The first letter indicates the type before and the second letter indicates the type after. '-' indicates that the path was not present, 'F' represents a regular file, `L' represents a symlink, 'C' represents a conflict, and 'G' represents a Git submodule.
+* `--name-only` — For each path, show only its path
+
+   Typically useful for shell commands like: `jj diff -r @- --name_only | xargs perl -pi -e's/OLD/NEW/g`
+* `--git` — Show a Git-format diff
+* `--color-words` — Show a word-level diff with changes indicated only by color
+* `--tool <TOOL>` — Generate diff by external command
+* `--context <CONTEXT>` — Number of lines of context to show
+
+
+
 ## `jj file`
 
 File operations
@@ -1087,7 +1123,7 @@ If the given directory does not exist, it will be created. If no directory is gi
 
 Compare the changes of two commits
 
-This excludes changes from other commits by temporarily rebasing `--from` onto `--to`'s parents. If you wish to compare the same change across versions, consider `jj obslog -p` instead.
+This excludes changes from other commits by temporarily rebasing `--from` onto `--to`'s parents. If you wish to compare the same change across versions, consider `jj evolog -p` instead.
 
 **Usage:** `jj interdiff [OPTIONS] <--from <FROM>|--to <TO>> [PATHS]...`
 
@@ -1230,44 +1266,6 @@ implied.
 
 
 
-## `jj obslog`
-
-Show how a change has evolved over time
-
-Lists the previous commits which a change has pointed to. The current commit of a change evolves when the change is updated, rebased, etc.
-
-Name is derived from Merciual's obsolescence markers.
-
-**Usage:** `jj obslog [OPTIONS]`
-
-###### **Options:**
-
-* `-r`, `--revision <REVISION>`
-
-  Default value: `@`
-* `-n`, `--limit <LIMIT>` — Limit number of revisions to show
-* `--no-graph` — Don't show the graph, show a flat list of revisions
-* `-T`, `--template <TEMPLATE>` — Render each revision using the given template
-
-   For the syntax, see https://github.com/martinvonz/jj/blob/main/docs/templates.md
-* `-p`, `--patch` — Show patch compared to the previous version of this change
-
-   If the previous version has different parents, it will be temporarily rebased to the parents of the new version, so the diff is not contaminated by unrelated changes.
-* `-s`, `--summary` — For each path, show only whether it was modified, added, or deleted
-* `--stat` — Show a histogram of the changes
-* `--types` — For each path, show only its type before and after
-
-   The diff is shown as two letters. The first letter indicates the type before and the second letter indicates the type after. '-' indicates that the path was not present, 'F' represents a regular file, `L' represents a symlink, 'C' represents a conflict, and 'G' represents a Git submodule.
-* `--name-only` — For each path, show only its path
-
-   Typically useful for shell commands like: `jj diff -r @- --name_only | xargs perl -pi -e's/OLD/NEW/g`
-* `--git` — Show a Git-format diff
-* `--color-words` — Show a word-level diff with changes indicated only by color
-* `--tool <TOOL>` — Generate diff by external command
-* `--context <CONTEXT>` — Number of lines of context to show
-
-
-
 ## `jj operation`
 
 Commands for working with the operation log

diff --git a/cli/tests/runner.rs b/cli/tests/runner.rs
@@ -27,6 +27,7 @@ mod test_diff_command;
 mod test_diffedit_command;
 mod test_duplicate_command;
 mod test_edit_command;
+mod test_evolog_command;
 mod test_file_chmod_command;
 mod test_file_print_command;
 mod test_fix_command;
@@ -49,7 +50,6 @@ mod test_log_command;
 mod test_move_command;
 mod test_new_command;
 mod test_next_prev_commands;
-mod test_obslog_command;
 mod test_operations;
 mod test_parallelize_command;
 mod test_rebase_command;

diff --git a/cli/tests/test_commit_template.rs b/cli/tests/test_commit_template.rs
@@ -431,7 +431,7 @@ fn test_log_builtin_templates_colored_debug() {
 }
 
 #[test]
-fn test_log_obslog_divergence() {
+fn test_log_evolog_divergence() {
     let test_env = TestEnvironment::default();
     test_env.jj_cmd_ok(test_env.env_root(), &["git", "init", "repo"]);
     let repo_path = test_env.env_root().join("repo");
@@ -473,8 +473,8 @@ fn test_log_obslog_divergence() {
     [1m[38;5;14m◆[0m  [1m[38;5;5mz[0m[38;5;8mzzzzzzz[39m [38;5;2mroot()[39m [1m[38;5;4m0[0m[38;5;8m0000000[39m
     "###);
 
-    // Obslog and hidden divergent
-    let stdout = test_env.jj_cmd_success(&repo_path, &["obslog"]);
+    // Evolog and hidden divergent
+    let stdout = test_env.jj_cmd_success(&repo_path, &["evolog"]);
     insta::assert_snapshot!(stdout, @r###"
     @  qpvuntsm?? [email protected] 2001-02-03 08:05:08 ff309c29
     │  description 1
@@ -484,8 +484,8 @@ fn test_log_obslog_divergence() {
        (empty) (no description set)
     "###);
 
-    // Colored obslog
-    let stdout = test_env.jj_cmd_success(&repo_path, &["obslog", "--color=always"]);
+    // Colored evolog
+    let stdout = test_env.jj_cmd_success(&repo_path, &["evolog", "--color=always"]);
     insta::assert_snapshot!(stdout, @r###"
     [1m[38;5;2m@[0m  [1m[4m[38;5;1mq[24mpvuntsm[38;5;9m??[39m [38;5;[email protected][39m [38;5;14m2001-02-03 08:05:08[39m [38;5;12mf[38;5;8mf309c29[39m[0m
     │  [1mdescription 1[0m