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

rust-lang · Sep 5, 2020 · 2ca4393 · 2ca4393
1 parent e1d3e13
commit 2ca4393
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/src/doc/man/cargo-check.md b/src/doc/man/cargo-check.md
@@ -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
 

diff --git a/src/doc/man/generated_txt/cargo-check.txt b/src/doc/man/generated_txt/cargo-check.txt
@@ -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

diff --git a/src/doc/src/commands/cargo-check.md b/src/doc/src/commands/cargo-check.md
@@ -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
 

diff --git a/src/etc/man/cargo-check.1 b/src/etc/man/cargo-check.1
@@ -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