Skip to content

Commit

Permalink
cli: document b as a "default alias"
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ilyagr committed Nov 11, 2024
1 parent 0e67ef9 commit bfbd04b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
5 changes: 4 additions & 1 deletion cli/src/commands/bookmark/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions cli/tests/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit bfbd04b

Please sign in to comment.