History

completion: improve docs for activation

It was not clear if users should activate both sets of completions if they wanted the dynamic ones. The shell commands for activating the dynamic completions are aligned with the static version. Users can choose / are responsible themselves to add the activation to their shell config if they want them in every shell instance. For fish specifically, `script | source` is more idiomatic than `source (script | psub)`.

Remo Senekowitsch committed 2 years ago

Commit a650af31 parent 8292d011 file · +10 −9Browse files

Unified · Split

docs/install-and-setup.md+10−9
@@ -210,12 +210,13 @@ To set up command-line completion, source the output of · 209 unmodified lines
210210 `jj util completion bash/zsh/fish`. Exactly how to source it
211211 depends on your shell.
212212
213−Improved completions are currently in the works, these will complete things
214−like bookmark names as well. You can activate them with the alternative "dynamic"
215−instructions below. Please let us know if you encounter any issues, so we can
216−ensure a smooth transition once we default to these new completions. If you
217−have ideas about specific completions that could be added, please share them
218−[here](https://github.com/martinvonz/jj/issues/4763).
213+Improved completions are currently in the works, these will complete things like
214+bookmark names as well. You can activate them with the alternative "dynamic"
215+instructions below. They should still complete everything the static completions
216+did, so only activate one of them. Please let us know if you encounter any
217+issues, so we can ensure a smooth transition once we default to these new
218+completions. If you have ideas about specific completions that could be added,
219+please share them [here](https://github.com/martinvonz/jj/issues/4763).
219220
220221 ### Bash
221222
@@ -226,7 +227,7 @@ source <(jj util completion bash) · 4 unmodified lines
226227 dynamic:
227228
228229 ```shell
229−echo "source <(COMPLETE=bash jj)" >> ~/.bashrc
230+source <(COMPLETE=bash jj)
230231 ```
231232
232233 ### Zsh
@@ -240,7 +241,7 @@ source <(jj util completion zsh) · 7 unmodified lines
240241 dynamic:
241242
242243 ```shell
243−echo "source <(COMPLETE=zsh jj)" >> ~/.zshrc
244+source <(COMPLETE=zsh jj)
244245 ```
245246
246247 ### Fish
@@ -252,7 +253,7 @@ jj util completion fish | source · 5 unmodified lines
252253 dynamic:
253254
254255 ```shell
255−echo "source (COMPLETE=fish jj | psub)" >> ~/.config/fish/config.fish
256+COMPLETE=fish jj | source
256257 ```
257258
258259 ### Nushell