bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #86913 - Stupremee:document-rustdoc-private-items, r=jyn514

Browse source 
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```
This commit is contained in:
Guillaume Gomez 2021-07-08 18:30:39 +02:00 • committed by GitHub
commit e30eb4d1a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/bootstrap/doc.rs
View file

@ -600,7 +600,7 @@ impl Step for Rustc {
} }
macro_rules! tool_doc { 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)] #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
pub struct $tool { pub struct $tool {
stage: u32, stage: u32,
@ -669,9 +669,9 @@ macro_rules! tool_doc {
cargo.arg("-p").arg($krate); cargo.arg("-p").arg($krate);
)+ )+
$(if !$bin { if !$bin {
cargo.rustdocflag("--document-private-items"); cargo.rustdocflag("--document-private-items");
})? }
cargo.rustdocflag("--enable-index-page"); cargo.rustdocflag("--enable-index-page");
cargo.rustdocflag("--show-type-layout"); cargo.rustdocflag("--show-type-layout");
cargo.rustdocflag("-Zunstable-options"); cargo.rustdocflag("-Zunstable-options");
@ -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!( tool_doc!(
Rustfmt, Rustfmt,
"rustfmt-nightly", "rustfmt-nightly",