Add test linking #1646

ehuss · 2024-10-08T00:09:15Z

This adds the ability to link rust-lang/rust tests to reference rule annotations. Rules now have a link that pops up a list of tests that are associated with that rule. Additionally, there is a new appendix that lists the number of rules in each chapter, how many tests are associated, and various summaries.

This requires a local checkout of rust-lang/rust which is pointed to by the SPEC_RUST_ROOT environment variable.

chorman0773

Looks to be working. The summary appendex is decent.

All of the rules were listed as not having tests, but I don't know whether that's because there aren't any yet or because it wasn't picking them up.

There should otherwise be no code changes here.

This is in preparation for error handling in future commits.

This adds a "Rules" struct which encapsulates the rules in the document. This also removes some of the mutable variables. This is paving the way for future updates which extends information and processing about rules.

This adds tracking of rule prefixes (like `asm.ts-args` is an interior prefix of `asm.ts-args.syntax`). This will be used for test linking, to check for tests that link to these. I'm not sure what we'll want to do with these long-term, whether we want to allow linking these "uber" rules, or remove them, or just warn about them.

This adds the ability to link rust-lang/rust tests to reference rule annotations. Rules now have a link that pops up a list of tests that are associated with that rule. Additionally, there is a new appendix that lists the number of rules in each chapter, how many tests are associated, and various summaries. This requires a local checkout of rust-lang/rust which is pointed to by the `SPEC_RUST_ROOT` environment variable.

ehuss · 2024-10-21T15:53:26Z

Thanks! Yea, there aren't any tests linked, yet. I was thinking about adding a few from one of the simpler chapters as a demonstration.

I'm going to go ahead and merge. I expect this to go through some iterations over time.

In rust-lang#1646 I accidentally changed the visibility of `Spec::new`. It needs to be `pub` in order to work in the upstream integration.

Update books ## rust-lang/edition-guide 7 commits in c7ebae25cb4801a31b6f05353f6d85bfa6feedd1..1f07c242f8162a711a5ac5a4ea8fa7ec884ee7a9 2024-10-21 14:29:49 UTC to 2024-10-19 19:08:20 UTC - 2024: Add reserved syntax (rust-lang/edition-guide#326) - Update stdout of `cargo new` (rust-lang/edition-guide#327) - Don't run doctests on rustfmt ident sorting page - add rustfmt raw identifer sorting doc (rust-lang/edition-guide#321) - Add some tips for what to be careful of with rustdoc-doctests (rust-lang/edition-guide#323) - Remove cargo-remove-implicit-features (rust-lang/edition-guide#324) - Rename doctest standalone tag (rust-lang/edition-guide#325) ## rust-embedded/book 1 commits in f40a8b420ec4b4505d9489965e261f1d5c28ba23..ddbf1b4e2858fedb71b7c42eb15c4576517dc125 2024-10-13 19:53:37 UTC to 2024-10-13 19:53:37 UTC - Add link to Cortex-M comparison to install.md (rust-embedded/book#378) ## rust-lang/reference 29 commits in c64e52a3d306eac0129f3ad6c6d8806ab99ae2e9..23ce619966541bf2c80d45fdfeecf3393e360a13 2024-10-05 00:33:03 +0000 to 2024-10-22 21:34:51 +0000 - Mention `--print cfg` under set configuration options (rust-lang/reference#1636) - Fix `pat` fragment specifier to be the "current" edition (rust-lang/reference#1640) - Add restriction for cfg_attr with crate_type and crate_name (rust-lang/reference#1649) - Sort macro fragment specifiers (rust-lang/reference#1641) - Document mixed-site hygiene (rust-lang/reference#1656) - Clarify that "macro attributes" refers to proc macros (rust-lang/reference#1660) - mdbook-spec: Fix Spec::new creation (rust-lang/reference#1658) - Fix stdcall example broken by recent rustc change (rust-lang/reference#1659) - Add spec identifiers to const_eval.md (rust-lang/reference#1569) - Add identifier syntax to trait-bounds.md (rust-lang/reference#1631) - Add identifier syntax to macro-ambiguity.md (rust-lang/reference#1634) - Add spec identifier syntax to conditional-compilation.md (rust-lang/reference#1564) - Add spec identifiers to behaviour-considered-undefined.md (rust-lang/reference#1562) - Add test linking (rust-lang/reference#1646) - Allow `deny` inside `forbid` as a no-op (rust-lang/reference#1655) - Add identifier syntax to identifiers.md (rust-lang/reference#1583) - Add spec identifiers to crates-and-source-files.md (rust-lang/reference#1570) - Add identifier syntax to linkage.md (rust-lang/reference#1633) - Add identifier syntax to type-coercions.md (rust-lang/reference#1632) - Add identifiers to variables.md (rust-lang/reference#1626) - Add identifier syntax to lexer chapters (rust-lang/reference#1620) - Add spec identifier syntax to `unsafe-keyword.md` and `unsafety.md` (rust-lang/reference#1619) - Add identifier syntax to types and subchapters. (rust-lang/reference#1618) - Add identifier syntax to subtyping.md (rust-lang/reference#1613) - Add identifier syntax to statements.md (rust-lang/reference#1611) - Add identifier syntax to type-layout.md (rust-lang/reference#1614) - Clarify definition of "immutable bytes" (rust-lang/reference#1637) - Add preview artifacts in CI (rust-lang/reference#1647) - trait bounds grammar: make `?` and `for<>` mutually exclusive (rust-lang/reference#1650) ## rust-lang/rustc-dev-guide 5 commits in 07bc9ca9eb1cd6d9fbbf758c2753b748804a134f..59d94ea75a0b157e148af14c73c2dd60efb7b60a 2024-10-21 02:30:07 UTC to 2024-10-07 21:12:09 UTC - Add the WASM | WASI | Emscripten notification groups (rust-lang/rustc-dev-guide#2100) - Update bootstrapping.md (rust-lang/rustc-dev-guide#1900) - Rename `needs-profiler-support` to `needs-profiler-runtime` (rust-lang/rustc-dev-guide#2095) - Document compiletest directives `ignore-coverage-map` and `ignore-coverage-run` (rust-lang/rustc-dev-guide#2094) - Purge `run-pass-valgrind` mentions (rust-lang/rustc-dev-guide#2091)

