From bba274fabbaf6e2387db5e09d1ad3a9c2ca48560 Mon Sep 17 00:00:00 2001 From: Pietro Albini Date: Tue, 24 Jan 2023 17:00:45 +0100 Subject: [PATCH 1/2] add option to include private items in library docs --- config.toml.example | 3 +++ src/bootstrap/config.rs | 3 +++ src/bootstrap/doc.rs | 3 +++ 3 files changed, 9 insertions(+) diff --git a/config.toml.example b/config.toml.example index 299bfd779e57a..85f058f3664e3 100644 --- a/config.toml.example +++ b/config.toml.example @@ -233,6 +233,9 @@ changelog-seen = 2 # and generated in already-minified form from the beginning. #docs-minification = true +# Flag to specify whether private items should be included in the library docs. +#library-docs-private-items = false + # Indicate whether the compiler should be documented in addition to the standard # library and facade crates. #compiler-docs = false diff --git a/src/bootstrap/config.rs b/src/bootstrap/config.rs index b41d60d51a8b5..0bcc919aee802 100644 --- a/src/bootstrap/config.rs +++ b/src/bootstrap/config.rs @@ -65,6 +65,7 @@ pub struct Config { pub verbose: usize, pub submodules: Option, pub compiler_docs: bool, + pub library_docs_private_items: bool, pub docs_minification: bool, pub docs: bool, pub locked_deps: bool, @@ -606,6 +607,7 @@ define_config! { rustfmt: Option = "rustfmt", docs: Option = "docs", compiler_docs: Option = "compiler-docs", + library_docs_private_items: Option = "library-docs-private-items", docs_minification: Option = "docs-minification", submodules: Option = "submodules", gdb: Option = "gdb", @@ -1015,6 +1017,7 @@ impl Config { config.submodules = build.submodules; set(&mut config.low_priority, build.low_priority); set(&mut config.compiler_docs, build.compiler_docs); + set(&mut config.library_docs_private_items, build.library_docs_private_items); set(&mut config.docs_minification, build.docs_minification); set(&mut config.docs, build.docs); set(&mut config.locked_deps, build.locked_deps); diff --git a/src/bootstrap/doc.rs b/src/bootstrap/doc.rs index 9bad9046ecc2c..5d5a808200d91 100644 --- a/src/bootstrap/doc.rs +++ b/src/bootstrap/doc.rs @@ -597,6 +597,9 @@ fn doc_std( .arg("--resource-suffix") .arg(&builder.version) .args(extra_args); + if builder.config.library_docs_private_items { + cargo.arg("--document-private-items"); + } builder.run(&mut cargo.into()); }; From 8f84408697dfa95fd3b6367094105b959969702e Mon Sep 17 00:00:00 2001 From: Pietro Albini Date: Thu, 26 Jan 2023 14:13:35 +0100 Subject: [PATCH 2/2] also document hidden items --- src/bootstrap/doc.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/bootstrap/doc.rs b/src/bootstrap/doc.rs index 5d5a808200d91..7f8aa2573ddb3 100644 --- a/src/bootstrap/doc.rs +++ b/src/bootstrap/doc.rs @@ -598,7 +598,7 @@ fn doc_std( .arg(&builder.version) .args(extra_args); if builder.config.library_docs_private_items { - cargo.arg("--document-private-items"); + cargo.arg("--document-private-items").arg("--document-hidden-items"); } builder.run(&mut cargo.into()); };