about summary refs log tree commit diff
path: root/compiler/rustc_codegen_llvm/src
diff options
context:
space:
mode:
authorDylan DPC <99973273+Dylan-DPC@users.noreply.github.com>2022-10-26 17:32:54 +0530
committerGitHub <noreply@github.com>2022-10-26 17:32:54 +0530
commitb03fa1a3fe02cd0087982cc22bda7598a9fc39eb (patch)
tree73f2a5812c23065a135d05f1bedb04a44871d91a /compiler/rustc_codegen_llvm/src
parent5b6455318a1e273c9fa4eb0d6ebad9e1f2c0ef51 (diff)
parent91c09d44f60c22e0874bcef393e2fa67e1875c01 (diff)
downloadrust-b03fa1a3fe02cd0087982cc22bda7598a9fc39eb.tar.gz
rust-b03fa1a3fe02cd0087982cc22bda7598a9fc39eb.zip
Rollup merge of #102706 - ferrocene:pa-ignore-doc-index, r=jyn514
Support excluding the generation of the standalone docs

For Ferrocene we need to exclude the generation of the standalone docs (which include the index page, which we want to replace with our own), but with the way bootstrap is currently implemented that proved not possible. This PR aims to support that.

The first problem is that the `doc::Standalone` step did two things: it generated the "standalone" documentation (which includes the index page and all the pages at the root of the documentation tree), but it also generated some files like `rust.css` and `version_info.html` that other step like `doc::TheBook` required. This meant generating the book required generating the index page, which made disabling the index page generation problematic.

The approach I took to fix the first problem is to split the step into `doc::Standalone` and `doc::SharedAssets`, with `doc::TheBook` now depending on `doc::SharedAssets`.

The second problem is that disabling the `doc::Standalone` proved to be tricky due to its path, `src/doc`. The path is accurate, as the source files for that step are `src/doc/*.md`. The problem is, bootstrap treats `--exclude` as a *suffix*, and so it also excluded the Cargo book whose source lives at `src/tools/cargo/src/doc`.

The approach I took to fix the second problem is to add the `standalone` path in addition to `src/doc`, so that you can pass `--exclude standalone`. I'm not fully happy with the solution, and the other idea I had was to just move the standalone docs source code to `src/doc/standalone`. I feel that second approach is cleaner, but also requires more changes and might require more consensus.

This PR is best reviewed commit-by-commit.

r? `@jyn514`
Diffstat (limited to 'compiler/rustc_codegen_llvm/src')
0 files changed, 0 insertions, 0 deletions