Skip to content

Commit 70a0e0a

Browse files
committed
Remove ancient and outdated references to config.mk
1 parent 1bd1b25 commit 70a0e0a

File tree

3 files changed

+4
-15
lines changed

3 files changed

+4
-15
lines changed

README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -228,9 +228,7 @@ configure script and makefile (the latter of which just invokes `x.py`).
228228
make && sudo make install
229229
```
230230

231-
When using the configure script, the generated `config.mk` file may override the
232-
`config.toml` file. To go back to the `config.toml` file, delete the generated
233-
`config.mk` file.
231+
`configure` generates a `config.toml` which can also be used with normal `x.py` invocations.
234232

235233
## Building Documentation
236234

src/bootstrap/README.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -80,18 +80,12 @@ The script accepts commands, flags, and arguments to determine what to do:
8080

8181
## Configuring rustbuild
8282

83-
There are currently two methods for configuring the rustbuild build system.
84-
85-
First, rustbuild offers a TOML-based configuration system with a `config.toml`
83+
rustbuild offers a TOML-based configuration system with a `config.toml`
8684
file. An example of this configuration can be found at `config.toml.example`,
8785
and the configuration file can also be passed as `--config path/to/config.toml`
8886
if the build system is being invoked manually (via the python script).
8987

90-
Next, the `./configure` options serialized in `config.mk` will be
91-
parsed and read. That is, if any `./configure` options are passed, they'll be
92-
handled naturally. `./configure` should almost never be used for local
93-
installations, and is primarily useful for CI. Prefer to customize behavior
94-
using `config.toml`.
88+
You can generate a config.toml using `./configure` options if you want to automate creating the file without having to edit it.
9589

9690
Finally, rustbuild makes use of the [cc-rs crate] which has [its own
9791
method][env-vars] of configuring C compilers and C flags via environment

src/bootstrap/config.rs

+1-4
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,7 @@ pub enum DryRun {
4646

4747
/// Global configuration for the entire build and/or bootstrap.
4848
///
49-
/// This structure is derived from a combination of both `config.toml` and
50-
/// `config.mk`. As of the time of this writing it's unlikely that `config.toml`
51-
/// is used all that much, so this is primarily filled out by `config.mk` which
52-
/// is generated from `./configure`.
49+
/// This structure is parsed from `config.toml`, and some of the fields are inferred from `git` or build-time parameters.
5350
///
5451
/// Note that this structure is not decoded directly into, but rather it is
5552
/// filled out from the decoded forms of the structs below. For documentation

0 commit comments

Comments
 (0)