1
Fork 0

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.
This commit is contained in:
Matthias Krüger 2022-05-07 22:44:41 +02:00 committed by GitHub
commit 16892cfe95
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 0 deletions

View file

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

View file

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

View file

@ -14,6 +14,8 @@ download-rustc = "if-unchanged"
[build]
# Document with the in-tree rustdoc by default, since `download-rustc` makes it quick to compile.
doc-stage = 2
# Contributors working on tools will probably expect compiler docs to be generated, so they can figure out how to use the API.
compiler-docs = true
[llvm]
# Will download LLVM from CI if available on your platform.