user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

external-rustc-drivers.md: some improvements

Browse source
This commit is contained in:
Tshepang Mbambo 2026-01-31 21:34:36 +02:00
parent 3f3a544798
commit 4956604c7d
1 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

21
src/doc/rustc-dev-guide/src/rustc-driver/external-rustc-drivers.md
View file

@ -42,29 +42,28 @@ For custom-built toolchains or environments not using rustup, additional configu
#### Troubleshooting Steps
1. **Check LLVM installation**: Verify LLVM is installed and accessible
2. **Configure library paths**: You may need to set environment variables:
```text
1. Verify LLVM is installed and accessible
2. Ensure that library paths are set:
```sh
export LD_LIBRARY_PATH=/path/to/llvm/lib:$LD_LIBRARY_PATH
```
3. **Check version compatibility**: Ensure your LLVM version is compatible with your Rust toolchain
3. Ensure your LLVM version is compatible with your Rust toolchain
### Configuring `rust-analyzer` for Out-of-Tree Projects
### Configuring `rust-analyzer` for out-of-tree projects
When developing out-of-tree projects that use `rustc_private` crates, you can configure `rust-analyzer` to recognize these crates.
#### Configuration Steps
1. **Set rust-analyzer configuration**
Configure `rust-analyzer.rustc.source` to `"discover"` in your editor settings.
1. Configure `rust-analyzer.rustc.source` to `"discover"` in your editor settings.
For VS Code, add to `rust_analyzer_settings.json`:
```json
{
"rust-analyzer.rustc.source": "discover"
}
```
2. **Add metadata to Cargo.toml**
Add the following to the `Cargo.toml` of every crate that uses `rustc_private`:
2. Add the following to the `Cargo.toml` of every crate that uses `rustc_private`:
```toml
[package.metadata.rust-analyzer]
rustc_private = true
@ -74,4 +73,6 @@ This configuration allows `rust-analyzer` to properly recognize and provide IDE
### Additional Resources
- [GitHub Issue #137421](https://github.com/rust-lang/rust/issues/137421): Explains that `rustc_private` linker failures often occur because `llvm-tools` is not installed
- [GitHub Issue #137421] explains that `rustc_private` linker failures often occur because `llvm-tools` is not installed
[GitHub Issue #137421]: https://github.com/rust-lang/rust/issues/137421