Skip to content

proposed copy edits to rustdoc chapter #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 26, 2018
Merged

proposed copy edits to rustdoc chapter #150

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6478c2b
include `./` in example x.py commands for smoother copy-paste experience
zackmdavis Jun 3, 2018
824c5c2
don't mention new rustdoc
zackmdavis Jun 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions src/rustdoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# The walking tour of rustdoc

Rustdoc actually uses the rustc internals directly. It lives in-tree with the
compiler and standard library. This chapter is about how it works. (A new
implementation is also [under way], though).

[under way]: https://github.com/steveklabnik/rustdoc
compiler and standard library. This chapter is about how it works.

Rustdoc is implemented entirely within the crate [`librustdoc`][rd]. It runs
the compiler up to the point where we have an internal representation of a
Expand Down Expand Up @@ -33,13 +30,13 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)

## 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.
* Add `src/libtest` to be able to use `rustdoc --test`.
* If you've used `rustup toolchain link local /path/to/build/$TARGET/stage1`
previously, then after the previous build command, `cargo +local doc` will
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.
* 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
Expand Down