Skip to content

Commit

Permalink
docs: clarify dynamic completion features
Browse files Browse the repository at this point in the history
  • Loading branch information
senekor committed Nov 29, 2024
1 parent e4231f2 commit 878e7ab
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

* A preview of improved shell completions was added. Please refer to the
[documentation](https://martinvonz.github.io/jj/latest/install-and-setup/#command-line-completion)
to activate them.
to activate them. They additionally complete context-dependent, dynamic values
like bookmarks, aliases, revisions, operations and files.

* Added the config setting `snapshot.auto-update-stale` for automatically
running `jj workspace update-stale` when applicable.
Expand Down
18 changes: 11 additions & 7 deletions docs/install-and-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,13 +210,17 @@ To set up command-line completion, source the output of
`jj util completion bash/zsh/fish`. Exactly how to source it
depends on your shell.

Improved completions are currently in the works, these will complete things like
bookmark names as well. You can activate them with the alternative "dynamic"
instructions below. They should still complete everything the static completions
did, so only activate one of them. Please let us know if you encounter any
issues, so we can ensure a smooth transition once we default to these new
completions. If you have ideas about specific completions that could be added,
please share them [here](https://github.com/martinvonz/jj/issues/4763).
Improved completions are also available. They will complete things like
bookmarks, aliases, revisions, operations and files. They can be context aware,
for example they respect the global flags `--repository` and `--at-operation` as
well as some command-specific ones like `--revision`, `--from` and `--to`. You
can activate them with the alternative "dynamic" instructions below. They should
still complete everything the static completions did, so only activate one of
them. Please let us know if you encounter any issues, so we can ensure a smooth
transition once we default to these new completions. Our initial experience
is that these new completions work best with `fish`. If you have ideas about
specific completions that could be added, please share them
[here](https://github.com/martinvonz/jj/issues/4763).

### Bash

Expand Down

0 comments on commit 878e7ab

Please sign in to comment.