diff options
| author | Steven Fackler <sfackler@gmail.com> | 2017-08-11 22:24:25 -0700 |
|---|---|---|
| committer | Steven Fackler <sfackler@gmail.com> | 2017-08-11 22:24:25 -0700 |
| commit | 1126a85e87629f7ec37fc6c4fde43419f4b9947f (patch) | |
| tree | e72178a890c63a3d3f20e356f683040ea38ddfd5 | |
| parent | b8266a90b9ffee04c1e4a33ec02a47b1299f1180 (diff) | |
| download | rust-1126a85e87629f7ec37fc6c4fde43419f4b9947f.tar.gz rust-1126a85e87629f7ec37fc6c4fde43419f4b9947f.zip | |
Move config.toml.example to the root dir
It's way more discoverable here.
| -rw-r--r-- | CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | config.toml.example (renamed from src/bootstrap/config.toml.example) | 0 | ||||
| -rw-r--r-- | src/bootstrap/README.md | 2 | ||||
| -rw-r--r-- | src/bootstrap/config.rs | 2 |
5 files changed, 4 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 04b6fea75a7..5b325110d38 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 a1f01861075..b6ff6df0aec 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 index 19678dc7793..19678dc7793 100644 --- a/src/bootstrap/config.toml.example +++ b/config.toml.example diff --git a/src/bootstrap/README.md b/src/bootstrap/README.md index 1ce99eb893e..65c1088f547 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 ec57bb069e0..c4d5d431521 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<String>, |
