From 590ca7e756b75d91f631ca2a4a1fbce0cb788f5e Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Tue, 15 Feb 2022 11:48:41 +0100 Subject: Add documentation for rustdoc --check option --- src/doc/rustdoc/src/command-line-arguments.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'src/doc/rustdoc') diff --git a/src/doc/rustdoc/src/command-line-arguments.md b/src/doc/rustdoc/src/command-line-arguments.md index 7b7e1a07646..3ce57f88938 100644 --- a/src/doc/rustdoc/src/command-line-arguments.md +++ b/src/doc/rustdoc/src/command-line-arguments.md @@ -426,3 +426,14 @@ When this flag is used with `--test`, the output (stdout and stderr) of your tes captured by rustdoc. Instead, the output will be directed to your terminal, as if you had run the test executable manually. This is especially useful for debugging your tests! + +## `--check` + +When this flag is supplied, rustdoc will type check and lint your code, but will not generate any +documentation or run your doctests. + +Using this flag looks like: + +```bash +rustdoc -Z unstable-options --check src/lib.rs +``` -- cgit 1.4.1-3-g733a5