Skip to content

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed
 

‎README.md

+17-12
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@ Read ["Installation"] from [The Book].
2222

2323
The Rust build system uses a Python script called `x.py` to build the compiler,
2424
which manages the bootstrapping process. It lives at the root of the project.
25-
It also uses a file named `config.toml` to determine various configuration settings for the build.
26-
You can see a full list of options in `config.example.toml`.
25+
It also uses a file named `config.toml` to determine various configuration
26+
settings for the build. You can see a full list of options in
27+
`config.example.toml`.
2728

2829
The `x.py` command can be run directly on most Unix systems in the following
2930
format:
@@ -33,7 +34,8 @@ format:
3334
```
3435

3536
This is how the documentation and examples assume you are running `x.py`.
36-
See the [rustc dev guide][rustcguidebuild] if this does not work on your platform.
37+
See the [rustc dev guide][rustcguidebuild] if this does not work on your
38+
platform.
3739

3840
More information about `x.py` can be found by running it with the `--help` flag
3941
or reading the [rustc dev guide][rustcguidebuild].
@@ -105,24 +107,26 @@ See [the rustc-dev-guide for more info][sysllvm].
105107

106108
When complete, `./x.py install` will place several programs into
107109
`$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
108-
API-documentation tool. By default, it will also include [Cargo], Rust's package manager.
109-
You can disable this behavior by passing `--set build.extended=false` to `./configure`.
110+
API-documentation tool. By default, it will also include [Cargo], Rust's
111+
package manager. You can disable this behavior by passing
112+
`--set build.extended=false` to `./configure`.
110113

111114
[Cargo]: https://github.com/rust-lang/cargo
112115

113116
#### Configure and Make
114117

115-
This project provides a configure script and makefile (the latter of which just invokes `x.py`).
116-
`./configure` is the recommended way to programatically generate a `config.toml`. `make` is not
117-
recommended (we suggest using `x.py` directly), but it is supported and we try not to break it
118-
unnecessarily.
118+
This project provides a configure script and makefile (the latter of which just
119+
invokes `x.py`). `./configure` is the recommended way to programatically
120+
generate a `config.toml`. `make` is not recommended (we suggest using `x.py`
121+
directly), but it is supported and we try not to break it unnecessarily.
119122

120123
```sh
121124
./configure
122125
make && sudo make install
123126
```
124127

125-
`configure` generates a `config.toml` which can also be used with normal `x.py` invocations.
128+
`configure` generates a `config.toml` which can also be used with normal `x.py`
129+
invocations.
126130

127131
### Building on Windows
128132

@@ -193,7 +197,7 @@ toolchain.
193197
#### MSVC
194198

195199
MSVC builds of Rust additionally require an installation of Visual Studio 2017
196-
(or later) so `rustc` can use its linker. The simplest way is to get
200+
(or later) so `rustc` can use its linker. The simplest way is to get
197201
[Visual Studio], check the "C++ build tools" and "Windows 10 SDK" workload.
198202

199203
[Visual Studio]: https://visualstudio.microsoft.com/downloads/
@@ -234,7 +238,8 @@ Windows build triples are:
234238

235239
The build triple can be specified by either specifying `--build=<triple>` when
236240
invoking `x.py` commands, or by creating a `config.toml` file (as described in
237-
[Building on a Unix-like system](#building-on-a-unix-like-system)), and passing `--set build.build=<triple>` to `./configure`.
241+
[Building on a Unix-like system](#building-on-a-unix-like-system)), and passing
242+
`--set build.build=<triple>` to `./configure`.
238243

239244
## Building Documentation
240245

0 commit comments

Comments
 (0)
Please sign in to comment.