fork/rust

git clone https://git.julia.blue/fork/rust

borsAuto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee3bcad65fbf6

master
2.6 KiB49 linesraw
1The build system of cg_clif.
2
3USAGE:
4    ./y.sh prepare [--out-dir DIR] [--download-dir DIR]
5    ./y.sh build [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen]
6    ./y.sh test [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen] [--skip-test TESTNAME]
7    ./y.sh abi-cafe [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen]
8    ./y.sh bench [--debug] [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen]
9
10OPTIONS:
11    --debug
12            Build cg_clif and the standard library in debug mode rather than release mode.
13            Warning: An unoptimized cg_clif is very slow.
14
15    --sysroot none|clif|llvm
16            Which sysroot libraries to use:
17            `none` will not include any standard library in the sysroot.
18            `clif` will build the standard library using Cranelift.
19            `llvm` will use the pre-compiled standard library of rustc which is compiled with LLVM.
20
21    --out-dir DIR
22            Specify the directory in which the download, build and dist directories are stored.
23            By default this is the working directory.
24
25    --download-dir DIR
26            Specify the directory in which the download directory is stored. Overrides --out-dir.
27
28    --no-unstable-features
29            Some features are not yet ready for production usage. This option will disable these
30            features. This includes the JIT mode and inline assembly support.
31
32    --frozen
33            Require Cargo.lock and cache are up to date
34
35    --skip-test TESTNAME
36            Skip testing the TESTNAME test. The test name format is the same as config.txt.
37
38    --use-backend NAME
39            Use the existing Cranelift (or other) backend of the rustc with which we built.
40            Warning: This is meant for use in rust's CI only!
41
42REQUIREMENTS:
43    * Rustup: By default rustup is used to install the right nightly version. If you don't want to
44      use rustup, you can manually install the nightly version indicated by rust-toolchain.toml and
45      point the CARGO, RUSTC and RUSTDOC env vars to the right executables.
46    * Git: Git is used for applying patches and on Windows for downloading test repos.
47    * Curl and tar (non-Windows only): Used by `./y.sh prepare` to download a single commit for
48      repos. Git will be used to clone the whole repo when using Windows.
49    * [Hyperfine](https://github.com/sharkdp/hyperfine/): Used for benchmarking with `./y.sh bench`.