about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMatthias Krüger <476013+matthiaskrgr@users.noreply.github.com>2025-04-25 00:54:00 +0200
committerGitHub <noreply@github.com>2025-04-25 00:54:00 +0200
commitee7766a25f7d5a684402e16ae142e2031f572bbc (patch)
treec7aa80a04dcdcfaee6d597c2952403cc652e0838
parent11fbbc54ba443f0edafdd1c34de7c069f7a325bf (diff)
parenta224942d4cd234a20cf5521afb1debc7fc51eea9 (diff)
downloadrust-ee7766a25f7d5a684402e16ae142e2031f572bbc.tar.gz
rust-ee7766a25f7d5a684402e16ae142e2031f572bbc.zip
Rollup merge of #140213 - onur-ozkan:x-setup, r=cuviper
mention about `x.py setup` in `INSTALL.md`

Addresses [#t-infra/bootstrap > Installing from Source](https://rust-lang.zulipchat.com/#narrow/channel/326414-t-infra.2Fbootstrap/topic/Installing.20from.20Source).
-rw-r--r--INSTALL.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 30e08201d6d..98eb825cd10 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -75,8 +75,31 @@ See [the rustc-dev-guide for more info][sysllvm].
 
 2. Configure the build settings:
 
+   If you're unsure which build configurations to use and need a good default, you
+   can run the interactive `x.py setup` command. This will guide you through selecting
+   a config profile, setting up the LSP, configuring a Git hook, etc.
+
+   With `configure` script, you can handle multiple configurations in a single
+   command which is useful to create complex/advanced config files. For example:
+
    ```sh
-   ./configure
+   ./configure --build=aarch64-unknown-linux-gnu \
+      --enable-full-tools \
+      --enable-profiler \
+      --enable-sanitizers \
+      --enable-compiler-docs \
+      --set target.aarch64-unknown-linux-gnu.linker=clang \
+      --set target.aarch64-unknown-linux-gnu.ar=/rustroot/bin/llvm-ar \
+      --set target.aarch64-unknown-linux-gnu.ranlib=/rustroot/bin/llvm-ranlib \
+      --set llvm.link-shared=true \
+      --set llvm.thin-lto=true \
+      --set llvm.libzstd=true \
+      --set llvm.ninja=false \
+      --set rust.debug-assertions=false \
+      --set rust.jemalloc \
+      --set rust.use-lld=true \
+      --set rust.lto=thin \
+      --set rust.codegen-units=1
    ```
 
    If you plan to use `x.py install` to create an installation, you can either