Skip to content

Commit f7d75a5

Browse files
committed
Auto merge of #142242 - matthiaskrgr:rollup-1sgx0ji, r=matthiaskrgr
Rollup of 7 pull requests Successful merges: - rust-lang/rust#129121 (Stabilize `tcp_quickack`) - rust-lang/rust#142192 (De-duplicate f16 & f128 doctest attributes) - rust-lang/rust#142193 (add tests for pattern binding drop order edge cases) - rust-lang/rust#142222 (Dont make `ObligationCtxt`s with diagnostics unnecessarily) - rust-lang/rust#142228 (rustc-dev-guide subtree update) - rust-lang/rust#142231 (Run `calculate_matrix` job on `master` to cache citool builds) - rust-lang/rust#142232 (add `Cargo.lock` to CI-rustc allowed list for non-CI env) r? `@ghost` `@rustbot` modify labels: rollup
2 parents 85315be + cfdc5f1 commit f7d75a5

File tree

16 files changed

+230
-275
lines changed

16 files changed

+230
-275
lines changed

rust-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
c68032fd4c442d275f4daa571ba19c076106b490
1+
c31cccb7b5cc098b1a8c1794ed38d7fdbec0ccb0

src/SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,8 @@
6363
- [Notification groups](notification-groups/about.md)
6464
- [Apple](notification-groups/apple.md)
6565
- [ARM](notification-groups/arm.md)
66-
- [Cleanup Crew](notification-groups/cleanup-crew.md)
6766
- [Emscripten](notification-groups/emscripten.md)
6867
- [Fuchsia](notification-groups/fuchsia.md)
69-
- [LLVM](notification-groups/llvm.md)
7068
- [RISC-V](notification-groups/risc-v.md)
7169
- [Rust for Linux](notification-groups/rust-for-linux.md)
7270
- [WASI](notification-groups/wasi.md)
@@ -101,6 +99,8 @@
10199
- [Rustdoc internals](./rustdoc-internals.md)
102100
- [Search](./rustdoc-internals/search.md)
103101
- [The `rustdoc` test suite](./rustdoc-internals/rustdoc-test-suite.md)
102+
- [The `rustdoc-gui` test suite](./rustdoc-internals/rustdoc-gui-test-suite.md)
103+
- [The `rustdoc-json` test suite](./rustdoc-internals/rustdoc-json-test-suite.md)
104104
- [Autodiff internals](./autodiff/internals.md)
105105
- [Installation](./autodiff/installation.md)
106106
- [How to debug](./autodiff/debugging.md)

src/building/bootstrapping/debugging-bootstrap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Bootstrap will conditionally build `tracing` support and enable `tracing` output
5555

5656
Example basic usage[^just-trace]:
5757

58-
[^just-trace]: It is not recommend to use *just* `BOOTSTRAP_TRACING=TRACE` because that will dump *everything* at `TRACE` level, including logs intentionally gated behind custom targets as they are too verbose even for `TRACE` level by default.
58+
[^just-trace]: It is not recommended to use *just* `BOOTSTRAP_TRACING=TRACE` because that will dump *everything* at `TRACE` level, including logs intentionally gated behind custom targets as they are too verbose even for `TRACE` level by default.
5959

6060
```bash
6161
$ BOOTSTRAP_TRACING=bootstrap=TRACE ./x build library --stage 1

src/getting-started.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,6 @@ feel comfortable jumping straight into the large `rust-lang/rust` codebase.
158158
The following tasks are doable without much background knowledge but are
159159
incredibly helpful:
160160

161-
- [Cleanup crew][iceb]: find minimal reproductions of ICEs, bisect
162-
regressions, etc. This is a way of helping that saves a ton of time for
163-
others to fix an error later.
164161
- [Writing documentation][wd]: if you are feeling a bit more intrepid, you could try
165162
to read a part of the code and write doc comments for it. This will help you
166163
to learn some part of the compiler while also producing a useful artifact!
@@ -179,7 +176,6 @@ incredibly helpful:
179176
[users]: https://users.rust-lang.org/
180177
[so]: http://stackoverflow.com/questions/tagged/rust
181178
[community-library]: https://github.com/rust-lang/rfcs/labels/A-community-library
182-
[iceb]: ./notification-groups/cleanup-crew.md
183179
[wd]: ./contributing.md#writing-documentation
184180
[wg]: https://rust-lang.github.io/compiler-team/working-groups/
185181
[triage]: ./contributing.md#issue-triage

src/notification-groups/about.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,7 @@ search for existing issues that haven't been claimed yet.
2121
Here's the list of the notification groups:
2222
- [Apple](./apple.md)
2323
- [ARM](./arm.md)
24-
- [Cleanup Crew](./cleanup-crew.md)
2524
- [Emscripten](./emscripten.md)
26-
- [LLVM Icebreakers](./llvm.md)
2725
- [RISC-V](./risc-v.md)
2826
- [WASI](./wasi.md)
2927
- [WebAssembly](./wasm.md)
@@ -64,9 +62,7 @@ Example PRs:
6462

6563
* [Example of adding yourself to the Apple group.](https://github.com/rust-lang/team/pull/1434)
6664
* [Example of adding yourself to the ARM group.](https://github.com/rust-lang/team/pull/358)
67-
* [Example of adding yourself to the Cleanup Crew.](https://github.com/rust-lang/team/pull/221)
6865
* [Example of adding yourself to the Emscripten group.](https://github.com/rust-lang/team/pull/1579)
69-
* [Example of adding yourself to the LLVM group.](https://github.com/rust-lang/team/pull/140)
7066
* [Example of adding yourself to the RISC-V group.](https://github.com/rust-lang/team/pull/394)
7167
* [Example of adding yourself to the WASI group.](https://github.com/rust-lang/team/pull/1580)
7268
* [Example of adding yourself to the WebAssembly group.](https://github.com/rust-lang/team/pull/1581)
@@ -81,9 +77,7 @@ group. For example:
8177
```text
8278
@rustbot ping apple
8379
@rustbot ping arm
84-
@rustbot ping cleanup-crew
8580
@rustbot ping emscripten
86-
@rustbot ping icebreakers-llvm
8781
@rustbot ping risc-v
8882
@rustbot ping wasi
8983
@rustbot ping wasm
@@ -92,12 +86,12 @@ group. For example:
9286

