From 77477aef998cb9f1d024f63af3f2e2bb8191c909 Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Sat, 16 Nov 2024 09:52:52 -0800 Subject: [PATCH] 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. --- cli/src/commands/log.rs | 5 +++++ cli/tests/cli-reference@.md.snap | 2 ++ 2 files changed, 7 insertions(+) diff --git a/cli/src/commands/log.rs b/cli/src/commands/log.rs index 5f1b2a8e3b..b01c594bd6 100644 --- 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/cli-reference@.md.snap b/cli/tests/cli-reference@.md.snap index 41b247d87a..d730d729b7 100644 --- a/cli/tests/cli-reference@.md.snap +++ b/cli/tests/cli-reference@.md.snap @@ -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:**