Commit a256f06

committed

doc: add '--document-private-items' to cargo xtask doc

1 parent c2d026d commit a256f06Copy full SHA for a256f06

File tree

-1

lines changed

-1

lines changed

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -198,6 +198,9 @@ impl Cargo {`
`198`	`198`	`if self.warnings_as_errors {`
`199`	`199`	`cmd.env("RUSTDOCFLAGS", "-Dwarnings");`
`200`	`200`	`}`
	`201`	`+ // We do not publicly do this on docs.rs but this helps us to prevent illegal`
	`202`	`+ // intra-doc links and other rustdoc errors in the documentation of private items.`
	`203`	`+ extra_args.push("--document-private-items");`
`201`	`204`	`if open {`
`202`	`205`	`extra_args.push("--open");`
`203`	`206`	`}`
`@@ -293,7 +296,7 @@ mod tests {`
`293`	`296`	`};`
`294`	`297`	`assert_eq!(`
`295`	`298`	`command_to_string(&cargo.command().unwrap()),`
`296`		`- "RUSTDOCFLAGS=-Dwarnings cargo doc --package uefi --package xtask --features alloc --open"`
	`299`	`+ "RUSTDOCFLAGS=-Dwarnings cargo doc --package uefi --package xtask --features alloc --document-private-items --open"`
`297`	`300`	`);`
`298`	`301`	`}`
`299`	`302`	`}`

Comments

(0)