Skip to content

Commit

Permalink
Move config.toml.example to the root dir
Browse files Browse the repository at this point in the history
It's way more discoverable here.
  • Loading branch information
sfackler committed Aug 12, 2017
1 parent b8266a9 commit 1126a85
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -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.
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion src/bootstrap/README.md
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion src/bootstrap/config.rs
Expand Up @@ -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>,
Expand Down

0 comments on commit 1126a85

Please sign in to comment.