|
31 | 31 | #
|
32 | 32 | # * uninstall - Uninstall the binaries
|
33 | 33 | #
|
34 |
| -# For hot tips on working with The Rust Build System, just: |
| 34 | +# For tips on working with The Rust Build System, just: |
35 | 35 | #
|
36 |
| -# type `make hot-tips` |
| 36 | +# run `make tips` |
37 | 37 | #
|
38 | 38 | # Otherwise
|
39 | 39 | #
|
40 |
| -# type `make` |
| 40 | +# run `make` |
41 | 41 | #
|
42 | 42 | # </help>
|
43 | 43 | #
|
44 |
| -# <hottips> |
| 44 | +# <tips> |
45 | 45 | #
|
46 | 46 | # # The Rust Build System Tip Line
|
47 | 47 | #
|
|
52 | 52 | # * check-$(crate) - Test a crate, e.g. `check-std`
|
53 | 53 | # * check-ref - Run the language reference tests
|
54 | 54 | # * check-docs - Test the documentation examples
|
55 |
| -# |
56 |
| -# TODO: Lots more |
| 55 | +# * check-stage$(stage)-$(crate) - Test a crate in a specific stage |
| 56 | +# * check-stage$(stage)-{rpass,rfail,cfail,rmake,...} - Run tests in src/test/ |
| 57 | +# * check-stage1-T-$(target)-H-$(host) - Run cross-compiled-tests |
57 | 58 | #
|
58 | 59 | # Then mix in some of these environment variables to harness the
|
59 | 60 | # ultimate power of The Rust Build System.
|
|
71 | 72 | #
|
72 | 73 | # * `NO_REBUILD=1` - Don't rebootstrap when testing std
|
73 | 74 | # (and possibly other crates)
|
74 |
| -# * `NO_MKFILE_DEPS=1` - Don rebuild for modified .mk files |
| 75 | +# * `NO_MKFILE_DEPS=1` - Don't rebuild for modified .mk files |
75 | 76 | #
|
76 | 77 | # * `SAVE_TEMPS=1` - Use `--save-temps` flag on all `rustc` invocations
|
77 | 78 | # * `ASM_COMMENTS=1` - Use `-Z asm-comments`
|
78 | 79 | # * `TIME_PASSES=1` - Use `-Z time-passes`
|
79 | 80 | # * `TIME_LLVM_PASSES=1` - Use `-Z time-llvm-passes`
|
80 | 81 | # * `TRACE=1` - Use `-Z trace`
|
81 | 82 | #
|
| 83 | +# # Rust recipes for build system success |
| 84 | +# |
| 85 | +# // Modifying libstd? Use this comment to run unit tests just on your change |
| 86 | +# make check-stage1-std NO_REBUILD=1 NO_BENCH=1 |
| 87 | +# |
| 88 | +# // Added a run-pass test? Use this to test running your test |
| 89 | +# make check-stage1-rpass TESTNAME=my-shiny-new-test |
| 90 | +# |
| 91 | +# // Having trouble figuring out which test is failing? Turn off parallel tests |
| 92 | +# make check-stage1-std RUST_TEST_TASKS=1 |
| 93 | +# |
82 | 94 | # This is hardly all there is to know of The Rust Build System's
|
83 | 95 | # mysteries. The tale continues on the wiki[1][2].
|
84 | 96 | #
|
85 | 97 | # [1]: https://github.com/mozilla/rust/wiki/Note-build-system
|
86 | 98 | # [2]: https://github.com/mozilla/rust/wiki/Note-testsuite
|
87 | 99 | #
|
88 |
| -# Unless you feel like getting your hands dirty, then: |
| 100 | +# If you really feel like getting your hands dirty, then: |
89 | 101 | #
|
90 |
| -# don't type `make nitty-gritty` |
| 102 | +# run `make nitty-gritty` |
91 | 103 | #
|
92 |
| -# </hottips> |
| 104 | +# </tips> |
93 | 105 | #
|
94 | 106 | # <nittygritty>
|
95 | 107 | #
|
|
0 commit comments