Skip to content

Commit 35f6370

Browse files
committed
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.
1 parent 877f5fb commit 35f6370

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/building/how-to-build-and-run.md

+8
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,14 @@ if you want to learn more about `x.py`, read its README.md
7070
To read more about the bootstrap process and why `x.py` is necessary,
7171
[read this chapter][bootstrap].
7272

73+
### Running `x.py` slightly more conveniently
74+
75+
There is a binary that wraps `x.py` called `x` in `src/tools/x`. All it does is
76+
run `x.py`, but it can be installed system-wide and run from any subdirectory
77+
of a checkout.
78+
79+
You can install it with `cargo install --path/src/tools/x`.
80+
7381
[bootstrap]: ./bootstrapping.md
7482

7583
## Building the Compiler

0 commit comments

Comments
 (0)