about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorMartin Nordholts <martin.nordholts@codetale.se>2024-04-06 22:01:03 +0200
committerGitHub <noreply@github.com>2024-04-06 21:01:03 +0100
commit00f1929be01fcb65d6e4941923be37527f910bef (patch)
tree25715043f0b1cf25f0091fb22959f8e2a8b4a85b /src/doc/rustc-dev-guide
parent0b431aca386eda700d299c21131e528a58885f08 (diff)
downloadrust-00f1929be01fcb65d6e4941923be37527f910bef.tar.gz
rust-00f1929be01fcb65d6e4941923be37527f910bef.zip
Add basic docs for the new `aux-bin` header (#1942)
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/tests/compiletest.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/doc/rustc-dev-guide/src/tests/compiletest.md b/src/doc/rustc-dev-guide/src/tests/compiletest.md
index 175e23b1232..41c750a29e7 100644
--- a/src/doc/rustc-dev-guide/src/tests/compiletest.md
+++ b/src/doc/rustc-dev-guide/src/tests/compiletest.md
@@ -501,10 +501,11 @@ only running the main `coverage` suite.
 ## Building auxiliary crates
 
 It is common that some tests require additional auxiliary crates to be compiled.
-There are two [headers](headers.md) to assist with that:
+There are three [headers](headers.md) to assist with that:
 
 * `aux-build`
 * `aux-crate`
+* `aux-bin`
 
 `aux-build` will build a separate crate from the named source file.
 The source file should be in a directory called `auxiliary` beside the test file.
@@ -529,6 +530,10 @@ For example, `// aux-crate:foo=bar.rs` will compile `auxiliary/bar.rs` and
 make it available under then name `foo` within the test.
 This is similar to how Cargo does dependency renaming.
 
+`aux-bin` is similar to `aux-build` but will build a binary instead of a
+library. The binary will be available in `auxiliary/bin` relative to the working
+directory of the test.
+
 ### Auxiliary proc-macro
 
 If you want a proc-macro dependency, then there currently is some ceremony