diff options
| author | Joshua Nelson <github@jyn.dev> | 2022-12-23 19:03:51 -0600 |
|---|---|---|
| committer | Joshua Nelson <github@jyn.dev> | 2022-12-23 19:08:53 -0600 |
| commit | 70a0e0a2779f04999d0f0e40f93e1697c37ec042 (patch) | |
| tree | f4fb71ad289f8dd4c7a1af6a68948b3ea1a21736 | |
| parent | 1bd1b25be8b4cc20358028108f8a35b8760b5cd3 (diff) | |
| download | rust-70a0e0a2779f04999d0f0e40f93e1697c37ec042.tar.gz | |
Remove ancient and outdated references to `config.mk`
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | src/bootstrap/README.md | 10 | ||||
| -rw-r--r-- | src/bootstrap/config.rs | 5 |
3 files changed, 4 insertions, 15 deletions
diff --git a/README.md b/README.md index e2042eb2d45..014fab907fb 100644 --- a/README.md +++ b/README.md @@ -228,9 +228,7 @@ configure script and makefile (the latter of which just invokes `x.py`). make && sudo make install ``` -When using the configure script, the generated `config.mk` file may override the -`config.toml` file. To go back to the `config.toml` file, delete the generated -`config.mk` file. +`configure` generates a `config.toml` which can also be used with normal `x.py` invocations. ## Building Documentation diff --git a/src/bootstrap/README.md b/src/bootstrap/README.md index 985727bddc5..79c2eb31cda 100644 --- a/src/bootstrap/README.md +++ b/src/bootstrap/README.md @@ -80,18 +80,12 @@ The script accepts commands, flags, and arguments to determine what to do: ## Configuring rustbuild -There are currently two methods for configuring the rustbuild build system. - -First, rustbuild offers a TOML-based configuration system with a `config.toml` +rustbuild offers a TOML-based configuration system with a `config.toml` file. An example of this configuration can be found at `config.toml.example`, and the configuration file can also be passed as `--config path/to/config.toml` if the build system is being invoked manually (via the python script). -Next, the `./configure` options serialized in `config.mk` will be -parsed and read. That is, if any `./configure` options are passed, they'll be -handled naturally. `./configure` should almost never be used for local -installations, and is primarily useful for CI. Prefer to customize behavior -using `config.toml`. +You can generate a config.toml using `./configure` options if you want to automate creating the file without having to edit it. Finally, rustbuild makes use of the [cc-rs crate] which has [its own method][env-vars] of configuring C compilers and C flags via environment diff --git a/src/bootstrap/config.rs b/src/bootstrap/config.rs index d8c15c76e2d..3ae23db1d1c 100644 --- a/src/bootstrap/config.rs +++ b/src/bootstrap/config.rs @@ -46,10 +46,7 @@ pub enum DryRun { /// Global configuration for the entire build and/or bootstrap. /// -/// This structure is derived from a combination of both `config.toml` and -/// `config.mk`. As of the time of this writing it's unlikely that `config.toml` -/// is used all that much, so this is primarily filled out by `config.mk` which -/// is generated from `./configure`. +/// This structure is parsed from `config.toml`, and some of the fields are inferred from `git` or build-time parameters. /// /// Note that this structure is not decoded directly into, but rather it is /// filled out from the decoded forms of the structs below. For documentation |