Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/doc/man/cargo-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ cargo-doc --- Build a package's documentation
Build the documentation for the local package and all dependencies. The output
is placed in `target/doc` in rustdoc's usual format.

**Note:** 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}}.

## OPTIONS

### Documentation Options
Expand Down
4 changes: 4 additions & 0 deletions src/doc/man/generated_txt/cargo-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ DESCRIPTION
Build the documentation for the local package and all dependencies. The
output is placed in target/doc in rustdoc’s usual format.

Note: 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).

OPTIONS
Documentation Options
--open
Expand Down
2 changes: 2 additions & 0 deletions src/doc/src/commands/cargo-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ cargo-doc --- Build a package's documentation
Build the documentation for the local package and all dependencies. The output
is placed in `target/doc` in rustdoc's usual format.

**Note:** 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).

## OPTIONS

### Documentation Options
Expand Down
2 changes: 2 additions & 0 deletions src/etc/man/cargo-doc.1
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ cargo\-doc \[em] Build a package\[cq]s documentation
.SH "DESCRIPTION"
Build the documentation for the local package and all dependencies. The output
is placed in \fBtarget/doc\fR in rustdoc\[cq]s usual format.
.sp
\fBNote:\fR Documentation generation is cumulative: existing doc files in the target directory are preserved across different \fBcargo doc\fR invocations. To remove existing generated docs, pass \fB\-\-doc\fR to \fBcargo\-clean\fR(1).
.SH "OPTIONS"
.SS "Documentation Options"
.sp
Expand Down
Loading