about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume.gomez@huawei.com>2022-02-15 11:48:41 +0100
committerGuillaume Gomez <guillaume.gomez@huawei.com>2022-02-15 21:34:40 +0100
commit590ca7e756b75d91f631ca2a4a1fbce0cb788f5e (patch)
treeb1a5cadb7759fee96372b3fc7e9d900bfbbd6cbc
parent41a0f8c72f3e9d439329ca7e3ccd9ae98b92bb23 (diff)
downloadrust-590ca7e756b75d91f631ca2a4a1fbce0cb788f5e.tar.gz
rust-590ca7e756b75d91f631ca2a4a1fbce0cb788f5e.zip
Add documentation for rustdoc --check option
-rw-r--r--src/doc/rustdoc/src/command-line-arguments.md11
1 files changed, 11 insertions, 0 deletions
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
+```