summaryrefslogtreecommitdiffstats
path: root/compiler/rustc_codegen_cranelift/build_system/usage.txt
diff options
context:
space:
mode:
Diffstat (limited to 'compiler/rustc_codegen_cranelift/build_system/usage.txt')
-rw-r--r--compiler/rustc_codegen_cranelift/build_system/usage.txt34
1 files changed, 24 insertions, 10 deletions
diff --git a/compiler/rustc_codegen_cranelift/build_system/usage.txt b/compiler/rustc_codegen_cranelift/build_system/usage.txt
index ab98ccc35..6d3b3a13d 100644
--- a/compiler/rustc_codegen_cranelift/build_system/usage.txt
+++ b/compiler/rustc_codegen_cranelift/build_system/usage.txt
@@ -1,11 +1,11 @@
The build system of cg_clif.
USAGE:
- ./y.rs prepare [--out-dir DIR]
- ./y.rs build [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--no-unstable-features]
- ./y.rs test [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--no-unstable-features]
- ./y.rs abi-cafe [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--no-unstable-features]
- ./y.rs bench [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--no-unstable-features]
+ ./y.sh prepare [--out-dir DIR] [--download-dir DIR]
+ ./y.sh build [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen]
+ ./y.sh test [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen] [--skip-test TESTNAME]
+ ./y.sh abi-cafe [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen]
+ ./y.sh bench [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen]
OPTIONS:
--debug
@@ -22,14 +22,28 @@ OPTIONS:
Specify the directory in which the download, build and dist directories are stored.
By default this is the working directory.
+ --download-dir DIR
+ Specify the directory in which the download directory is stored. Overrides --out-dir.
+
--no-unstable-features
Some features are not yet ready for production usage. This option will disable these
features. This includes the JIT mode and inline assembly support.
+ --frozen
+ Require Cargo.lock and cache are up to date
+
+ --skip-test TESTNAME
+ Skip testing the TESTNAME test. The test name format is the same as config.txt.
+
+ --use-backend NAME
+ Use the existing Cranelift (or other) backend of the rustc with which we built.
+ Warning: This is meant for use in rust's CI only!
+
REQUIREMENTS:
- * Rustup: The build system has a hard coded dependency on rustup to install the right nightly
- version and make sure it is used where necessary.
- * Git: `./y.rs prepare` uses git for applying patches and on Windows for downloading test repos.
- * Curl and tar (non-Windows only): Used by `./y.rs prepare` to download a single commit for
+ * Rustup: By default rustup is used to install the right nightly version. If you don't want to
+ use rustup, you can manually install the nightly version indicated by rust-toolchain.toml and
+ point the CARGO, RUSTC and RUSTDOC env vars to the right executables.
+ * Git: `./y.sh prepare` uses git for applying patches and on Windows for downloading test repos.
+ * Curl and tar (non-Windows only): Used by `./y.sh prepare` to download a single commit for
repos. Git will be used to clone the whole repo when using Windows.
- * [Hyperfine](https://github.com/sharkdp/hyperfine/): Used for benchmarking with `./y.rs bench`.
+ * [Hyperfine](https://github.com/sharkdp/hyperfine/): Used for benchmarking with `./y.sh bench`.