Skip to content

Commit

Permalink
Rollup merge of #86913 - Stupremee:document-rustdoc-private-items, r=…
Browse files Browse the repository at this point in the history
…jyn514

Document rustdoc with `--document-private-items`

The `tool_doc` macro introduced in #86737 did not use `false` as the default value for `binary` when it is not provided, so the `if` is not even expanded and thus the argument is never provided if the `binary` argument isn't.

Resolves #86900

r? ```@Mark-Simulacrum```
  • Loading branch information
GuillaumeGomez authored Jul 8, 2021
2 parents 46314f7 + 27b55e6 commit e30eb4d
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions src/bootstrap/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@ impl Step for Rustc {
}

macro_rules! tool_doc {
($tool: ident, $should_run: literal, $path: literal, [$($krate: literal),+ $(,)?] $(, binary=$bin:expr)?) => {
($tool: ident, $should_run: literal, $path: literal, [$($krate: literal),+ $(,)?], binary=$bin:expr) => {
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
pub struct $tool {
stage: u32,
Expand Down Expand Up @@ -669,9 +669,9 @@ macro_rules! tool_doc {
cargo.arg("-p").arg($krate);
)+

$(if !$bin {
if !$bin {
cargo.rustdocflag("--document-private-items");
})?
}
cargo.rustdocflag("--enable-index-page");
cargo.rustdocflag("--show-type-layout");
cargo.rustdocflag("-Zunstable-options");
Expand All @@ -681,7 +681,13 @@ macro_rules! tool_doc {
}
}

tool_doc!(Rustdoc, "rustdoc-tool", "src/tools/rustdoc", ["rustdoc", "rustdoc-json-types"]);
tool_doc!(
Rustdoc,
"rustdoc-tool",
"src/tools/rustdoc",
["rustdoc", "rustdoc-json-types"],
binary = false
);
tool_doc!(
Rustfmt,
"rustfmt-nightly",
Expand Down

0 comments on commit e30eb4d

Please sign in to comment.