9387
To make some commands shorter and easier to remember, there are aliases,
9488
defined in the [`triagebot.toml`] file. For example, all of these commands
95-
are equivalent and will ping the Cleanup Crew:
89+
are equivalent and will ping the Apple group:
9690

9791
```text
98-
@rustbot ping cleanup
99-
@rustbot ping bisect
100-
@rustbot ping reduce
92+
@rustbot ping apple
93+
@rustbot ping macos
94+
@rustbot ping ios
10195
```
10296

10397
Keep in mind that these aliases are meant to make humans' life easier.

src/notification-groups/cleanup-crew.md

Lines changed: 0 additions & 90 deletions
This file was deleted.

src/notification-groups/llvm.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

src/rustdoc-internals.md

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -270,35 +270,6 @@ in `test.rs` is the function `make_test`, which is where hand-written
270270
Some extra reading about `make_test` can be found
271271
[here](https://quietmisdreavus.net/code/2018/02/23/how-the-doctests-get-made/).
272272

273-
## Dotting i's And Crossing t's
274-
275-
So that's `rustdoc`'s code in a nutshell, but there's more things in the
276-
compiler that deal with it. Since we have the full `compiletest` suite at hand,
277-
there's a set of tests in `tests/rustdoc` that make sure the final `HTML` is
278-
what we expect in various situations. These tests also use a supplementary
279-
script, `src/etc/htmldocck.py`, that allows it to look through the final `HTML`
280-
using `XPath` notation to get a precise look at the output. The full
281-
description of all the commands available to `rustdoc` tests (e.g. [`@has`] and
282-
[`@matches`]) is in [`htmldocck.py`].
283-
284-
To use multiple crates in a `rustdoc` test, add `//@ aux-build:filename.rs`
285-
to the top of the test file. `filename.rs` should be placed in an `auxiliary`
286-
directory relative to the test file with the comment. If you need to build
287-
docs for the auxiliary file, use `//@ build-aux-docs`.
288-
289-
In addition, there are separate tests for the search index and `rustdoc`'s
290-
ability to query it. The files in `tests/rustdoc-js` each contain a
291-
different search query and the expected results, broken out by search tab.
292-
These files are processed by a script in `src/tools/rustdoc-js` and the `Node.js`
293-
runtime. These tests don't have as thorough of a writeup, but a broad example
294-
that features results in all tabs can be found in `basic.js`. The basic idea is
295-
that you match a given `QUERY` with a set of `EXPECTED` results, complete with
296-
the full item path of each item.
297-
298-
[`@has`]: https://github.com/rust-lang/rust/blob/master/src/etc/htmldocck.py#L39
299-
[`@matches`]: https://github.com/rust-lang/rust/blob/master/src/etc/htmldocck.py#L44
300-
[`htmldocck.py`]: https://github.com/rust-lang/rust/blob/master/src/etc/htmldocck.py
301-
302273
## Testing Locally
303274

304275
Some features of the generated `HTML` documentation might require local
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# The `rustdoc-gui` test suite
2+
3+
> **FIXME**: This section is a stub. Please help us flesh it out!
4+
5+
This page is about the test suite named `rustdoc-gui` used to test the "GUI" of `rustdoc` (i.e., the HTML/JS/CSS as rendered in a browser).
6+
For other rustdoc-specific test suites, see [Rustdoc test suites].
7+
8+
These use a NodeJS-based tool called [`browser-UI-test`] that uses [puppeteer] to run tests in a headless browser and check rendering and interactivity. For information on how to write this form of test, see [`tests/rustdoc-gui/README.md`][rustdoc-gui-readme] as well as [the description of the `.goml` format][goml-script]
9+
10+
[Rustdoc test suites]: ../tests/compiletest.md#rustdoc-test-suites
11+
[`browser-UI-test`]: https://github.com/GuillaumeGomez/browser-UI-test/
12+
[puppeteer]: https://pptr.dev/
13+
[rustdoc-gui-readme]: https://github.com/rust-lang/rust/blob/master/tests/rustdoc-gui/README.md
14+
[goml-script]: https://github.com/GuillaumeGomez/browser-UI-test/blob/master/goml-script.md
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# The `rustdoc-json` test suite
2+
3+
> **FIXME**: This section is a stub. It will be populated by [PR #2422](https://github.com/rust-lang/rustc-dev-guide/pull/2422/).

0 commit comments

Comments
 (0)