diff options
| author | clubby789 <jamie@hill-daniel.co.uk> | 2023-05-10 21:16:19 +0100 |
|---|---|---|
| committer | jyn <github@jyn.dev> | 2023-05-17 21:44:05 -0500 |
| commit | dd4e8839f9c4df06efd03d2878ca0d7f6b209969 (patch) | |
| tree | a0babcd74780408aca9a1995f128e9fe541ad294 /src/doc/rustc-dev-guide | |
| parent | 0847a932519486e17feb0359f4042957e1e6aadd (diff) | |
| download | rust-dd4e8839f9c4df06efd03d2878ca0d7f6b209969.tar.gz rust-dd4e8839f9c4df06efd03d2878ca0d7f6b209969.zip | |
Add note about shell completion scripts
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/building/suggested.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/suggested.md b/src/doc/rustc-dev-guide/src/building/suggested.md index 8cf9891b6c9..9dcc795f20e 100644 --- a/src/doc/rustc-dev-guide/src/building/suggested.md +++ b/src/doc/rustc-dev-guide/src/building/suggested.md @@ -339,3 +339,13 @@ pkgs.mkShell { RUST_BOOTSTRAP_CONFIG = config; } ``` + +## Shell Completions + +If you use Bash, Fish or PowerShell, you can find automatically-generated shell completion scripts for `x.py` in [`src/etc/completions`](https://github.com/rust-lang/rust/tree/master/src/etc/completions). +Zsh support will also be included once issues with [`clap_complete`](https://crates.io/crates/clap_complete) have been resolved. + +You can use `source ./src/etc/completions/x.py.<extension>` +to load completions for your shell of choice, +or `source .\src\etc\completions\x.py.ps1` for PowerShell. +Adding this to your shell's startup script (e.g. `.bashrc`) will automatically load this completion. \ No newline at end of file |