diff options
| author | Casey Rodarmor <casey@rodarmor.com> | 2020-11-08 14:46:41 -0800 |
|---|---|---|
| committer | Tshepang Lekhonkhobe <tshepang@gmail.com> | 2020-11-09 09:07:41 +0200 |
| commit | 9c0b661c4966edc0507b839e38fc717e683a56cf (patch) | |
| tree | 0532c7e25af53dbb0b8fbd14ae126be0eae8c9c8 /src/doc/rustc-dev-guide | |
| parent | 6e9d316e14f2bb5d106ae084c44ec1c412164fd1 (diff) | |
| download | rust-9c0b661c4966edc0507b839e38fc717e683a56cf.tar.gz rust-9c0b661c4966edc0507b839e38fc717e683a56cf.zip | |
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.
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/building/how-to-build-and-run.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/how-to-build-and-run.md b/src/doc/rustc-dev-guide/src/building/how-to-build-and-run.md index 0195659acb4..39d7e9a4c0b 100644 --- a/src/doc/rustc-dev-guide/src/building/how-to-build-and-run.md +++ b/src/doc/rustc-dev-guide/src/building/how-to-build-and-run.md @@ -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, [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 ## Building the Compiler |