Skip to content

Commit cb12afe

Browse files
committed
Auto merge of #14563 - epage:complete, r=weihanglo
docs(unstable): Expand on completion documentation ### What does this PR try to resolve? Wanting to improve the workflow for people testing completions ### How should we test and review this PR? ### Additional information
2 parents a6de8c7 + 9a658f9 commit cb12afe

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

src/doc/src/reference/unstable.md

+22-5
Original file line numberDiff line numberDiff line change
@@ -1695,21 +1695,38 @@ This feature moves the handwritten completion scripts to Rust native, making it
16951695
easier for us to add, extend and test new completions. This feature is enabled with the
16961696
nightly channel, without requiring additional `-Z` options.
16971697

1698+
Areas of particular interest for feedback
1699+
- Arguments that need escaping or quoting that aren't handled correctly
1700+
- Inaccuracies in the information
1701+
- Bugs in parsing of the command-line
1702+
- Arguments that don't report their completions
1703+
- If a known issue is being problematic
1704+
1705+
Feedback can be broken down into
1706+
- What completion candidates are reported
1707+
- Known issues: [#14520](https://github.com/rust-lang/cargo/issues/14520), [`A-completions`](https://github.com/rust-lang/cargo/labels/A-completions)
1708+
- [Report an issue](https://github.com/rust-lang/cargo/issues/new) or [discuss the behavior](https://github.com/rust-lang/cargo/issues/14520)
1709+
- Shell integration, command-line parsing, and completion filtering
1710+
- Known issues: [clap#3166](https://github.com/clap-rs/clap/issues/3166), [clap's `A-completions`](https://github.com/clap-rs/clap/labels/A-completion)
1711+
- [Report an issue](https://github.com/clap-rs/clap/issues/new/choose) or [discuss the behavior](https://github.com/clap-rs/clap/discussions/new/choose)
1712+
1713+
When in doubt, you can discuss this in [#14520](https://github.com/rust-lang/cargo/issues/14520) or on [zulip](https://rust-lang.zulipchat.com/#narrow/stream/246057-t-cargo)
1714+
16981715
### How to use native-completions feature:
16991716
- bash:
1700-
Add `source <(CARGO_COMPLETE=bash cargo)` to your .bashrc.
1717+
Add `source <(CARGO_COMPLETE=bash cargo +nightly)` to your .bashrc.
17011718

17021719
- zsh:
1703-
Add `source <(CARGO_COMPLETE=zsh cargo)` to your .zshrc.
1720+
Add `source <(CARGO_COMPLETE=zsh cargo +nightly)` to your .zshrc.
17041721

17051722
- fish:
1706-
Add `source (CARGO_COMPLETE=fish cargo | psub)` to `$XDG_CONFIG_HOME/fish/completions/cargo.fish`
1723+
Add `source (CARGO_COMPLETE=fish cargo +nightly | psub)` to `$XDG_CONFIG_HOME/fish/completions/cargo.fish`
17071724

17081725
- elvish:
1709-
Add `eval (E:CARGO_COMPLETE=elvish cargo | slurp)` to `$XDG_CONFIG_HOME/elvish/rc.elv`
1726+
Add `eval (E:CARGO_COMPLETE=elvish cargo +nightly | slurp)` to `$XDG_CONFIG_HOME/elvish/rc.elv`
17101727

17111728
- powershell:
1712-
Add `CARGO_COMPLETE=powershell cargo | Invoke-Expression` to `$PROFILE`.
1729+
Add `CARGO_COMPLETE=powershell cargo +nightly | Invoke-Expression` to `$PROFILE`.
17131730

17141731
# Stabilized and removed features
17151732

0 commit comments

Comments
 (0)