Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add details for cargo check pass where cargo build fail #8677

Merged
merged 1 commit into from
Sep 5, 2020
Merged

docs: add details for cargo check pass where cargo build fail #8677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion src/doc/man/cargo-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Check a local package and all of its dependencies for errors. This will
essentially compile the packages without performing the final step of code
generation, which is faster than running `cargo build`. The compiler will save
metadata files to disk so that future runs will reuse them if the source has
not been modified.
not been modified. Some diagnostics and errors are only emitted during code
generation, so they inherently won't be reported with `cargo check`.

## OPTIONS

Expand Down
4 changes: 3 additions & 1 deletion src/doc/man/generated_txt/cargo-check.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ DESCRIPTION
essentially compile the packages without performing the final step of
code generation, which is faster than running cargo build. The compiler
will save metadata files to disk so that future runs will reuse them if
the source has not been modified.
the source has not been modified. Some diagnostics and errors are only
emitted during code generation, so they inherently won't be reported
with cargo check.

OPTIONS
Package Selection
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Check a local package and all of its dependencies for errors. This will
essentially compile the packages without performing the final step of code
generation, which is faster than running `cargo build`. The compiler will save
metadata files to disk so that future runs will reuse them if the source has
not been modified.
not been modified. Some diagnostics and errors are only emitted during code
generation, so they inherently won't be reported with `cargo check`.

## OPTIONS

Expand Down
3 changes: 2 additions & 1 deletion src/etc/man/cargo-check.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Check a local package and all of its dependencies for errors. This will
essentially compile the packages without performing the final step of code
generation, which is faster than running \fBcargo build\fR\&. The compiler will save
metadata files to disk so that future runs will reuse them if the source has
not been modified.
not been modified. Some diagnostics and errors are only emitted during code
generation, so they inherently won't be reported with \fBcargo check\fR\&.
.SH "OPTIONS"
.SS "Package Selection"
By default, when no package selection options are given, the packages selected
Expand Down