Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit 1d59d22

Browse files
Rollup merge of rust-lang#127434 - onur-ozkan:use-bootstrap-instead-of-rustbuild, r=Mark-Simulacrum
use "bootstrap" instead of "rustbuild" in comments and docs Let's stick with the single name "bootstrap" to refer to the bootstrap project to avoid confusion. This should make it clearer, especially for new contributors.
2 parents 4c493db + 4819270 commit 1d59d22

File tree

26 files changed

+44
-45
lines changed

26 files changed

+44
-45
lines changed

INSTALL.md

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 4 additions & 4 deletions
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

Lines changed: 9 additions & 9 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 3 additions & 3 deletions
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.
@@ -818,8 +818,8 @@ pub struct Rustc {
818818
pub compiler: Compiler,
819819
/// Whether to build a subset of crates, rather than the whole compiler.
820820
///
821-
/// This should only be requested by the user, not used within rustbuild itself.
822-
/// Using it within rustbuild can lead to confusing situation where lints are replayed
821+
/// This should only be requested by the user, not used within bootstrap itself.
822+
/// Using it within bootstrap can lead to confusing situation where lints are replayed
823823
/// in two different steps.
824824
crates: Vec<String>,
825825
}

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

Lines changed: 1 addition & 1 deletion
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

0 commit comments

Comments
 (0)