about summary refs log tree commit diff
path: root/src/doc/rustdoc
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2021-12-11 08:22:30 +0100
committerGitHub <noreply@github.com>2021-12-11 08:22:30 +0100
commitd8bb4d69db35368cf3ceff92ee59b100339bce3b (patch)
tree3a5b9e442c50f010b343ae166178d644eca0e343 /src/doc/rustdoc
parent2f8e2ff6ba7194424718e39f0482b6d350b5e170 (diff)
parent03be3e21b1e259b24859b8f00f5280e56bd0b254 (diff)
downloadrust-d8bb4d69db35368cf3ceff92ee59b100339bce3b.tar.gz
rust-d8bb4d69db35368cf3ceff92ee59b100339bce3b.zip
Rollup merge of #91310 - hi-rustin:rustin-patch-rustdoc, r=jyn514
Add --out-dir flag for rustdoc

part of https://github.com/rust-lang/rust/issues/91260

Add --out-dir flag for rustdoc and change the `-o` option to point to out-dir.

I'm not quite sure if it should be stable, also I'm not sure if this parameter priority is appropriate? Or should I just refuse to pass both parameters at the same time?

r? `@jyn514`
Diffstat (limited to 'src/doc/rustdoc')
-rw-r--r--src/doc/rustdoc/src/command-line-arguments.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/doc/rustdoc/src/command-line-arguments.md b/src/doc/rustdoc/src/command-line-arguments.md
index d6948622662..9de2e733de7 100644
--- a/src/doc/rustdoc/src/command-line-arguments.md
+++ b/src/doc/rustdoc/src/command-line-arguments.md
@@ -57,13 +57,13 @@ release: 1.17.0
 LLVM version: 3.9
 ```
 
-## `-o`/`--output`: output path
+## `-o`/`--out-dir`: output directory path
 
 Using this flag looks like this:
 
 ```bash
 $ rustdoc src/lib.rs -o target/doc
-$ rustdoc src/lib.rs --output target/doc
+$ rustdoc src/lib.rs --out-dir target/doc
 ```
 
 By default, `rustdoc`'s output appears in a directory named `doc` in