itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-28 11:20:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update instructions on using native-completions (#15480)

Browse Source 
`~/.local/share/bash-completion/completions/cargo` is more sensible, and
[recommended by
rustup](e4f3ad6f89/src/cli/help.rs (L275)).

<!--
Thanks for submitting a pull request 🎉! Here are some tips for you:

* If this is your first contribution, read "Cargo Contribution Guide"
first:
  https://doc.crates.io/contrib/
* Run `cargo fmt --all` to format your code changes.
* Small commits and pull requests are always preferable and easy to
review.
* If your idea is large and needs feedback from the community, read how:
  https://doc.crates.io/contrib/process/#working-on-large-features
* Cargo takes care of compatibility. Read our design principles:
  https://doc.crates.io/contrib/design.html
* When changing help text of cargo commands, follow the steps to
generate docs:

https://github.com/rust-lang/cargo/tree/master/src/doc#building-the-man-pages
* If your PR is not finished, set it as "draft" PR or add "WIP" in its
title.
* It's ok to use the CI resources to test your PR, but please don't
abuse them.

### What does this PR try to resolve?

Explain the motivation behind this change.
A clear overview along with an in-depth explanation are helpful.

You can use `Fixes #<issue number>` to associate this PR to an existing
issue.

### How should we test and review this PR?

Demonstrate how you test this change and guide reviewers through your
PR.
With a smooth review process, a pull request usually gets reviewed
quicker.

If you don't know how to write and run your tests, please read the
guide:
https://doc.crates.io/contrib/tests

### Additional information

Other information you want to mention in this PR, such as prior arts,
future extensions, an unresolved problem, or a TODO list.
-->
This commit is contained in:
Weihang Lo 2025-05-09 13:15:26 +00:00 committed by GitHub
commit c566be4742
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/doc/src/reference/unstable.md
View File

@ -1817,10 +1817,10 @@ When in doubt, you can discuss this in [#14520](https://github.com/rust-lang/car
### How to use native-completions feature:
- bash:
Add `source <(CARGO_COMPLETE=bash cargo +nightly)` to your .bashrc.
Add `source <(CARGO_COMPLETE=bash cargo +nightly)` to `$XDG_DATA_HOME/bash-completion/completions/cargo`, or `~/.local/share/bash-completion/completions/cargo` if `XDG_DATA_HOME` is not set.
- zsh:
Add `source <(CARGO_COMPLETE=zsh cargo +nightly)` to your .zshrc.
Add `source <(CARGO_COMPLETE=zsh cargo +nightly)` to your `.zshrc`.
- fish:
Add `source (CARGO_COMPLETE=fish cargo +nightly | psub)` to `$XDG_CONFIG_HOME/fish/completions/cargo.fish`