diff options
| author | Timothée Gerber <contact@timotheegerber.fr> | 2020-03-14 23:04:33 +0100 |
|---|---|---|
| committer | Timothée Gerber <contact@timotheegerber.fr> | 2020-03-14 23:04:33 +0100 |
| commit | 68dc24fcbebbd529e44d9ecba9bcdeff68268555 (patch) | |
| tree | 47abe152bea53204fdebdba7a01e73de9ca15f57 /src/doc | |
| parent | 131772c5e0ba40cd656dedb5e1990d36e3ea31cf (diff) | |
| download | rust-68dc24fcbebbd529e44d9ecba9bcdeff68268555.tar.gz rust-68dc24fcbebbd529e44d9ecba9bcdeff68268555.zip | |
Clean up path separator in rustdoc book
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/rustdoc/src/command-line-arguments.md | 4 | ||||
| -rw-r--r-- | src/doc/rustdoc/src/what-is-rustdoc.md | 6 |
2 files changed, 5 insertions, 5 deletions
diff --git a/src/doc/rustdoc/src/command-line-arguments.md b/src/doc/rustdoc/src/command-line-arguments.md index 2e32ce31eca..ddbe26389fd 100644 --- a/src/doc/rustdoc/src/command-line-arguments.md +++ b/src/doc/rustdoc/src/command-line-arguments.md @@ -79,8 +79,8 @@ Rustdoc only supports HTML output, and so this flag is redundant today. 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 -o target/doc +$ rustdoc src/lib.rs --output target/doc ``` By default, `rustdoc`'s output appears in a directory named `doc` in diff --git a/src/doc/rustdoc/src/what-is-rustdoc.md b/src/doc/rustdoc/src/what-is-rustdoc.md index bbcacb7f3d5..adcebc832bc 100644 --- a/src/doc/rustdoc/src/what-is-rustdoc.md +++ b/src/doc/rustdoc/src/what-is-rustdoc.md @@ -78,8 +78,8 @@ $ cargo doc Internally, this calls out to `rustdoc` like this: ```bash -$ rustdoc --crate-name docs srclib.rs -o <path>\docs\target\doc -L -dependency=<path>docs\target\debug\deps +$ rustdoc --crate-name docs src/lib.rs -o <path>/docs/target/doc -L +dependency=<path>/docs/target/debug/deps ``` You can see this with `cargo doc --verbose`. @@ -128,4 +128,4 @@ Cargo currently does not understand standalone Markdown files, unfortunately. ## Summary This covers the simplest use-cases of `rustdoc`. The rest of this book will -explain all of the options that `rustdoc` has, and how to use them. \ No newline at end of file +explain all of the options that `rustdoc` has, and how to use them. |