From f4346f2e51dfff1fc3e398c6764b472cca83d6f2 Mon Sep 17 00:00:00 2001 From: Ilya Grigoriev Date: Mon, 27 Jan 2025 14:56:43 -0800 Subject: [PATCH] cli reference & `jj log --help`: render URLs in CLI refrerence Fixes #5490 (we can catch other instances of this manually) Note that it links to the `latest` even if you are looking at the `prerelease` docs. This is not ideal, but seems annoying to fix. --- cli/src/commands/log.rs | 11 ++++++----- cli/src/commands/operation/log.rs | 2 +- cli/tests/cli-reference@.md.snap | 8 ++++---- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/cli/src/commands/log.rs b/cli/src/commands/log.rs index 7d46c4cf0..eb4cc8356 100644 --- a/cli/src/commands/log.rs +++ b/cli/src/commands/log.rs @@ -48,16 +48,17 @@ use crate::ui::Ui; /// before parents. By default, the output only includes mutable revisions, /// along with some additional revisions for context. Use `jj log -r ::` to see /// all revisions. See `jj help -k revsets` (or -/// https://jj-vcs.github.io/jj/latest/revsets/) for information about the +/// ) for information about the /// syntax. /// /// 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://jj-vcs.github.io/jj/latest/config/#set-of-immutable-commits) -/// have a `◆` symbol. Other commits have a `○` symbol. To customize these -/// symbols, see https://jj-vcs.github.io/jj/latest/config/#node-style. +/// revisions +/// () have +/// a `◆` symbol. Other commits have a `○` symbol. To customize these symbols, +/// see . #[derive(clap::Args, Clone, Debug)] pub(crate) struct LogArgs { /// Which revisions to show @@ -95,7 +96,7 @@ pub(crate) struct LogArgs { /// Run `jj log -T` to list the built-in templates. /// /// You can also specify arbitrary template expressions. For the syntax, - /// see https://jj-vcs.github.io/jj/latest/templates/. + /// see . /// /// If not specified, this defaults to the `templates.log` setting. #[arg(long, short = 'T')] diff --git a/cli/src/commands/operation/log.rs b/cli/src/commands/operation/log.rs index 51f8e7f5c..0f2cecc48 100644 --- a/cli/src/commands/operation/log.rs +++ b/cli/src/commands/operation/log.rs @@ -62,7 +62,7 @@ pub struct OperationLogArgs { no_graph: bool, /// Render each operation using the given template /// - /// For the syntax, see https://jj-vcs.github.io/jj/latest/templates/ + /// For the syntax, see #[arg(long, short = 'T')] template: Option, /// Show changes to the repository at each operation diff --git a/cli/tests/cli-reference@.md.snap b/cli/tests/cli-reference@.md.snap index ed673fc23..e21910b17 100644 --- a/cli/tests/cli-reference@.md.snap +++ b/cli/tests/cli-reference@.md.snap @@ -1367,11 +1367,11 @@ This excludes changes from other commits by temporarily rebasing `--from` onto ` Show revision history -Renders a graphical view of the project's history, ordered with children before parents. By default, the output only includes mutable revisions, along with some additional revisions for context. Use `jj log -r ::` to see all revisions. See `jj help -k revsets` (or https://jj-vcs.github.io/jj/latest/revsets/) for information about the syntax. +Renders a graphical view of the project's history, ordered with children before parents. By default, the output only includes mutable revisions, along with some additional revisions for context. Use `jj log -r ::` to see all revisions. See `jj help -k revsets` (or ) for information about the syntax. 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://jj-vcs.github.io/jj/latest/config/#set-of-immutable-commits) have a `◆` symbol. Other commits have a `○` symbol. To customize these symbols, see https://jj-vcs.github.io/jj/latest/config/#node-style. +The working-copy commit is indicated by a `@` symbol in the graph. Immutable revisions () have a `◆` symbol. Other commits have a `○` symbol. To customize these symbols, see . **Usage:** `jj log [OPTIONS] [FILESETS]...` @@ -1393,7 +1393,7 @@ The working-copy commit is indicated by a `@` symbol in the graph. Immutable rev Run `jj log -T` to list the built-in templates. - You can also specify arbitrary template expressions. For the syntax, see https://jj-vcs.github.io/jj/latest/templates/. + You can also specify arbitrary template expressions. For the syntax, see . If not specified, this defaults to the `templates.log` setting. * `-p`, `--patch` — Show patch @@ -1578,7 +1578,7 @@ Like other commands, `jj op log` snapshots the current working-copy changes and * `--no-graph` — Don't show the graph, show a flat list of operations * `-T`, `--template