Skip to content

Commit 0269acb

Browse files
committed
Auto merge of #43820 - sfackler:move-config-template, r=alexcrichton
Move config.toml.example to the root dir It's way more discoverable here. r? @alexcrichton
2 parents 045ca8b + 1126a85 commit 0269acb

File tree

5 files changed

+4
-4
lines changed

5 files changed

+4
-4
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Before you can start building the compiler you need to configure the build for
9999
your system. In most cases, that will just mean using the defaults provided
100100
for Rust.
101101

102-
To change configuration, you must copy the file `src/bootstrap/config.toml.example`
102+
To change configuration, you must copy the file `config.toml.example`
103103
to `config.toml` in the directory from which you will be running the build, and
104104
change the settings provided.
105105

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Read ["Installation"] from [The Book].
3939
```
4040

4141
> ***Note:*** Install locations can be adjusted by copying the config file
42-
> from `./src/bootstrap/config.toml.example` to `./config.toml`, and
42+
> from `./config.toml.example` to `./config.toml`, and
4343
> adjusting the `prefix` option under `[install]`. Various other options, such
4444
> as enabling debug information, are also supported, and are documented in
4545
> the config file.
File renamed without changes.

src/bootstrap/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ handled naturally.
8080

8181
Next, rustbuild offers a TOML-based configuration system with a `config.toml`
8282
file in the same location as `config.mk`. An example of this configuration can
83-
be found at `src/bootstrap/config.toml.example`, and the configuration file
83+
be found at `config.toml.example`, and the configuration file
8484
can also be passed as `--config path/to/config.toml` if the build system is
8585
being invoked manually (via the python script).
8686

src/bootstrap/config.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ use cache::{INTERNER, Interned};
3535
/// Note that this structure is not decoded directly into, but rather it is
3636
/// filled out from the decoded forms of the structs below. For documentation
3737
/// each field, see the corresponding fields in
38-
/// `src/bootstrap/config.toml.example`.
38+
/// `config.toml.example`.
3939
#[derive(Default)]
4040
pub struct Config {
4141
pub ccache: Option<String>,

0 commit comments

Comments
 (0)