diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 04b6fea75a78a..5b325110d380b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,7 +99,7 @@ Before you can start building the compiler you need to configure the build for your system. In most cases, that will just mean using the defaults provided for Rust. -To change configuration, you must copy the file `src/bootstrap/config.toml.example` +To change configuration, you must copy the file `config.toml.example` to `config.toml` in the directory from which you will be running the build, and change the settings provided. diff --git a/README.md b/README.md index a1f018610753c..b6ff6df0aec94 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ Read ["Installation"] from [The Book]. ``` > ***Note:*** Install locations can be adjusted by copying the config file - > from `./src/bootstrap/config.toml.example` to `./config.toml`, and + > from `./config.toml.example` to `./config.toml`, and > adjusting the `prefix` option under `[install]`. Various other options, such > as enabling debug information, are also supported, and are documented in > the config file. diff --git a/src/bootstrap/config.toml.example b/config.toml.example similarity index 100% rename from src/bootstrap/config.toml.example rename to config.toml.example diff --git a/src/bootstrap/README.md b/src/bootstrap/README.md index 1ce99eb893efe..65c1088f5473f 100644 --- a/src/bootstrap/README.md +++ b/src/bootstrap/README.md @@ -80,7 +80,7 @@ handled naturally. Next, rustbuild offers a TOML-based configuration system with a `config.toml` file in the same location as `config.mk`. An example of this configuration can -be found at `src/bootstrap/config.toml.example`, and the configuration file +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). diff --git a/src/bootstrap/config.rs b/src/bootstrap/config.rs index ec57bb069e0a4..c4d5d43152118 100644 --- a/src/bootstrap/config.rs +++ b/src/bootstrap/config.rs @@ -35,7 +35,7 @@ use cache::{INTERNER, Interned}; /// 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 /// each field, see the corresponding fields in -/// `src/bootstrap/config.toml.example`. +/// `config.toml.example`. #[derive(Default)] pub struct Config { pub ccache: Option,