Skip to content

Commit 16892cf

Browse files
authored
Rollup merge of #96756 - jyn514:compiler-docs-default, r=Mark-Simulacrum
Enable compiler-docs by default for `compiler`, `codegen`, and `tools` profiles I had this overridden locally for a while and realized just now it should probably just be a default.
2 parents a82e2ab + 7443cc2 commit 16892cf

File tree

3 files changed

+10
-0
lines changed

3 files changed

+10
-0
lines changed

src/bootstrap/defaults/config.codegen.toml

+4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# These defaults are meant for contributors to the compiler who modify codegen or LLVM
2+
[build]
3+
# Contributors working on the compiler will probably expect compiler docs to be generated.
4+
compiler-docs = true
5+
26
[llvm]
37
# This enables debug-assertions in LLVM,
48
# catching logic errors in codegen much earlier in the process.

src/bootstrap/defaults/config.compiler.toml

+4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# These defaults are meant for contributors to the compiler who do not modify codegen or LLVM
2+
[build]
3+
# Contributors working on the compiler will probably expect compiler docs to be generated.
4+
compiler-docs = true
5+
26
[rust]
37
# This enables `RUSTC_LOG=debug`, avoiding confusing situations
48
# where adding `debug!()` appears to do nothing.

src/bootstrap/defaults/config.tools.toml

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ download-rustc = "if-unchanged"
1414
[build]
1515
# Document with the in-tree rustdoc by default, since `download-rustc` makes it quick to compile.
1616
doc-stage = 2
17+
# Contributors working on tools will probably expect compiler docs to be generated, so they can figure out how to use the API.
18+
compiler-docs = true
1719

1820
[llvm]
1921
# Will download LLVM from CI if available on your platform.

0 commit comments

Comments
 (0)