ehuss mentioned this pull request Oct 10, 2024

Add a link for the reference compiletest header rust-lang/rustc-dev-guide#2096

Draft

chorman0773 approved these changes Oct 10, 2024

View reviewed changes

ehuss added 10 commits October 12, 2024 08:20

Move rules handling to its own module

42e435c

There should otherwise be no code changes here.

Move Spec creation out of main

f99b45a

This is in preparation for error handling in future commits.

Move rule collection into a separate pass with a new structure

160bb6a

This adds a "Rules" struct which encapsulates the rules in the document. This also removes some of the mutable variables. This is paving the way for future updates which extends information and processing about rules.

More directly document the SPEC_RELATIVE environment variable

c44b031

Document SPEC_DENY_WARNINGS

84414cc

Link the appendix

d5c6fb1

Add a little clarity around who is responsible for what

603ab3d

CI: Update preview job to include test links

4d83b0b

ehuss force-pushed the test-summary branch from 7c0d8d2 to 4d83b0b Compare October 12, 2024 15:22

ehuss added this pull request to the merge queue Oct 21, 2024

Merged via the queue into rust-lang:master with commit cf88463 Oct 21, 2024
5 checks passed

rustbot mentioned this pull request Oct 21, 2024

Update books rust-lang/rust#132007

Merged

ehuss added a commit to ehuss/reference that referenced this pull request Oct 21, 2024

mdbook-spec: Fix Spec::new visibility

6479450

In rust-lang#1646 I accidentally changed the visibility of `Spec::new`. It needs to be `pub` in order to work in the upstream integration.

ehuss mentioned this pull request Oct 21, 2024

mdbook-spec: Fix Spec::new creation #1658

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add test linking #1646

Add test linking #1646

ehuss commented Oct 8, 2024

chorman0773 left a comment

ehuss commented Oct 21, 2024

Add test linking #1646

Add test linking #1646

Conversation

ehuss commented Oct 8, 2024

chorman0773 left a comment

Choose a reason for hiding this comment

ehuss commented Oct 21, 2024