Skip to content

Commit 684fa19

Browse files
authored
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.
2 parents fa189d4 + 095b6d2 commit 684fa19

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

Diff for: config.toml.example

+5
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,11 @@ changelog-seen = 2
208208
# documentation.
209209
#docs = true
210210

211+
# Flag to specify whether CSS, JavaScript, and HTML are minified when
212+
# docs are generated. JSON is always minified, because it's enormous,
213+
# and generated in already-minified form from the beginning.
214+
#docs-minification = true
215+
211216
# Indicate whether the compiler should be documented in addition to the standard
212217
# library and facade crates.
213218
#compiler-docs = false

Diff for: src/bootstrap/config.rs

+4
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ pub struct Config {
5151
pub submodules: bool,
5252
pub fast_submodules: bool,
5353
pub compiler_docs: bool,
54+
pub docs_minification: bool,
5455
pub docs: bool,
5556
pub locked_deps: bool,
5657
pub vendor: bool,
@@ -362,6 +363,7 @@ struct Build {
362363
rustfmt: Option<PathBuf>,
363364
docs: Option<bool>,
364365
compiler_docs: Option<bool>,
366+
docs_minification: Option<bool>,
365367
submodules: Option<bool>,
366368
fast_submodules: Option<bool>,
367369
gdb: Option<String>,
@@ -557,6 +559,7 @@ impl Config {
557559
config.submodules = true;
558560
config.fast_submodules = true;
559561
config.docs = true;
562+
config.docs_minification = true;
560563
config.rust_rpath = true;
561564
config.channel = "dev".to_string();
562565
config.codegen_tests = true;
@@ -663,6 +666,7 @@ impl Config {
663666
config.python = build.python.map(PathBuf::from);
664667
set(&mut config.low_priority, build.low_priority);
665668
set(&mut config.compiler_docs, build.compiler_docs);
669+
set(&mut config.docs_minification, build.docs_minification);
666670
set(&mut config.docs, build.docs);
667671
set(&mut config.submodules, build.submodules);
668672
set(&mut config.fast_submodules, build.fast_submodules);

Diff for: src/bootstrap/doc.rs

+12
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,10 @@ fn invoke_rustdoc(
270270
.arg("--markdown-css")
271271
.arg("../rust.css");
272272

273+
if !builder.config.docs_minification {
274+
cmd.arg("-Z").arg("unstable-options").arg("--disable-minification");
275+
}
276+
273277
builder.run(&mut cmd);
274278
}
275279

@@ -365,6 +369,10 @@ impl Step for Standalone {
365369
.arg(&out)
366370
.arg(&path);
367371

372+
if !builder.config.docs_minification {
373+
cmd.arg("--disable-minification");
374+
}
375+
368376
if filename == "not_found.md" {
369377
cmd.arg("--markdown-css").arg("https://doc.rust-lang.org/rust.css");
370378
} else {
@@ -437,6 +445,10 @@ impl Step for Std {
437445
.arg("--index-page")
438446
.arg(&builder.src.join("src/doc/index.md"));
439447

448+
if !builder.config.docs_minification {
449+
cargo.arg("--disable-minification");
450+
}
451+
440452
builder.run(&mut cargo.into());
441453
};
442454
// Only build the following crates. While we could just iterate over the

0 commit comments

Comments
 (0)