mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2025-02-07 13:00:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 20

cli reference & jj log --help: render URLs in CLI refrerence

Browse source 
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.
This commit is contained in:
Ilya Grigoriev 2025-01-27 14:56:43 -08:00
parent 88d3b52081
commit f4346f2e51
3 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
cli/src/commands/log.rs
View file

@ -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
/// <https://jj-vcs.github.io/jj/latest/revsets/>) 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
/// (<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>.
#[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 <https://jj-vcs.github.io/jj/latest/templates/>.
///
/// If not specified, this defaults to the `templates.log` setting.
#[arg(long, short = 'T')]

2
cli/src/commands/operation/log.rs
View file

@ -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 <https://jj-vcs.github.io/jj/latest/templates/>
#[arg(long, short = 'T')]
template: Option<String>,
/// Show changes to the repository at each operation

8
cli/tests/cli-reference@.md.snap
View file

@ -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 <https://jj-vcs.github.io/jj/latest/revsets/>) 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 (<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>.
**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 <https://jj-vcs.github.io/jj/latest/templates/>.
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 <TEMPLATE>` — Render each operation using the given template
For the syntax, see https://jj-vcs.github.io/jj/latest/templates/
For the syntax, see <https://jj-vcs.github.io/jj/latest/templates/>
* `--op-diff` — Show changes to the repository at each operation
* `-p`, `--patch` — Show patch of modifications to changes (implies --op-diff)