From bfbd04b083c7c1dfcb96cbf49ba38376ef116d88 Mon Sep 17 00:00:00 2001 From: Ilya Grigoriev Date: Fri, 8 Nov 2024 20:38:13 -0800 Subject: [PATCH] cli: document `b` as a "default alias" Unlike other documented aliases, it can be redefined by the user. However, I think it's important for people to be informed that `b` exists. I left `amend`, `unamend`, and `ci` undocumented, since I think we were considering removing or at least discouraging them. --- cli/src/commands/bookmark/mod.rs | 5 ++++- cli/tests/cli-reference@.md.snap | 4 ++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/cli/src/commands/bookmark/mod.rs b/cli/src/commands/bookmark/mod.rs index 14d32d7dc9..9e955e6609 100644 --- a/cli/src/commands/bookmark/mod.rs +++ b/cli/src/commands/bookmark/mod.rs @@ -56,7 +56,10 @@ use crate::command_error::user_error; use crate::command_error::CommandError; use crate::ui::Ui; -/// Manage bookmarks +// Unlike most other aliases, `b` is defined in the config and can be overridden +// by the user. + +/// Manage bookmarks [default alias: b] /// /// For information about bookmarks, see /// https://martinvonz.github.io/jj/latest/bookmarks. diff --git a/cli/tests/cli-reference@.md.snap b/cli/tests/cli-reference@.md.snap index 29b2fec0fe..8575bb7780 100644 --- a/cli/tests/cli-reference@.md.snap +++ b/cli/tests/cli-reference@.md.snap @@ -122,7 +122,7 @@ To get started, see the tutorial at https://martinvonz.github.io/jj/latest/tutor * `abandon` — Abandon a revision * `backout` — Apply the reverse of a revision on top of another revision -* `bookmark` — Manage bookmarks +* `bookmark` — Manage bookmarks [default alias: b] * `commit` — Update the description and create a new change on top * `config` — Manage config options * `describe` — Update the change description or other metadata [aliases: desc] @@ -239,7 +239,7 @@ Apply the reverse of a revision on top of another revision ## `jj bookmark` -Manage bookmarks +Manage bookmarks [default alias: b] For information about bookmarks, see https://martinvonz.github.io/jj/latest/bookmarks.