about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMiguel Ojeda <ojeda@kernel.org>2024-08-10 14:56:22 +0200
committerMiguel Ojeda <ojeda@kernel.org>2024-08-28 01:57:16 +0200
commit992dd0bbe39fc65257fd9e8bfd21a1d0779ec52e (patch)
treea2538c5fe596bb2058bccb60e33b4cd37d1f4ccc
parent1f12b9b0fdbe735968ac002792a720f0ba4faca6 (diff)
downloadrust-992dd0bbe39fc65257fd9e8bfd21a1d0779ec52e.tar.gz
rust-992dd0bbe39fc65257fd9e8bfd21a1d0779ec52e.zip
CI: rfl: add a couple comments to split the steps and document them
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
-rwxr-xr-xsrc/ci/docker/scripts/rfl-build.sh9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/ci/docker/scripts/rfl-build.sh b/src/ci/docker/scripts/rfl-build.sh
index 389abb2fdd3..90706a55017 100755
--- a/src/ci/docker/scripts/rfl-build.sh
+++ b/src/ci/docker/scripts/rfl-build.sh
@@ -62,11 +62,20 @@ make -C linux LLVM=1 -j$(($(nproc) + 1)) \
     defconfig \
     rfl-for-rust-ci.config
 
+# Build a few Rust targets
+#
+# This does not include building the C side of the kernel nor linking,
+# which can find other issues, but it is much faster.
+#
+# This includes transforming `rustdoc` tests into KUnit ones thanks to
+# `CONFIG_RUST_KERNEL_DOCTESTS=y` above (which, for the moment, uses the
+# unstable `--test-builder` and `--no-run`).
 make -C linux LLVM=1 -j$(($(nproc) + 1)) \
     samples/rust/rust_minimal.o \
     samples/rust/rust_print.o \
     drivers/net/phy/ax88796b_rust.o \
     rust/doctests_kernel_generated.o
 
+# Generate documentation
 make -C linux LLVM=1 -j$(($(nproc) + 1)) \
     rustdoc