Move config.toml.example to the root dir

It's way more discoverable here.
This commit is contained in:
Steven Fackler 2017-08-11 22:24:25 -07:00
parent b8266a90b9
commit 1126a85e87
5 changed files with 4 additions and 4 deletions

View File

@ -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 your system. In most cases, that will just mean using the defaults provided
for Rust. 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 to `config.toml` in the directory from which you will be running the build, and
change the settings provided. change the settings provided.

View File

@ -39,7 +39,7 @@ Read ["Installation"] from [The Book].
``` ```
> ***Note:*** Install locations can be adjusted by copying the config file > ***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 > adjusting the `prefix` option under `[install]`. Various other options, such
> as enabling debug information, are also supported, and are documented in > as enabling debug information, are also supported, and are documented in
> the config file. > the config file.

View File

@ -80,7 +80,7 @@ handled naturally.
Next, rustbuild offers a TOML-based configuration system with a `config.toml` 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 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 can also be passed as `--config path/to/config.toml` if the build system is
being invoked manually (via the python script). being invoked manually (via the python script).

View File

@ -35,7 +35,7 @@ use cache::{INTERNER, Interned};
/// Note that this structure is not decoded directly into, but rather it is /// 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 /// filled out from the decoded forms of the structs below. For documentation
/// each field, see the corresponding fields in /// each field, see the corresponding fields in
/// `src/bootstrap/config.toml.example`. /// `config.toml.example`.
#[derive(Default)] #[derive(Default)]
pub struct Config { pub struct Config {
pub ccache: Option<String>, pub ccache: Option<String>,