diff --git a/CHANGELOG.md b/CHANGELOG.md index ca5a9e48f4..a990be314d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,9 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). * Templates now support the `==` logical operator for `Boolean`, `Integer`, and `String` types. +* The `jj desc` and `jj st` aliases are now hidden to not interfere with shell + completion. They remain available. + ### Fixed bugs ## [0.23.0] - 2024-11-06 diff --git a/cli/src/commands/describe.rs b/cli/src/commands/describe.rs index d40a080966..3ca4be5e90 100644 --- a/cli/src/commands/describe.rs +++ b/cli/src/commands/describe.rs @@ -34,12 +34,12 @@ use crate::description_util::ParsedBulkEditMessage; use crate::text_util::parse_author; use crate::ui::Ui; -/// Update the change description or other metadata +/// Update the change description or other metadata [aliases: desc] /// /// Starts an editor to let you edit the description of changes. The editor /// will be $EDITOR, or `pico` if that's not defined (`Notepad` on Windows). #[derive(clap::Args, Clone, Debug)] -#[command(visible_aliases = &["desc"])] +#[command(alias = "desc")] pub(crate) struct DescribeArgs { /// The revision(s) whose description to edit #[arg(default_value = "@")] diff --git a/cli/src/commands/status.rs b/cli/src/commands/status.rs index 98d1090fcd..794cf4f928 100644 --- a/cli/src/commands/status.rs +++ b/cli/src/commands/status.rs @@ -26,7 +26,7 @@ use crate::diff_util::get_copy_records; use crate::diff_util::DiffFormat; use crate::ui::Ui; -/// Show high-level repo status +/// Show high-level repo status [aliases: st] /// /// This includes: /// @@ -34,7 +34,7 @@ use crate::ui::Ui; /// changes between them /// * Conflicted bookmarks (see https://martinvonz.github.io/jj/latest/bookmarks/) #[derive(clap::Args, Clone, Debug)] -#[command(visible_alias = "st")] +#[command(alias = "st")] pub(crate) struct StatusArgs { /// Restrict the status display to these paths #[arg(value_hint = clap::ValueHint::AnyPath)] diff --git a/cli/tests/cli-reference@.md.snap b/cli/tests/cli-reference@.md.snap index 826e787fe2..7b354cda2e 100644 --- a/cli/tests/cli-reference@.md.snap +++ b/cli/tests/cli-reference@.md.snap @@ -1,7 +1,6 @@ --- source: cli/tests/test_generate_md_cli_help.rs description: "AUTO-GENERATED FILE, DO NOT EDIT. This cli reference is generated by a test as an `insta` snapshot. MkDocs includes this snapshot from docs/cli-reference.md." -snapshot_kind: text --- @@ -124,7 +123,7 @@ To get started, see the tutorial at https://martinvonz.github.io/jj/latest/tutor * `bookmark` — Manage bookmarks * `commit` — Update the description and create a new change on top * `config` — Manage config options -* `describe` — Update the change description or other metadata +* `describe` — Update the change description or other metadata [aliases: desc] * `diff` — Compare file contents between two revisions * `diffedit` — Touch up the content changes in a revision with a diff editor * `duplicate` — Create a new change with the same content as an existing one @@ -151,7 +150,7 @@ To get started, see the tutorial at https://martinvonz.github.io/jj/latest/tutor * `sparse` — Manage which paths from the working-copy commit are present in the working copy * `split` — Split a revision in two * `squash` — Move changes from a revision into another revision -* `status` — Show high-level repo status +* `status` — Show high-level repo status [aliases: st] * `tag` — Manage tags * `util` — Infrequently used commands such as for generating shell completions * `undo` — Undo an operation (shortcut for `jj op undo`) @@ -605,7 +604,7 @@ Update config file to unset the given option ## `jj describe` -Update the change description or other metadata +Update the change description or other metadata [aliases: desc] Starts an editor to let you edit the description of changes. The editor will be $EDITOR, or `pico` if that's not defined (`Notepad` on Windows). @@ -2054,7 +2053,7 @@ If a working-copy commit gets abandoned, it will be given a new, empty commit. T ## `jj status` -Show high-level repo status +Show high-level repo status [aliases: st] This includes: