about summary refs log tree commit diff
diff options
context:
space:
mode:
authorlolbinarycat <binarycat@envs.net>2025-07-11 13:39:39 -0500
committerGitHub <noreply@github.com>2025-07-11 13:39:39 -0500
commit7803c25deaa3f330a952a18c7c3d5ea3850e9ff7 (patch)
treee68f78387c92fd3a6d9816853b85cdaa0fc2004b
parentc46e385a5ebf6b0312dbed617aa53192d8e43607 (diff)
downloadrust-7803c25deaa3f330a952a18c7c3d5ea3850e9ff7.tar.gz
rust-7803c25deaa3f330a952a18c7c3d5ea3850e9ff7.zip
directives.md: build-aux-docs does not work with aux-crate
-rw-r--r--src/doc/rustc-dev-guide/src/tests/directives.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/doc/rustc-dev-guide/src/tests/directives.md b/src/doc/rustc-dev-guide/src/tests/directives.md
index 839076b809d..63aa08c389c 100644
--- a/src/doc/rustc-dev-guide/src/tests/directives.md
+++ b/src/doc/rustc-dev-guide/src/tests/directives.md
@@ -59,7 +59,7 @@ not be exhaustive. Directives can generally be found by browsing the
 | `aux-crate`           | Like `aux-build` but makes available as extern prelude                                                | All except `run-make` | `<extern_prelude_name>=<path/to/aux/file.rs>` |
 | `aux-codegen-backend` | Similar to `aux-build` but pass the compiled dylib to `-Zcodegen-backend` when building the main file | `ui-fulldeps`         | Path to codegen backend file                  |
 | `proc-macro`          | Similar to `aux-build`, but for aux forces host and don't use `-Cprefer-dynamic`[^pm].                | All except `run-make` | Path to auxiliary proc-macro `.rs` file       |
-| `build-aux-docs`      | Build docs for auxiliaries as well                                                                    | All except `run-make` | N/A                                           |
+| `build-aux-docs`      | Build docs for auxiliaries as well.  Note that this only works with `aux-build`, not `aux-crate`.     | All except `run-make` | N/A                                           |
 
 [^pm]: please see the Auxiliary proc-macro section in the
     [compiletest](./compiletest.md) chapter for specifics.