mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document `src/tools/x`, an `x.py` wrapper 

Document the newly added `x` binary that wraps `x.py`, which can be
installed system-wide, and can be run from any subdirectory of a rust
repo checkout.
This commit is contained in:
Casey Rodarmor 2020-11-08 14:46:41 -08:00 committed by Tshepang Lekhonkhobe
parent 3f33422aab
commit ac0b94deff
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/building/how-to-build-and-run.md
View File

@ -70,6 +70,14 @@ if you want to learn more about `x.py`, read its README.md
To read more about the bootstrap process and why `x.py` is necessary, To read more about the bootstrap process and why `x.py` is necessary,
[read this chapter][bootstrap]. [read this chapter][bootstrap].
### Running `x.py` slightly more conveniently
There is a binary that wraps `x.py` called `x` in `src/tools/x`. All it does is
run `x.py`, but it can be installed system-wide and run from any subdirectory
of a checkout.
You can install it with `cargo install --path/src/tools/x`.
[bootstrap]: ./bootstrapping.md [bootstrap]: ./bootstrapping.md
## Building the Compiler ## Building the Compiler