Skip to content

Commit c37a6e3

Browse files
committed
Add missing information to the man pages
Add the short missing description and build all of the manpages.
1 parent 6128233 commit c37a6e3

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

src/doc/man/cargo-doc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Do not build documentation for dependencies.
3232
{{/option}}
3333

3434
{{#option "`--document-private-items`" }}
35-
Include non-public items in the documentation.
35+
Include non-public items in the documentation. This will be enabled by default if documenting a binary target.
3636
{{/option}}
3737

3838
{{/options}}

src/doc/man/generated_txt/cargo-doc.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ OPTIONS
2323
Do not build documentation for dependencies.
2424

2525
--document-private-items
26-
Include non-public items in the documentation.
26+
Include non-public items in the documentation. This will be enabled
27+
by default if documenting a binary target.
2728

2829
Package Selection
2930
By default, when no package selection options are given, the packages

src/etc/man/cargo-doc.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Do not build documentation for dependencies.
2828
.sp
2929
\fB\-\-document\-private\-items\fR
3030
.RS 4
31-
Include non\-public items in the documentation.
31+
Include non\-public items in the documentation. This will be enabled by default if documenting a binary target.
3232
.RE
3333
.SS "Package Selection"
3434
By default, when no package selection options are given, the packages selected

0 commit comments

Comments
 (0)