make doc/tutorial.html
- build the tutorialmake check-stage1-doc-tutorial
- test the examples in the tutorial
make doc/std/index.html
- build the API docs forstd
make check-stage1-doc-crate-std
- teststd
rm tmp/*ok
- delete previous test results. The test runner will not run if it thinks the tests have already been completely successfully. Run this to reset.- Add
NO_REBUILD=1
to avoid rebuilding Rust when making changes to API docs or tests - Add
TESTNAME=foo
to yourmake
command to limit the set of tests being run.
NO_REBUILD=1
allows docs and tests to be built and run without recompiling Rust. This is useful for iterating on docs and tests in the standard libraries without lengthy rebuilds.
e.g. a typical command I might use for iterating on docs is rm tmp/*ok; make check-stage1-doc-crate-std NO_REBUILD=1 TESTNAME=io::net
To work on the tutorial do the following:
make
- Build Rust so all the tooling is ready- Edit
src/doc/tutorial.md
- Run
make doc/tutorial.html NO_REBUILD=1
to build the doc - Run
make check-stage1-doc-tutorial NO_REBUILD=1
to test the examples - Goto 2