Auto merge of #137081 - Shourya742:2025-02-15-change-config.toml-to-bootstrap.toml, r=onur-ozkan,jieyouxu,kobzol

change config.toml to bootstrap.toml

Currently, both Bootstrap and Cargo uses same name as their configuration file, which can be confusing. This PR is based on a discussion to rename `config.toml` to `bootstrap.toml` for Bootstrap. Closes: #126875.

I have split the PR into atomic commits to make it easier to review. Once the changes are finalized, I will squash them. I am particularly concerned about the changes made to modules that are not part of Bootstrap. How should we handle those changes? Should we ping the respective maintainers?

Author: bors

Diff for: .github/ISSUE_TEMPLATE/bootstrap.md

@@ -32,7 +32,7 @@ Describe what you expected to happen.
 Describe what actually happened.
 -->
 
-### Bootstrap configuration (config.toml)
+### Bootstrap configuration (bootstrap.toml)
 ```toml
 <config>
 ```

Diff for: .gitignore

@@ -1,6 +1,6 @@
 # This file should only ignore things that are generated during a `x.py` build,
 # generated by common IDEs, and optional files controlled by the user that
-# affect the build (such as config.toml).
+# affect the build (such as bootstrap.toml).
 # In particular, things like `mir_dump` should not be listed here; they are only
 # created during manual debugging and many people like to clean up instead of
 # having git ignore such leftovers. You can use `.git/info/exclude` to
@@ -34,6 +34,7 @@ Session.vim
 !/tests/run-make/thumb-none-qemu/example/.cargo
 
 ## Configuration
+/bootstrap.toml
 /config.toml
 /Makefile
 config.mk

Diff for: .ignore

@@ -1,2 +1,3 @@
-# Make vscode *not* count `config.toml` as ignored, so it is included in search
+# Make vscode *not* count `bootstrap.toml` and `config.toml` as ignored, so it is included in search
+!/bootstrap.toml
 !/config.toml

Diff for: INSTALL.md

@@ -6,9 +6,9 @@ If you just want to install Rust, check out the [README.md](README.md) instead.*
 
 The Rust build system uses a Python script called `x.py` to build the compiler,
 which manages the bootstrapping process. It lives at the root of the project.
-It also uses a file named `config.toml` to determine various configuration
+It also uses a file named `bootstrap.toml` to determine various configuration
 settings for the build. You can see a full list of options in
-`config.example.toml`.
+`bootstrap.example.toml`.
 
 The `x.py` command can be run directly on most Unix systems in the following
 format:
@@ -115,15 +115,15 @@ See [the rustc-dev-guide for more info][sysllvm].
 
 This project provides a configure script and makefile (the latter of which just
 invokes `x.py`). `./configure` is the recommended way to programmatically
