mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

include `./` in example x.py commands for smoother copy-paste experience 

The current directory is typically not on the user's $PATH.
This commit is contained in:
Zack M. Davis 2018-06-02 21:58:53 -07:00 committed by Who? Me?!
parent 247ff14a43
commit e39c13d458
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/rustdoc.md
View File

@ -33,13 +33,13 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
## Cheat sheet ## Cheat sheet
* Use `x.py build --stage 1 src/libstd src/tools/rustdoc` to make a useable * Use `./x.py build --stage 1 src/libstd src/tools/rustdoc` to make a useable
rustdoc you can run on other projects. rustdoc you can run on other projects.
* Add `src/libtest` to be able to use `rustdoc --test`. * Add `src/libtest` to be able to use `rustdoc --test`.
* If you've used `rustup toolchain link local /path/to/build/$TARGET/stage1` * If you've used `rustup toolchain link local /path/to/build/$TARGET/stage1`
previously, then after the previous build command, `cargo +local doc` will previously, then after the previous build command, `cargo +local doc` will
Just Work. Just Work.
* Use `x.py doc --stage 1 src/libstd` to use this rustdoc to generate the * Use `./x.py doc --stage 1 src/libstd` to use this rustdoc to generate the
standard library docs. standard library docs.
* The completed docs will be available in `build/$TARGET/doc/std`, though the * The completed docs will be available in `build/$TARGET/doc/std`, though the
bundle is meant to be used as though you would copy out the `doc` folder to bundle is meant to be used as though you would copy out the `doc` folder to