From 61282336ad27aa8b4fbe6594484d425ba2063907 Mon Sep 17 00:00:00 2001 From: KubaP Date: Thu, 10 Jun 2021 00:30:53 +0100 Subject: [PATCH 1/2] Add mising information regarding `cargo doc` It seems that the `--document-private-items` flag is automatically set when documenting a binary target. --- src/doc/src/commands/cargo-doc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/doc/src/commands/cargo-doc.md b/src/doc/src/commands/cargo-doc.md index 413f7f48c..b96e7e953 100644 --- a/src/doc/src/commands/cargo-doc.md +++ b/src/doc/src/commands/cargo-doc.md @@ -32,7 +32,7 @@ option.
--document-private-items
-
Include non-public items in the documentation.
+
Include non-public items in the documentation. This will be enabled by default if documenting a binary target.
From c37a6e354d454a1bd24eebb0e33773e60eae9846 Mon Sep 17 00:00:00 2001 From: KubaP Date: Thu, 10 Jun 2021 10:37:01 +0100 Subject: [PATCH 2/2] Add missing information to the man pages Add the short missing description and build all of the manpages. --- src/doc/man/cargo-doc.md | 2 +- src/doc/man/generated_txt/cargo-doc.txt | 3 ++- src/etc/man/cargo-doc.1 | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/doc/man/cargo-doc.md b/src/doc/man/cargo-doc.md index c97f13a0b..5d87c72e6 100644 --- a/src/doc/man/cargo-doc.md +++ b/src/doc/man/cargo-doc.md @@ -32,7 +32,7 @@ Do not build documentation for dependencies. {{/option}} {{#option "`--document-private-items`" }} -Include non-public items in the documentation. +Include non-public items in the documentation. This will be enabled by default if documenting a binary target. {{/option}} {{/options}} diff --git a/src/doc/man/generated_txt/cargo-doc.txt b/src/doc/man/generated_txt/cargo-doc.txt index b81160f44..a7b160b54 100644 --- a/src/doc/man/generated_txt/cargo-doc.txt +++ b/src/doc/man/generated_txt/cargo-doc.txt @@ -23,7 +23,8 @@ OPTIONS Do not build documentation for dependencies. --document-private-items - Include non-public items in the documentation. + Include non-public items in the documentation. This will be enabled + by default if documenting a binary target. Package Selection By default, when no package selection options are given, the packages diff --git a/src/etc/man/cargo-doc.1 b/src/etc/man/cargo-doc.1 index cb700b2f8..46bb4dca3 100644 --- a/src/etc/man/cargo-doc.1 +++ b/src/etc/man/cargo-doc.1 @@ -28,7 +28,7 @@ Do not build documentation for dependencies. .sp \fB\-\-document\-private\-items\fR .RS 4 -Include non\-public items in the documentation. +Include non\-public items in the documentation. This will be enabled by default if documenting a binary target. .RE .SS "Package Selection" By default, when no package selection options are given, the packages selected