Rename config.toml.example
to config.example.toml
This commit is contained in:
parent
8a73f50d87
commit
fcb2a3665f
1
.gitattributes
vendored
1
.gitattributes
vendored
@ -9,7 +9,6 @@
|
||||
src/etc/installer/gfx/* binary
|
||||
src/vendor/** -text
|
||||
Cargo.lock linguist-generated=false
|
||||
config.toml.example linguist-language=TOML
|
||||
|
||||
# Older git versions try to fix line endings on images and fonts, this prevents it.
|
||||
*.png binary
|
||||
|
@ -16,7 +16,7 @@ Files: compiler/*
|
||||
Cargo.lock
|
||||
Cargo.toml
|
||||
CODE_OF_CONDUCT.md
|
||||
config.toml.example
|
||||
config.example.toml
|
||||
configure
|
||||
CONTRIBUTING.md
|
||||
COPYRIGHT
|
||||
|
@ -99,7 +99,7 @@ See [the rustc-dev-guide for more info][sysllvm].
|
||||
The Rust build system uses a file named `config.toml` in the root of the
|
||||
source tree to determine various configuration settings for the build.
|
||||
Set up the defaults intended for distros to get started. You can see a full
|
||||
list of options in `config.toml.example`.
|
||||
list of options in `config.example.toml`.
|
||||
|
||||
```sh
|
||||
printf 'profile = "user" \nchangelog-seen = 2 \n' > config.toml
|
||||
|
@ -185,7 +185,7 @@ Some general areas that you may be interested in modifying are:
|
||||
If you make a major change, please remember to:
|
||||
|
||||
+ Update `VERSION` in `src/bootstrap/main.rs`.
|
||||
* Update `changelog-seen = N` in `config.toml.example`.
|
||||
* Update `changelog-seen = N` in `config.example.toml`.
|
||||
* Add an entry in `src/bootstrap/CHANGELOG.md`.
|
||||
|
||||
A 'major change' includes
|
||||
|
@ -44,8 +44,8 @@ fn main() {
|
||||
if suggest_setup {
|
||||
println!("warning: you have not made a `config.toml`");
|
||||
println!(
|
||||
"help: consider running `./x.py setup` or copying `config.toml.example` by running \
|
||||
`cp config.toml.example config.toml`"
|
||||
"help: consider running `./x.py setup` or copying `config.example.toml` by running \
|
||||
`cp config.example.toml config.toml`"
|
||||
);
|
||||
} else if let Some(suggestion) = &changelog_suggestion {
|
||||
println!("{}", suggestion);
|
||||
@ -57,8 +57,8 @@ fn main() {
|
||||
if suggest_setup {
|
||||
println!("warning: you have not made a `config.toml`");
|
||||
println!(
|
||||
"help: consider running `./x.py setup` or copying `config.toml.example` by running \
|
||||
`cp config.toml.example config.toml`"
|
||||
"help: consider running `./x.py setup` or copying `config.example.toml` by running \
|
||||
`cp config.example.toml config.toml`"
|
||||
);
|
||||
} else if let Some(suggestion) = &changelog_suggestion {
|
||||
println!("{}", suggestion);
|
||||
|
@ -55,7 +55,7 @@ pub enum DryRun {
|
||||
/// 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
|
||||
/// `config.toml.example`.
|
||||
/// `config.example.toml`.
|
||||
#[derive(Default)]
|
||||
#[cfg_attr(test, derive(Clone))]
|
||||
pub struct Config {
|
||||
@ -325,7 +325,7 @@ fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||
|
||||
impl SplitDebuginfo {
|
||||
/// Returns the default `-Csplit-debuginfo` value for the current target. See the comment for
|
||||
/// `rust.split-debuginfo` in `config.toml.example`.
|
||||
/// `rust.split-debuginfo` in `config.example.toml`.
|
||||
fn default_for_platform(target: &str) -> Self {
|
||||
if target.contains("apple") {
|
||||
SplitDebuginfo::Unpacked
|
||||
|
@ -194,7 +194,7 @@ if '--help' in sys.argv or '-h' in sys.argv:
|
||||
print('')
|
||||
print('This configure script is a thin configuration shim over the true')
|
||||
print('configuration system, `config.toml`. You can explore the comments')
|
||||
print('in `config.toml.example` next to this configure script to see')
|
||||
print('in `config.example.toml` next to this configure script to see')
|
||||
print('more information about what each option is. Additionally you can')
|
||||
print('pass `--set` as an argument to set arbitrary key/value pairs')
|
||||
print('in the TOML configuration if desired')
|
||||
@ -367,7 +367,7 @@ for key in known_args:
|
||||
|
||||
set('build.configure-args', sys.argv[1:])
|
||||
|
||||
# "Parse" the `config.toml.example` file into the various sections, and we'll
|
||||
# "Parse" the `config.example.toml` file into the various sections, and we'll
|
||||
# use this as a template of a `config.toml` to write out which preserves
|
||||
# all the various comments and whatnot.
|
||||
#
|
||||
@ -380,7 +380,7 @@ section_order = [None]
|
||||
targets = {}
|
||||
top_level_keys = []
|
||||
|
||||
for line in open(rust_dir + '/config.toml.example').read().split("\n"):
|
||||
for line in open(rust_dir + '/config.example.toml').read().split("\n"):
|
||||
if cur_section == None:
|
||||
if line.count('=') == 1:
|
||||
top_level_key = line.split('=')[0]
|
||||
|
@ -967,7 +967,7 @@ fn run(self, builder: &Builder<'_>) -> GeneratedTarball {
|
||||
"RELEASES.md",
|
||||
"configure",
|
||||
"x.py",
|
||||
"config.toml.example",
|
||||
"config.example.toml",
|
||||
"Cargo.toml",
|
||||
"Cargo.lock",
|
||||
];
|
||||
|
@ -286,7 +286,7 @@ fn run(self, builder: &Builder<'_>) -> LlvmResult {
|
||||
(true, true) => "RelWithDebInfo",
|
||||
};
|
||||
|
||||
// NOTE: remember to also update `config.toml.example` when changing the
|
||||
// NOTE: remember to also update `config.example.toml` when changing the
|
||||
// defaults!
|
||||
let llvm_targets = match &builder.config.llvm_targets {
|
||||
Some(s) => s,
|
||||
|
@ -31,7 +31,7 @@ Rust's source-based code coverage requires the Rust "profiler runtime". Without
|
||||
|
||||
The Rust `nightly` distribution channel includes the profiler runtime, by default.
|
||||
|
||||
> **Important**: If you are building the Rust compiler from the source distribution, the profiler runtime is _not_ enabled in the default `config.toml.example`. Edit your `config.toml` file and ensure the `profiler` feature is set it to `true` (either under the `[build]` section, or under the settings for an individual `[target.<triple>]`):
|
||||
> **Important**: If you are building the Rust compiler from the source distribution, the profiler runtime is _not_ enabled in the default `config.example.toml`. Edit your `config.toml` file and ensure the `profiler` feature is set it to `true` (either under the `[build]` section, or under the settings for an individual `[target.<triple>]`):
|
||||
>
|
||||
> ```toml
|
||||
> # Build the profiler runtime (required when compiling with options that depend
|
||||
|
@ -185,7 +185,7 @@ trigger_files = [
|
||||
"src/tools/x",
|
||||
"configure",
|
||||
"Cargo.toml",
|
||||
"config.toml.example",
|
||||
"config.example.toml",
|
||||
"src/stage0.json"
|
||||
]
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user