log: describe the different graph node symbols in help text

It's not obvious what the symbols mean. We've had a few questions about it on Discord recently.
jj-vcs · Nov 16, 2024 · 77477ae · 77477ae
1 parent eb91547
commit 77477ae
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/cli/src/commands/log.rs b/cli/src/commands/log.rs
@@ -47,6 +47,11 @@ use crate::ui::Ui;
 ///
 /// Spans of revisions that are not included in the graph per `--revisions` are
 /// rendered as a synthetic node labeled "(elided revisions)".
+///
+/// The working-copy commit is indicated by a `@` symbol in the graph. Immutable
+/// revisions (https://martinvonz.github.io/jj/latest/config/#set-of-immutable-commits)
+/// have a `◆` symbol. Other commits have a `○` symbol. To customize these
+/// symbols, see https://martinvonz.github.io/jj/latest/config/#node-style.
 #[derive(clap::Args, Clone, Debug)]
 pub(crate) struct LogArgs {
     /// Which revisions to show

diff --git a/cli/tests/[email protected] b/cli/tests/[email protected]
@@ -1340,6 +1340,8 @@ Renders a graphical view of the project's history, ordered with children before
 
 Spans of revisions that are not included in the graph per `--revisions` are rendered as a synthetic node labeled "(elided revisions)".
 
+The working-copy commit is indicated by a `@` symbol in the graph. Immutable revisions (https://martinvonz.github.io/jj/latest/config/#set-of-immutable-commits) have a `◆` symbol. Other commits have a `○` symbol. To customize these symbols, see https://martinvonz.github.io/jj/latest/config/#node-style.
+
 **Usage:** `jj log [OPTIONS] [PATHS]...`
 
 ###### **Arguments:**