Skip to content

Commit cea9b52

Browse files
committed
fixed documentation and regenaration of the pages
1 parent 840b83a commit cea9b52

File tree

4 files changed

+10
-0
lines changed

4 files changed

+10
-0
lines changed

src/doc/man/cargo-doc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ cargo-doc --- Build a package's documentation
1616
Build the documentation for the local package and all dependencies. The output
1717
is placed in `target/doc` in rustdoc's usual format.
1818

19+
Documentation generation is cumulative: existing doc files in the target directory are preserved across different cargo doc invocations. To remove existing generated docs, pass --doc to {{man "cargo-clean" 1}}.
20+
1921
## OPTIONS
2022

2123
### Documentation Options

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ DESCRIPTION
1010
Build the documentation for the local package and all dependencies. The
1111
output is placed in target/doc in rustdoc’s usual format.
1212

13+
Documentation generation is cumulative: existing doc files in the target
14+
directory are preserved across different cargo doc invocations. To
15+
remove existing generated docs, pass –doc to cargo-clean(1).
16+
1317
OPTIONS
1418
Documentation Options
1519
--open

src/doc/src/commands/cargo-doc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ cargo-doc --- Build a package's documentation
1212
Build the documentation for the local package and all dependencies. The output
1313
is placed in `target/doc` in rustdoc's usual format.
1414

15+
Documentation generation is cumulative: existing doc files in the target directory are preserved across different cargo doc invocations. To remove existing generated docs, pass --doc to [cargo-clean(1)](cargo-clean.html).
16+
1517
## OPTIONS
1618

1719
### Documentation Options

src/etc/man/cargo-doc.1

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ cargo\-doc \[em] Build a package\[cq]s documentation
1010
.SH "DESCRIPTION"
1111
Build the documentation for the local package and all dependencies. The output
1212
is placed in \fBtarget/doc\fR in rustdoc\[cq]s usual format.
13+
.sp
14+
Documentation generation is cumulative: existing doc files in the target directory are preserved across different cargo doc invocations. To remove existing generated docs, pass \[en]doc to \fBcargo\-clean\fR(1).
1315
.SH "OPTIONS"
1416
.SS "Documentation Options"
1517
.sp

0 commit comments

Comments
 (0)