Skip to content

Commit 2ca4393

Browse files
committed
docs: add details for cargo check pass where cargo build fail
1 parent e1d3e13 commit 2ca4393

File tree

4 files changed

+9
-4
lines changed

4 files changed

+9
-4
lines changed

src/doc/man/cargo-check.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Check a local package and all of its dependencies for errors. This will
1515
essentially compile the packages without performing the final step of code
1616
generation, which is faster than running `cargo build`. The compiler will save
1717
metadata files to disk so that future runs will reuse them if the source has
18-
not been modified.
18+
not been modified. Some diagnostics and errors are only emitted during code
19+
generation, so they inherently won't be reported with `cargo check`.
1920

2021
## OPTIONS
2122

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ DESCRIPTION
1111
essentially compile the packages without performing the final step of
1212
code generation, which is faster than running cargo build. The compiler
1313
will save metadata files to disk so that future runs will reuse them if
14-
the source has not been modified.
14+
the source has not been modified. Some diagnostics and errors are only
15+
emitted during code generation, so they inherently won't be reported
16+
with cargo check.
1517

1618
OPTIONS
1719
Package Selection

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Check a local package and all of its dependencies for errors. This will
1515
essentially compile the packages without performing the final step of code
1616
generation, which is faster than running `cargo build`. The compiler will save
1717
metadata files to disk so that future runs will reuse them if the source has
18-
not been modified.
18+
not been modified. Some diagnostics and errors are only emitted during code
19+
generation, so they inherently won't be reported with `cargo check`.
1920

2021
## OPTIONS
2122

src/etc/man/cargo-check.1

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Check a local package and all of its dependencies for errors. This will
1212
essentially compile the packages without performing the final step of code
1313
generation, which is faster than running \fBcargo build\fR\&. The compiler will save
1414
metadata files to disk so that future runs will reuse them if the source has
15-
not been modified.
15+
not been modified. Some diagnostics and errors are only emitted during code
16+
generation, so they inherently won't be reported with \fBcargo check\fR\&.
1617
.SH "OPTIONS"
1718
.SS "Package Selection"
1819
By default, when no package selection options are given, the packages selected

0 commit comments

Comments
 (0)