Skip to content

Commit 4819270

Browse files
onur-ozkanonur-ozkan
committed
use "bootstrap" instead of "rustbuild" in comments and docs
Signed-off-by: onur-ozkan <[email protected]>
1 parent 51917e2 commit 4819270

File tree

26 files changed

+44
-45
lines changed

26 files changed

+44
-45
lines changed

‎INSTALL.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ python x.py build
215215

216216
Right now, building Rust only works with some known versions of Visual Studio.
217217
If you have a more recent version installed and the build system doesn't
218-
understand, you may need to force rustbuild to use an older version.
218+
understand, you may need to force bootstrap to use an older version.
219219
This can be done by manually calling the appropriate vcvars file before running
220220
the bootstrap.
221221

‎compiler/rustc_codegen_ssa/src/back/linker.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ impl<'a> GccLinker<'a> {
398398
self.link_arg("-dylib");
399399

400400
// Note that the `osx_rpath_install_name` option here is a hack
401-
// purely to support rustbuild right now, we should get a more
401+
// purely to support bootstrap right now, we should get a more
402402
// principled solution at some point to force the compiler to pass
403403
// the right `-Wl,-install_name` with an `@rpath` in it.
404404
if self.sess.opts.cg.rpath || self.sess.opts.unstable_opts.osx_rpath_install_name {

‎compiler/rustc_session/src/config.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2620,7 +2620,7 @@ pub fn build_session_options(early_dcx: &mut EarlyDiagCtxt, matches: &getopts::M
26202620
// This is the location used by the `rust-src` `rustup` component.
26212621
let mut candidate = sysroot.join("lib/rustlib/src/rust");
26222622
if let Ok(metadata) = candidate.symlink_metadata() {
2623-
// Replace the symlink rustbuild creates, with its destination.
2623+
// Replace the symlink bootstrap creates, with its destination.
26242624
// We could try to use `fs::canonicalize` instead, but that might
26252625
// produce unnecessarily verbose path.
26262626
if metadata.file_type().is_symlink() {

‎config.example.toml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Sample TOML configuration file for building Rust.
22
#
3-
# To configure rustbuild, run `./configure` or `./x.py setup`.
3+
# To configure bootstrap, run `./configure` or `./x.py setup`.
44
# See https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html#create-a-configtoml for more information.
55
#
66
# All options are commented out by default in this file, and they're commented
@@ -109,7 +109,7 @@
109109
# increases the size of binaries and consequently the memory required by
110110
# each linker process.
111111
# If set to 0, linker invocations are treated like any other job and
112-
# controlled by rustbuild's -j parameter.
112+
# controlled by bootstrap's -j parameter.
113113
#link-jobs = 0
114114

115115
# Whether to build LLVM as a dynamically linked library (as opposed to statically linked).
@@ -371,11 +371,11 @@
371371
# Useful for modifying only the stage2 compiler without having to pass `--keep-stage 0` each time.
372372
#local-rebuild = false
373373

374-
# Print out how long each rustbuild step took (mostly intended for CI and
374+
# Print out how long each bootstrap step took (mostly intended for CI and
375375
# tracking over time)
376376
#print-step-timings = false
377377

378-
# Print out resource usage data for each rustbuild step, as defined by the Unix
378+
# Print out resource usage data for each bootstrap step, as defined by the Unix
379379
# struct rusage. (Note that this setting is completely unstable: the data it
380380
# captures, what platforms it supports, the format of its associated output, and
381381
# this setting's very existence, are all subject to change.)

‎src/bootstrap/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# rustbuild - Bootstrapping Rust
1+
# Bootstrapping Rust
22

33
This README is aimed at helping to explain how Rust is bootstrapped,
4-
and some of the technical details of the build system.
4+
and some of the technical details of the bootstrap build system.
55

66
Note that this README only covers internal information, not how to use the tool.
77
Please check [bootstrapping dev guide][bootstrapping-dev-guide] for further information.
@@ -12,17 +12,17 @@ Please check [bootstrapping dev guide][bootstrapping-dev-guide] for further info
1212

1313
The build system defers most of the complicated logic of managing invocations
1414
of rustc and rustdoc to Cargo itself. However, moving through various stages
15-
and copying artifacts is still necessary for it to do. Each time rustbuild
15+
and copying artifacts is still necessary for it to do. Each time bootstrap
1616
is invoked, it will iterate through the list of predefined steps and execute
1717
each serially in turn if it matches the paths passed or is a default rule.
18-
For each step, rustbuild relies on the step internally being incremental and
19-
parallel. Note, though, that the `-j` parameter to rustbuild gets forwarded
18+
For each step, bootstrap relies on the step internally being incremental and
19+
parallel. Note, though, that the `-j` parameter to bootstrap gets forwarded
2020
to appropriate test harnesses and such.
2121

2222
## Build phases
2323

24-
The rustbuild build system goes through a few phases to actually build the
25-
compiler. What actually happens when you invoke rustbuild is:
24+
Bootstrap build system goes through a few phases to actually build the
25+
compiler. What actually happens when you invoke bootstrap is:
2626

2727
1. The entry point script (`x` for unix like systems, `x.ps1` for windows systems,
2828
`x.py` cross-platform) is run. This script is responsible for downloading the stage0
@@ -151,9 +151,9 @@ build/
151151
stage3/
152152
```
153153

154-
## Extending rustbuild
154+
## Extending bootstrap
155155

156-
When you use the bootstrap system, you'll call it through the entry point script
156+
When you use bootstrap, you'll call it through the entry point script
157157
(`x`, `x.ps1`, or `x.py`). However, most of the code lives in `src/bootstrap`.
158158
`bootstrap` has a difficult problem: it is written in Rust, but yet it is run
159159
before the Rust compiler is built! To work around this, there are two components

‎src/bootstrap/bootstrap.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1038,7 +1038,7 @@ def build_triple(self):
10381038

10391039
def check_vendored_status(self):
10401040
"""Check that vendoring is configured properly"""
1041-
# keep this consistent with the equivalent check in rustbuild:
1041+
# keep this consistent with the equivalent check in bootstrap:
10421042
# https://github.com/rust-lang/rust/blob/a8a33cf27166d3eabaffc58ed3799e054af3b0c6/src/bootstrap/lib.rs#L399-L405
10431043
if 'SUDO_USER' in os.environ and not self.use_vendored_sources:
10441044
if os.getuid() == 0:

‎src/bootstrap/mk/Makefile.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ all:
2020
$(Q)$(BOOTSTRAP) doc --stage 2 $(BOOTSTRAP_ARGS)
2121

2222
help:
23-
$(Q)echo 'Welcome to the rustbuild build system!'
23+
$(Q)echo 'Welcome to bootstrap, the Rust build system!'
2424
$(Q)echo
2525
$(Q)echo This makefile is a thin veneer over the ./x.py script located
2626
$(Q)echo in this directory. To get the full power of the build system

‎src/bootstrap/src/bin/main.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! rustbuild, the Rust build system
1+
//! bootstrap, the Rust build system
22
//!
33
//! This is the entry point for the build system used to compile the `rustc`
44
//! compiler. Lots of documentation can be found in the `README.md` file in the

‎src/bootstrap/src/core/build_steps/compile.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//! Implementation of compiling various phases of the compiler and standard
22
//! library.
33
//!
4-
//! This module contains some of the real meat in the rustbuild build system
4+
//! This module contains some of the real meat in the bootstrap build system
55
//! which is where Cargo is used to compile the standard library, libtest, and
66
//! the compiler. This module is also responsible for assembling the sysroot as it
77
//! goes along from the output of the previous stage.
@@ -819,8 +819,8 @@ pub struct Rustc {
819819
pub compiler: Compiler,
820820
/// Whether to build a subset of crates, rather than the whole compiler.
821821
///
822-
/// This should only be requested by the user, not used within rustbuild itself.
823-
/// Using it within rustbuild can lead to confusing situation where lints are replayed
822+
/// This should only be requested by the user, not used within bootstrap itself.
823+
/// Using it within bootstrap can lead to confusing situation where lints are replayed
824824
/// in two different steps.
825825
crates: Vec<String>,
826826
}

‎src/bootstrap/src/core/build_steps/doc.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Documentation generation for rustbuilder.
1+
//! Documentation generation for bootstrap.
22
//!
33
//! This module implements generation for all bits and pieces of documentation
44
//! for the Rust project. This notably includes suites like the rust book, the

‎src/bootstrap/src/core/build_steps/test.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2993,7 +2993,7 @@ impl Step for Bootstrap {
29932993
// https://github.com/rust-lang/rust/issues/49215
29942994
cmd.env("RUSTFLAGS", flags);
29952995
}
2996-
// rustbuild tests are racy on directory creation so just run them one at a time.
2996+
// bootstrap tests are racy on directory creation so just run them one at a time.
29972997
// Since there's not many this shouldn't be a problem.
29982998
run_cargo_test(cmd, &["--test-threads=1"], &[], "bootstrap", None, compiler, host, builder);
29992999
}

‎src/bootstrap/src/core/builder.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1627,11 +1627,11 @@ impl<'a> Builder<'a> {
16271627
}
16281628

16291629
// This tells Cargo (and in turn, rustc) to output more complete
1630-
// dependency information. Most importantly for rustbuild, this
1630+
// dependency information. Most importantly for bootstrap, this
16311631
// includes sysroot artifacts, like libstd, which means that we don't
1632-
// need to track those in rustbuild (an error prone process!). This
1632+
// need to track those in bootstrap (an error prone process!). This
16331633
// feature is currently unstable as there may be some bugs and such, but
1634-
// it represents a big improvement in rustbuild's reliability on
1634+
// it represents a big improvement in bootstrap's reliability on
16351635
// rebuilds, so we're using it here.
16361636
//
16371637
// For some additional context, see #63470 (the PR originally adding
@@ -1643,7 +1643,7 @@ impl<'a> Builder<'a> {
16431643
// Restrict the allowed features so we don't depend on nightly
16441644
// accidentally.
16451645
//
1646-
// binary-dep-depinfo is used by rustbuild itself for all
1646+
// binary-dep-depinfo is used by bootstrap itself for all
16471647
// compilations.
16481648
//
16491649
// Lots of tools depend on proc_macro2 and proc-macro-error.

‎src/bootstrap/src/core/builder/tests.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ mod defaults {
266266
// rustdoc/rustcc/std here (the user only requested a host=B build, so
267267
// there's not really a need for us to build for target A in this case
268268
// (since we're producing stage 1 libraries/binaries). But currently
269-
// rustbuild is just a bit buggy here; this should be fixed though.
269+
// bootstrap is just a bit buggy here; this should be fixed though.
270270
assert_eq!(
271271
first(cache.all::<compile::Std>()),
272272
&[

‎src/bootstrap/src/core/config/config.rs

+2-3
Original file line numberDiff line numberDiff line change
@@ -658,8 +658,7 @@ impl Merge for TomlConfig {
658658
}
659659
}
660660

661-
// We are using a decl macro instead of a derive proc macro here to reduce the compile time of
662-
// rustbuild.
661+
// We are using a decl macro instead of a derive proc macro here to reduce the compile time of bootstrap.
663662
macro_rules! define_config {
664663
($(#[$attr:meta])* struct $name:ident {
665664
$($field:ident: Option<$field_ty:ty> = $field_key:literal,)*
@@ -704,7 +703,7 @@ macro_rules! define_config {
704703

705704
// The following is a trimmed version of what serde_derive generates. All parts not relevant
706705
// for toml deserialization have been removed. This reduces the binary size and improves
707-
// compile time of rustbuild.
706+
// compile time of bootstrap.
708707
impl<'de> Deserialize<'de> for $name {
709708
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
710709
where

‎src/bootstrap/src/core/config/flags.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Command-line interface of the rustbuild build system.
1+
//! Command-line interface of the bootstrap build system.
22
//!
33
//! This module implements the command-line parsing of the build system which
44
//! has various flags to configure how it's run.

‎src/bootstrap/src/core/sanity.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Sanity checking performed by rustbuild before actually executing anything.
1+
//! Sanity checking performed by bootstrap before actually executing anything.
22
//!
33
//! This module contains the implementation of ensuring that the build
44
//! environment looks reasonable before progressing. This will verify that

‎src/bootstrap/src/lib.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
//! Implementation of rustbuild, the Rust build system.
1+
//! Implementation of bootstrap, the Rust build system.
22
//!
33
//! This module, and its descendants, are the implementation of the Rust build
44
//! system. Most of this build system is backed by Cargo but the outer layer
55
//! here serves as the ability to orchestrate calling Cargo, sequencing Cargo
6-
//! builds, building artifacts like LLVM, etc. The goals of rustbuild are:
6+
//! builds, building artifacts like LLVM, etc. The goals of bootstrap are:
77
//!
88
//! * To be an easily understandable, easily extensible, and maintainable build
99
//! system.

‎src/bootstrap/src/utils/helpers.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Various utility functions used throughout rustbuild.
1+
//! Various utility functions used throughout bootstrap.
22
//!
33
//! Simple things like testing the various filesystem operations here and there,
44
//! not a lot of interesting happenings here unfortunately.

‎src/ci/scripts/install-clang.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ if isMacOS; then
4040
# our own clang can figure out the correct include path on its own.
4141
ciCommandSetEnv SDKROOT "$(xcrun --sdk macosx --show-sdk-path)"
4242

43-
# Configure `AR` specifically so rustbuild doesn't try to infer it as
43+
# Configure `AR` specifically so bootstrap doesn't try to infer it as
4444
# `clang-ar` by accident.
4545
ciCommandSetEnv AR "ar"
4646
elif isWindows && ! isKnownToBeMingwBuild; then

‎src/doc/rustc/src/platform-support/x86_64-fortanix-unknown-sgx.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ on how to setup a development and runtime environment.
4646

4747
As a tier 2 target, the target is built by the Rust project.
4848

49-
You can configure rustbuild like so:
49+
You can configure bootstrap like so:
5050

5151
```toml
5252
[build]

‎src/tools/build_helper/src/ci.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ impl CiEnv {
2525
/// If in a CI environment, forces the command to run with colors.
2626
pub fn force_coloring_in_ci(self, cmd: &mut Command) {
2727
if self != CiEnv::None {
28-
// Due to use of stamp/docker, the output stream of rustbuild is not
28+
// Due to use of stamp/docker, the output stream of bootstrap is not
2929
// a TTY in CI, so coloring is by-default turned off.
3030
// The explicit `TERM=xterm` environment is needed for
3131
// `--color always` to actually work. This env var was lost when

‎src/tools/lint-docs/src/groups.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ impl<'a> LintExtractor<'a> {
3737
.map_err(|e| format!("could not read {}: {}", groups_path.display(), e))?;
3838
let new_contents =
3939
contents.replace("{{groups-table}}", &self.make_groups_table(lints, &groups)?);
40-
// Delete the output because rustbuild uses hard links in its copies.
40+
// Delete the output because bootstrap uses hard links in its copies.
4141
let _ = fs::remove_file(&groups_path);
4242
fs::write(&groups_path, new_contents)
4343
.map_err(|e| format!("could not write to {}: {}", groups_path.display(), e))?;

‎src/tools/lint-docs/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@ impl<'a> LintExtractor<'a> {
532532
}
533533
add_rename_redirect(level, &mut result);
534534
let out_path = self.out_path.join("listing").join(level.doc_filename());
535-
// Delete the output because rustbuild uses hard links in its copies.
535+
// Delete the output because bootstrap uses hard links in its copies.
536536
let _ = fs::remove_file(&out_path);
537537
fs::write(&out_path, result)
538538
.map_err(|e| format!("could not write to {}: {}", out_path.display(), e))?;

‎src/tools/rust-analyzer/crates/rust-analyzer/src/version.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ pub struct VersionInfo {
1515
pub version: &'static str,
1616
/// The release channel we were built for (stable/beta/nightly/dev).
1717
///
18-
/// `None` if not built via rustbuild.
18+
/// `None` if not built via bootstrap.
1919
pub release_channel: Option<&'static str>,
2020
/// Information about the Git repository we may have been built from.
2121
///

‎src/tools/rust-installer/src/combiner.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ impl Combiner {
109109
.with_context(|| format!("failed to read components in '{}'", input_tarball))?;
110110
for component in pkg_components.split_whitespace() {
111111
// All we need to do is copy the component directory. We could
112-
// move it, but rustbuild wants to reuse the unpacked package
112+
// move it, but bootstrap wants to reuse the unpacked package
113113
// dir for OS-specific installers on macOS and Windows.
114114
let component_dir = package_dir.join(component);
115115
create_dir(&component_dir)?;

‎src/tools/rust-installer/test.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -974,7 +974,7 @@ combined_remains() {
974974
--package-name=rust \
975975
--input-tarballs="$OUT_DIR/rustc.tar.gz,$OUT_DIR/cargo.tar.gz,$OUT_DIR/rust-docs.tar.gz"
976976
for component in rustc cargo rust-docs; do
977-
# rustbuild wants the original extracted package intact too
977+
# bootstrap wants the original extracted package intact too
978978
try test -d "$WORK_DIR/$component/$component"
979979
try test -d "$WORK_DIR/rust/$component"
980980
done

0 commit comments

Comments
 (0)