about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2025-09-10 17:13:49 +0200
committerGuillaume Gomez <guillaume1.gomez@gmail.com>2025-09-10 18:44:02 +0200
commit82ff0025b7e12b2bbd9ddff4a5fed685c491bd34 (patch)
treed29f16df44e18d97b12f46ceb5c45d37b5b194aa /src/doc/rustc-dev-guide
parent808595eff4768b3dba8bbbf19abb50ce4f2093d6 (diff)
downloadrust-82ff0025b7e12b2bbd9ddff4a5fed685c491bd34.tar.gz
rust-82ff0025b7e12b2bbd9ddff4a5fed685c491bd34.zip
Add missing documentation for running tests with GCC backend
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/tests/codegen-backend-tests/cg_gcc.md33
1 files changed, 32 insertions, 1 deletions
diff --git a/src/doc/rustc-dev-guide/src/tests/codegen-backend-tests/cg_gcc.md b/src/doc/rustc-dev-guide/src/tests/codegen-backend-tests/cg_gcc.md
index 4caf4c0e0ee..ef407797fea 100644
--- a/src/doc/rustc-dev-guide/src/tests/codegen-backend-tests/cg_gcc.md
+++ b/src/doc/rustc-dev-guide/src/tests/codegen-backend-tests/cg_gcc.md
@@ -1,3 +1,34 @@
 # GCC codegen backend tests
 
-TODO: please add some more information to this page.
+To test the GCC codegen backend, you need to add `"gcc"` into the `rust.codegen-backends`
+setting in `bootstrap.toml`:
+
+```toml
+rust.codegen-backends = ["llvm", "gcc"]
+```
+
+If you don't want to change your `bootstrap.toml` file, you can alternatively run your `x.py`
+commands with `--set rust.codegen-backends=["llvm", "gcc"]'`. For example:
+
+```bash
+x.py test --set 'rust.codegen-backends=["llvm", "gcc"]'
+```
+
+If you don't want to build `gcc` yourself, you also need to set:
+
+```toml
+gcc.download-ci-gcc = true
+```
+
+Then when running tests, add the `--test-codegen-backend gcc` option. For example:
+
+```bash
+./x.py test tests/ui --test-codegen-backend gcc
+```
+
+If you want to build the sysroot using the GCC backend, you need to set it first
+in `rust.codegen-backends`:
+
+```toml
+rust.codegen-backends = ["llvm", "gcc"]
+```