Skip to content

Commit

Permalink
Reorganize and expand the testing chapters. (rust-lang#1281)
Browse files Browse the repository at this point in the history
* Reorganize and expand the testing chapters.

* Update tests chapters for review comments.

* Fix typo.
  • Loading branch information
ehuss authored Jan 18, 2022
1 parent 4d46bd0 commit 78dd6a4
Show file tree
Hide file tree
Showing 14 changed files with 2,055 additions and 1,100 deletions.
3 changes: 3 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,6 @@ follow-web-links = true
exclude = [ "crates\\.io", "gcc\\.godbolt\\.org", "youtube\\.com", "youtu\\.be", "dl\\.acm\\.org", "cs\\.bgu\\.ac\\.il", "www\\.amazon\\.com", "www\\.rustaceans\\.org", "play\\.rust-lang\\.org" ]
cache-timeout = 86400
warning-policy = "error"

[output.html.redirect]
"/compiletest.html" = "tests/compiletest.html"
10 changes: 8 additions & 2 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,16 @@
- [Documenting Compiler](./building/compiler-documenting.md)
- [Rustdoc overview](./rustdoc.md)
- [Adding a new target](./building/new-target.md)
- [The compiler testing framework](./tests/intro.md)
- [Testing the compiler](./tests/intro.md)
- [Running tests](./tests/running.md)
- [Testing with Docker](./tests/docker.md)
- [Testing with CI](./tests/ci.md)
- [Adding new tests](./tests/adding.md)
- [Using `compiletest` commands to control test execution](./compiletest.md)
- [Compiletest](./tests/compiletest.md)
- [UI tests](./tests/ui.md)
- [Test headers](./tests/headers.md)
- [Performance testing](./tests/perf.md)
- [Crater](./tests/crater.md)
- [Debugging the Compiler](./compiler-debugging.md)
- [Using the tracing/logging instrumentation](./tracing.md)
- [Profiling the compiler](./profiling.md)
Expand Down
223 changes: 0 additions & 223 deletions src/compiletest.md

This file was deleted.

7 changes: 2 additions & 5 deletions src/profiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@ This section talks about how to profile the compiler and find out where it spend

Depending on what you're trying to measure, there are several different approaches:

- If you want to see if a PR improves or regresses compiler performance:
- The [rustc-perf](https://github.com/rust-lang/rustc-perf) project makes this easy and can be triggered to run on a PR via the `@rust-timer` bot.
The `@bors try @rust-timer queue` command, in a comment on the PR, will queue a try build and a
benchmarking run.
Note: you need `try` privileges to be able to do this. More details are available in the [perf collector documentation](https://github.com/rust-lang/rustc-perf/blob/master/collector/README.md).
- If you want to see if a PR improves or regresses compiler performance,
see the [rustc-perf chapter](tests/perf.md) for requesting a benchmarking run.

- If you want a medium-to-high level overview of where `rustc` is spending its time:
- The `-Z self-profile` flag and [measureme](https://github.com/rust-lang/measureme) tools offer a query-based approach to profiling.
Expand Down
Loading

0 comments on commit 78dd6a4

Please sign in to comment.