mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2025-01-12 23:23:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

docs: clarify dynamic completion features

Browse source
This commit is contained in:
Remo Senekowitsch 2024-11-28 15:36:20 +01:00
parent 1b96d27b66
commit d76bcd9305
2 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -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 * 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) [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 * Added the config setting `snapshot.auto-update-stale` for automatically
running `jj workspace update-stale` when applicable. running `jj workspace update-stale` when applicable.

18
docs/install-and-setup.md
View file

@ -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 `jj util completion bash/zsh/fish`. Exactly how to source it
depends on your shell. depends on your shell.
Improved completions are currently in the works, these will complete things like Improved completions are also available. They will complete things like
bookmark names as well. You can activate them with the alternative "dynamic" bookmarks, aliases, revisions, operations and files. They can be context aware,
instructions below. They should still complete everything the static completions for example they respect the global flags `--repository` and `--at-operation` as
did, so only activate one of them. Please let us know if you encounter any well as some command-specific ones like `--revision`, `--from` and `--to`. You
issues, so we can ensure a smooth transition once we default to these new can activate them with the alternative "dynamic" instructions below. They should
completions. If you have ideas about specific completions that could be added, still complete everything the static completions did, so only activate one of
please share them [here](https://github.com/martinvonz/jj/issues/4763). 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 ### Bash