-generate a `config.toml`. `make` is not recommended (we suggest using `x.py`
+generate a `bootstrap.toml`. `make` is not recommended (we suggest using `x.py`
 directly), but it is supported and we try not to break it unnecessarily.
 
 ```sh
 ./configure
 make && sudo make install
 ```
 
-`configure` generates a `config.toml` which can also be used with normal `x.py`
+`configure` generates a `bootstrap.toml` which can also be used with normal `x.py`
 invocations.
 
 ## Building on Windows
@@ -255,7 +255,7 @@ Windows build triples are:
     - `x86_64-pc-windows-msvc`
 
 The build triple can be specified by either specifying `--build=<triple>` when
-invoking `x.py` commands, or by creating a `config.toml` file (as described in
+invoking `x.py` commands, or by creating a `bootstrap.toml` file (as described in
 [Building on a Unix-like system](#building-on-a-unix-like-system)), and passing
 `--set build.build=<triple>` to `./configure`.
 

Diff for: RELEASES.md

@@ -2282,7 +2282,7 @@ Compatibility Notes
 - [Cargo denies `CARGO_HOME` in the `[env]` configuration table. Cargo itself doesn't pick up this value, but recursive calls to cargo would, which was not intended.](https://github.com/rust-lang/cargo/pull/11644/)
 - [Debuginfo for build dependencies is now off if not explicitly set. This is expected to improve the overall build time.](https://github.com/rust-lang/cargo/pull/11252/)
 - [The Rust distribution no longer always includes rustdoc](https://github.com/rust-lang/rust/pull/106886)
-  If `tools = [...]` is set in config.toml, we will respect a missing rustdoc in that list. By
+  If `tools = [...]` is set in bootstrap.toml, we will respect a missing rustdoc in that list. By
   default rustdoc remains included. To retain the prior behavior explicitly add `"rustdoc"` to the
   list.
 
@@ -5268,7 +5268,7 @@ related tools.
 
 - [Building `rustc` from source now uses `ninja` by default over `make`.][74922]
   You can continue building with `make` by setting `ninja=false` in
-  your `config.toml`.
+  your `bootstrap.toml`.
 - [cg_llvm: `fewer_names` in `uncached_llvm_type`][76030]
 - [Made `ensure_sufficient_stack()` non-generic][76680]
 

Diff for: REUSE.toml

@@ -22,7 +22,7 @@ path = [
     "Cargo.lock",
     "Cargo.toml",
     "CODE_OF_CONDUCT.md",
-    "config.example.toml",
+    "bootstrap.example.toml",
     "configure",
     "CONTRIBUTING.md",
     "COPYRIGHT",

Diff for: config.example.toml renamed to bootstrap.example.toml

@@ -5,7 +5,7 @@
 #
 # All options are commented out by default in this file, and they're commented
 # out with their default values. The build system by default looks for
-# `config.toml` in the current directory of a build for build configuration, but
+# `bootstrap.toml` in the current directory of a build for build configuration, but
 # a custom configuration file can also be specified with `--config` to the build
 # system.
 
@@ -16,7 +16,7 @@
 # Use different pre-set defaults than the global defaults.
 #
 # See `src/bootstrap/defaults` for more information.
-# Note that this has no default value (x.py uses the defaults in `config.example.toml`).
+# Note that this has no default value (x.py uses the defaults in `bootstrap.example.toml`).
 #profile = <none>
 
 # Keeps track of major changes made to this configuration.
@@ -346,7 +346,7 @@
 # Enable a build of the extended Rust tool set which is not only the compiler
 # but also tools such as Cargo. This will also produce "combined installers"
 # which are used to install Rust and Cargo together.
-# The `tools` (check `config.example.toml` to see its default value) option specifies
+# The `tools` (check `bootstrap.example.toml` to see its default value) option specifies
 # which tools should be built if `extended = true`.
 #
 # This is disabled by default.

Diff for: compiler/rustc_session/src/options.rs

@@ -389,7 +389,7 @@ top_level_options!(
         ///
         /// This directory is what the virtual `/rustc/$hash` is translated back to,
         /// if Rust was built with path remapping to `/rustc/$hash` enabled
-        /// (the `rust.remap-debuginfo` option in `config.toml`).
+        /// (the `rust.remap-debuginfo` option in `bootstrap.toml`).
         real_rust_source_base_dir: Option<PathBuf> [TRACKED_NO_CRATE_HASH],
 
         edition: Edition [TRACKED],

Diff for: src/bootstrap/README.md

@@ -163,7 +163,7 @@ compiler, which will then build the bootstrap binary written in Rust.
 
 Because there are two separate codebases behind `x.py`, they need to
 be kept in sync. In particular, both `bootstrap.py` and the bootstrap binary
-parse `config.toml` and read the same command line arguments. `bootstrap.py`
+parse `bootstrap.toml` and read the same command line arguments. `bootstrap.py`
 keeps these in sync by setting various environment variables, and the
 programs sometimes have to add arguments that are explicitly ignored, to be
 read by the other.

Diff for: src/bootstrap/bootstrap.py

@@ -726,7 +726,7 @@ def download_toolchain(self):
 
     def should_fix_bins_and_dylibs(self):
         """Whether or not `fix_bin_or_dylib` needs to be run; can only be True
-        on NixOS or if config.toml has `build.patch-binaries-for-nix` set.
+        on NixOS or if bootstrap.toml has `build.patch-binaries-for-nix` set.
         """
         if self._should_fix_bins_and_dylibs is not None:
             return self._should_fix_bins_and_dylibs
@@ -775,7 +775,7 @@ def get_answer():
                         "The IN_NIX_SHELL environment variable is `{}`;".format(
                             in_nix_shell
                         ),
-                        "you may need to set `patch-binaries-for-nix=true` in config.toml",
+                        "you may need to set `patch-binaries-for-nix=true` in bootstrap.toml",
                     )
 
             return is_nixos
@@ -884,7 +884,7 @@ def bin_root(self):
         return os.path.join(self.build_dir, self.build, subdir)
 
     def get_toml(self, key, section=None):
-        """Returns the value of the given key in config.toml, otherwise returns None
+        """Returns the value of the given key in bootstrap.toml, otherwise returns None
 
         >>> rb = RustBuild()
         >>> rb.config_toml = 'key1 = "value1"\\nkey2 = "value2"'
@@ -1250,17 +1250,23 @@ def bootstrap(args):
             "unless you put them in place manually."
         )
 
-    # Read from `--config`, then `RUST_BOOTSTRAP_CONFIG`, then `./config.toml`,
-    # then `config.toml` in the root directory.
+    # Read from `--config` first, followed by `RUST_BOOTSTRAP_CONFIG`.
+    # If neither is set, check `./bootstrap.toml`, then `bootstrap.toml` in the root directory.
+    # If those are unavailable, fall back to `./config.toml`, then `config.toml` for
+    # backward compatibility.
     toml_path = args.config or os.getenv("RUST_BOOTSTRAP_CONFIG")
     using_default_path = toml_path is None
     if using_default_path:
-        toml_path = "config.toml"
+        toml_path = "bootstrap.toml"
         if not os.path.exists(toml_path):
-            toml_path = os.path.join(rust_root, toml_path)
+            toml_path = os.path.join(rust_root, "bootstrap.toml")
+            if not os.path.exists(toml_path):
+                toml_path = "config.toml"
+                if not os.path.exists(toml_path):
+                    toml_path = os.path.join(rust_root, "config.toml")
 
     # Give a hard error if `--config` or `RUST_BOOTSTRAP_CONFIG` are set to a missing path,
-    # but not if `config.toml` hasn't been created.
+    # but not if `bootstrap.toml` hasn't been created.
     if not using_default_path or os.path.exists(toml_path):
         with open(toml_path) as config:
             config_toml = config.read()
@@ -1278,7 +1284,9 @@ def bootstrap(args):
         # profiles to be renamed while maintaining back compatibility
         # Keep in sync with `profile_aliases` in config.rs
         profile_aliases = {"user": "dist"}
-        include_file = "config.{}.toml".format(profile_aliases.get(profile) or profile)
+        include_file = "bootstrap.{}.toml".format(
+            profile_aliases.get(profile) or profile
+        )
         include_dir = os.path.join(rust_root, "src", "bootstrap", "defaults")
         include_path = os.path.join(include_dir, include_file)
 

Diff for: src/bootstrap/bootstrap_test.py

@@ -156,7 +156,7 @@ def test_known_args(self):
 
 
 class GenerateAndParseConfig(unittest.TestCase):
-    """Test that we can serialize and deserialize a config.toml file"""
+    """Test that we can serialize and deserialize a bootstrap.toml file"""
 
     def test_no_args(self):
         build = serialize_and_parse([])
@@ -206,11 +206,11 @@ def build_args(self, configure_args=None, args=None, env=None):
         # problem in most cases, but there is a scenario where it would cause
         # the test to fail.
         #
-        # When a custom local Cargo is configured in config.toml (with the
+        # When a custom local Cargo is configured in bootstrap.toml (with the
         # build.cargo setting), no Cargo is downloaded to any location known by
         # bootstrap, and bootstrap relies on that setting to find it.
         #
-        # In this test though we are not using the config.toml of the caller:
+        # In this test though we are not using the bootstrap.toml of the caller:
         # we are generating a blank one instead. If we don't set build.cargo in
         # it, the test will have no way to find Cargo, failing the test.
         cargo_bin = os.environ.get("BOOTSTRAP_TEST_CARGO_BIN")

Diff for: src/bootstrap/configure.py

@@ -367,8 +367,8 @@ def is_value_list(key):
             print("\t\t" + option.desc)
     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.example.toml` next to this configure script to see")
+    print("configuration system, `bootstrap.toml`. You can explore the comments")
+    print("in `bootstrap.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")
@@ -567,8 +567,8 @@ def apply_args(known_args, option_checking, config):
             raise RuntimeError("unhandled option {}".format(option.name))
 
 
-# "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
+# "Parse" the `bootstrap.example.toml` file into the various sections, and we'll
+# use this as a template of a `bootstrap.toml` to write out which preserves
 # all the various comments and whatnot.
 #
 # Note that the `target` section is handled separately as we'll duplicate it
@@ -581,7 +581,7 @@ def parse_example_config(known_args, config):
     targets = {}
     top_level_keys = []
 
-    with open(rust_dir + "/config.example.toml") as example_config:
+    with open(rust_dir + "/bootstrap.example.toml") as example_config:
         example_lines = example_config.read().split("\n")
     for line in example_lines:
         if cur_section is None:
@@ -755,8 +755,8 @@ def quit_if_file_exists(file):
 
 
 if __name__ == "__main__":
-    # If 'config.toml' already exists, exit the script at this point
-    quit_if_file_exists("config.toml")
+    # If 'bootstrap.toml' already exists, exit the script at this point
+    quit_if_file_exists("bootstrap.toml")
 
     if "GITHUB_ACTIONS" in os.environ:
         print("::group::Configure the build")
@@ -766,11 +766,11 @@ def quit_if_file_exists(file):
     p("")
     section_order, sections, targets = parse_args(sys.argv[1:])
 
-    # Now that we've built up our `config.toml`, write it all out in the same
+    # Now that we've built up our `bootstrap.toml`, write it all out in the same
     # order that we read it in.
     p("")
-    p("writing `config.toml` in current directory")
-    with bootstrap.output("config.toml") as f:
+    p("writing `bootstrap.toml` in current directory")
+    with bootstrap.output("bootstrap.toml") as f:
         write_config_toml(f, section_order, targets, sections)
 
     with bootstrap.output("Makefile") as f:

Diff for: src/bootstrap/defaults/config.compiler.toml renamed to src/bootstrap/defaults/bootstrap.compiler.toml

@@ -77,14 +77,14 @@ fn main() {
             check_version(&config)
         };
 
-    // NOTE: Since `./configure` generates a `config.toml`, distro maintainers will see the
+    // NOTE: Since `./configure` generates a `bootstrap.toml`, distro maintainers will see the
     // changelog warning, not the `x.py setup` message.
     let suggest_setup = config.config.is_none() && !matches!(config.cmd, Subcommand::Setup { .. });
     if suggest_setup {
-        println!("WARNING: you have not made a `config.toml`");
+        println!("WARNING: you have not made a `bootstrap.toml`");
         println!(
-            "HELP: consider running `./x.py setup` or copying `config.example.toml` by running \
-            `cp config.example.toml config.toml`"
+            "HELP: consider running `./x.py setup` or copying `bootstrap.example.toml` by running \
+            `cp bootstrap.example.toml bootstrap.toml`"
         );
     } else if let Some(suggestion) = &changelog_suggestion {
         println!("{suggestion}");
@@ -98,10 +98,10 @@ fn main() {
     Build::new(config).build();
 
     if suggest_setup {
-        println!("WARNING: you have not made a `config.toml`");
+        println!("WARNING: you have not made a `bootstrap.toml`");
         println!(
-            "HELP: consider running `./x.py setup` or copying `config.example.toml` by running \
-            `cp config.example.toml config.toml`"
+            "HELP: consider running `./x.py setup` or copying `bootstrap.example.toml` by running \
+            `cp bootstrap.example.toml bootstrap.toml`"
         );
     } else if let Some(suggestion) = &changelog_suggestion {
         println!("{suggestion}");
@@ -160,7 +160,7 @@ fn check_version(config: &Config) -> Option<String> {
         }
 
         // Always try to use `change-id` from .last-warned-change-id first. If it doesn't exist,
-        // then use the one from the config.toml. This way we never show the same warnings
+        // then use the one from the bootstrap.toml. This way we never show the same warnings
         // more than once.
         if let Ok(t) = fs::read_to_string(&warned_id_path) {
             let last_warned_id = usize::from_str(&t)
@@ -185,16 +185,18 @@ fn check_version(config: &Config) -> Option<String> {
 
         msg.push_str("NOTE: to silence this warning, ");
         msg.push_str(&format!(
-            "update `config.toml` to use `change-id = {latest_change_id}` instead"
+            "update `bootstrap.toml` to use `change-id = {latest_change_id}` instead"
         ));
 
         if io::stdout().is_terminal() {
             t!(fs::write(warned_id_path, latest_change_id.to_string()));
         }
     } else {
-        msg.push_str("WARNING: The `change-id` is missing in the `config.toml`. This means that you will not be able to track the major changes made to the bootstrap configurations.\n");
+        msg.push_str("WARNING: The `change-id` is missing in the `bootstrap.toml`. This means that you will not be able to track the major changes made to the bootstrap configurations.\n");
         msg.push_str("NOTE: to silence this warning, ");
-        msg.push_str(&format!("add `change-id = {latest_change_id}` at the top of `config.toml`"));
+        msg.push_str(&format!(
+            "add `change-id = {latest_change_id}` at the top of `bootstrap.toml`"
+        ));
     };
 
     Some(msg)

Diff for: src/bootstrap/defaults/config.dist.toml renamed to src/bootstrap/defaults/bootstrap.dist.toml

@@ -425,7 +425,7 @@ fn copy_self_contained_objects(
     } else if target.contains("-wasi") {
         let srcdir = builder.wasi_libdir(target).unwrap_or_else(|| {
             panic!(
-                "Target {:?} does not have a \"wasi-root\" key in Config.toml \
+                "Target {:?} does not have a \"wasi-root\" key in bootstrap.toml \
                     or `$WASI_SDK_PATH` set",
                 target.triple
             )
@@ -1294,7 +1294,7 @@ pub fn rustc_cargo_env(
         .env("CFG_VERSION", builder.rust_version());
 
     // Some tools like Cargo detect their own git information in build scripts. When omit-git-hash
-    // is enabled in config.toml, we pass this environment variable to tell build scripts to avoid
+    // is enabled in bootstrap.toml, we pass this environment variable to tell build scripts to avoid
     // detecting git information on their own.
     if builder.config.omit_git_hash {
         cargo.env("CFG_OMIT_GIT_HASH", "1");
@@ -1538,7 +1538,7 @@ fn is_codegen_cfg_needed(path: &TaskPath, run: &RunConfig<'_>) -> bool {
         {
             run.builder.info(
                 "WARNING: no codegen-backends config matched the requested path to build a codegen backend. \
-                HELP: add backend to codegen-backends in config.toml.",
+                HELP: add backend to codegen-backends in bootstrap.toml.",
             );
             return true;
         }
@@ -1550,7 +1550,7 @@ fn is_codegen_cfg_needed(path: &TaskPath, run: &RunConfig<'_>) -> bool {
 impl Step for CodegenBackend {
     type Output = ();
     const ONLY_HOSTS: bool = true;
-    /// Only the backends specified in the `codegen-backends` entry of `config.toml` are built.
+    /// Only the backends specified in the `codegen-backends` entry of `bootstrap.toml` are built.
     const DEFAULT: bool = true;
 
     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {

Diff for: src/bootstrap/defaults/config.library.toml renamed to src/bootstrap/defaults/bootstrap.library.toml

@@ -1000,9 +1000,9 @@ impl Step for PlainSourceTarball {
         let src_files = [
             // tidy-alphabetical-start
             ".gitmodules",
+            "bootstrap.example.toml",
             "Cargo.lock",
             "Cargo.toml",
-            "config.example.toml",
             "configure",
             "CONTRIBUTING.md",
             "COPYRIGHT",