diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2022-12-24 08:53:46 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-12-24 08:53:46 +0100 |
| commit | 9ae98804e51178a12bc8166bf469abc5283e10fd (patch) | |
| tree | 6af12de0189ef940e83ac5fdbf567710dfb97c82 /src/bootstrap | |
| parent | 4f4d0586ad20c66a16d547581ca379beafece93a (diff) | |
| parent | 70a0e0a2779f04999d0f0e40f93e1697c37ec042 (diff) | |
| download | rust-9ae98804e51178a12bc8166bf469abc5283e10fd.tar.gz rust-9ae98804e51178a12bc8166bf469abc5283e10fd.zip | |
Rollup merge of #105465 - jyn514:docs, r=Mark-Simulacrum
Improve top-level docs See a detailed explanation in the commit messages. This is a companion PR to https://github.com/rust-lang/rustc-dev-guide/pull/1528. * Link to other resources instead of inlining their information * Remove ancient and outdated reference to `config.mk` * Suggest `profile = "user"` in the README * Add detail about dependencies from the dev-guide * Link to CONTRIBUTING.md instead of rustc-dev-guide in the main readme * Link to `std-dev-guide` in CONTRIBUTING.md
Diffstat (limited to 'src/bootstrap')
| -rw-r--r-- | src/bootstrap/README.md | 10 | ||||
| -rw-r--r-- | src/bootstrap/config.rs | 5 |
2 files changed, 3 insertions, 12 deletions
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 84278583846..b41d60d51a8 100644 --- a/src/bootstrap/config.rs +++ b/src/bootstrap/config.rs @@ -49,10 +49,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 |