bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Clean up path separator in rustdoc book

Browse source
This commit is contained in:
Timothée Gerber 2020-03-14 23:04:33 +01:00
parent 131772c5e0
commit 68dc24fcbe
2 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/doc/rustdoc/src/command-line-arguments.md
View file

@ -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

6
src/doc/rustdoc/src/what-is-rustdoc.md
View file

@ -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.
explain all of the options that `rustdoc` has, and how to use them.