Skip to content

Commit 5f39b81

Browse files
jyn514tshepang
authored andcommitted
Add docs for x.py setup
1 parent ea7ee3a commit 5f39b81

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

src/getting-started.md

+21-14
Original file line numberDiff line numberDiff line change
@@ -126,22 +126,29 @@ this chapter for more info][config].
126126
In the top level of the repo:
127127

128128
```sh
129-
cp config.toml.example config.toml
129+
$ x.py setup
130130
```
131131

132-
Then, edit `config.toml`. You may want to search for, uncomment, and update
133-
the following settings:
134-
135-
- `debug = true`: enables debug symbols and `debug!` logging, takes a bit longer to compile.
136-
- `incremental = true`: enables incremental compilation of the compiler itself,
137-
which can significantly speed things up. This is turned off by default
138-
because it's technically unsound; sometimes it will cause weird crashes.
139-
Also, it can consume a lot of disk space. This has the same effect as the
140-
`-i` or `--incremental` flags.
141-
- `llvm-config`: enables building with system LLVM. [See this chapter][sysllvm]
142-
for more info. This avoids building LLVM, which can take a while (45 minutes
143-
on my laptop; others have reported 15 minutes or faster with incremental
144-
compilation).
132+
This will walk you through an interactive setup for x.py that looks like this:
133+
134+
```
135+
$ x.py setup
136+
Welcome to the Rust project! What do you want to do with x.py?
137+
a) Contribute to the standard library
138+
b) Contribute to the compiler
139+
c) Contribute to the compiler, and also modify LLVM or codegen
140+
d) Install Rust from source
141+
Please choose one (a/b/c/d): a
142+
`x.py` will now use the configuration at /home/joshua/rustc2/src/bootstrap/defaults/config.toml.library
143+
To get started, try one of the following commands:
144+
- `x.py check`
145+
- `x.py build`
146+
- `x.py test library/std`
147+
- `x.py doc`
148+
For more suggestions, see https://rustc-dev-guide.rust-lang.org/building/suggested.html
149+
```
150+
151+
You may also want to set up [system LLVM][sysllvm] to avoid building LLVM from source.
145152

146153
[sysllvm]: ./building/suggested.html#building-with-system-llvm
147154

0 commit comments

Comments
 (0)