Rollup merge of #83059 - notriddle:config-toml-disable-minification, r=Mark-Simulacrum

Allow configuring `rustdoc --disable-minification` in config.toml

This way, you can debug rustdoc's JavaScript and CSS file with normal F12 Dev Tools and you'll have useful line numbers to work with.
This commit is contained in:
Yuki Okushi 2021-03-13 09:44:47 +09:00 committed by GitHub
commit 684fa1977c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 21 additions and 0 deletions

View File

@ -208,6 +208,11 @@ changelog-seen = 2
# documentation. # documentation.
#docs = true #docs = true
# Flag to specify whether CSS, JavaScript, and HTML are minified when
# docs are generated. JSON is always minified, because it's enormous,
# and generated in already-minified form from the beginning.
#docs-minification = true
# Indicate whether the compiler should be documented in addition to the standard # Indicate whether the compiler should be documented in addition to the standard
# library and facade crates. # library and facade crates.
#compiler-docs = false #compiler-docs = false

View File

@ -51,6 +51,7 @@ pub struct Config {
pub submodules: bool, pub submodules: bool,
pub fast_submodules: bool, pub fast_submodules: bool,
pub compiler_docs: bool, pub compiler_docs: bool,
pub docs_minification: bool,
pub docs: bool, pub docs: bool,
pub locked_deps: bool, pub locked_deps: bool,
pub vendor: bool, pub vendor: bool,
@ -362,6 +363,7 @@ struct Build {
rustfmt: Option<PathBuf>, rustfmt: Option<PathBuf>,
docs: Option<bool>, docs: Option<bool>,
compiler_docs: Option<bool>, compiler_docs: Option<bool>,
docs_minification: Option<bool>,
submodules: Option<bool>, submodules: Option<bool>,
fast_submodules: Option<bool>, fast_submodules: Option<bool>,
gdb: Option<String>, gdb: Option<String>,
@ -557,6 +559,7 @@ impl Config {
config.submodules = true; config.submodules = true;
config.fast_submodules = true; config.fast_submodules = true;
config.docs = true; config.docs = true;
config.docs_minification = true;
config.rust_rpath = true; config.rust_rpath = true;
config.channel = "dev".to_string(); config.channel = "dev".to_string();
config.codegen_tests = true; config.codegen_tests = true;
@ -663,6 +666,7 @@ impl Config {
config.python = build.python.map(PathBuf::from); config.python = build.python.map(PathBuf::from);
set(&mut config.low_priority, build.low_priority); set(&mut config.low_priority, build.low_priority);
set(&mut config.compiler_docs, build.compiler_docs); set(&mut config.compiler_docs, build.compiler_docs);
set(&mut config.docs_minification, build.docs_minification);
set(&mut config.docs, build.docs); set(&mut config.docs, build.docs);
set(&mut config.submodules, build.submodules); set(&mut config.submodules, build.submodules);
set(&mut config.fast_submodules, build.fast_submodules); set(&mut config.fast_submodules, build.fast_submodules);

View File

@ -270,6 +270,10 @@ fn invoke_rustdoc(
.arg("--markdown-css") .arg("--markdown-css")
.arg("../rust.css"); .arg("../rust.css");
if !builder.config.docs_minification {
cmd.arg("-Z").arg("unstable-options").arg("--disable-minification");
}
builder.run(&mut cmd); builder.run(&mut cmd);
} }
@ -365,6 +369,10 @@ impl Step for Standalone {
.arg(&out) .arg(&out)
.arg(&path); .arg(&path);
if !builder.config.docs_minification {
cmd.arg("--disable-minification");
}
if filename == "not_found.md" { if filename == "not_found.md" {
cmd.arg("--markdown-css").arg("https://doc.rust-lang.org/rust.css"); cmd.arg("--markdown-css").arg("https://doc.rust-lang.org/rust.css");
} else { } else {
@ -437,6 +445,10 @@ impl Step for Std {
.arg("--index-page") .arg("--index-page")
.arg(&builder.src.join("src/doc/index.md")); .arg(&builder.src.join("src/doc/index.md"));
if !builder.config.docs_minification {
cargo.arg("--disable-minification");
}
builder.run(&mut cargo.into()); builder.run(&mut cargo.into());
}; };
// Only build the following crates. While we could just iterate over the // Only build the following crates. While we could just iterate over the