Skip to content

coverage attribute #1628

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 8 commits into from
Dec 18, 2024
Merged

coverage attribute #1628

merged 8 commits into from
Dec 18, 2024

Conversation

@clarfonthey
Copy link
Contributor

Since rust-lang/rust#84605 passed FCP, this adds the coverage attribute to the reference. Coverage instrumentation isn't mentioned in the reference elsewhere, as most of that information lies in the rustc book, but it feels like it should at least go here.

@clarfonthey clarfonthey mentioned this pull request Sep 23, 2024
Merged
@clarfonthey clarfonthey force-pushed the coverage branch 2 times, most recently from d4aad7c to f9f2c5c Compare September 26, 2024 02:07
@ehuss ehuss added the S-waiting-on-stabilization Waiting for a stabilization PR to be merged in the main Rust repository label Oct 22, 2024
@ehuss ehuss added the S-waiting-on-review Status: The marked PR is awaiting review from a maintainer label Dec 5, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 16, 2024
@bors
Auto merge of rust-lang#130766 - clarfonthey:stable-coverage-attribut…
15c5045 
…e, r=wesleywiser

Stabilize #[coverage] attribute

Closes rust-lang#84605, which passed FCP.

Stabilisation report here: rust-lang#84605 (comment)

Also added to reference here: rust-lang/reference#1628
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 16, 2024
@bors
Auto merge of rust-lang#130766 - clarfonthey:stable-coverage-attribut…
95f4974 
…e, r=<try>

Stabilize #[coverage] attribute

Closes rust-lang#84605, which passed FCP.

Stabilisation report here: rust-lang#84605 (comment)

Also added to reference here: rust-lang/reference#1628

---

try-job: aarch64-apple
try-job: x86_64-gnu
try-job: x86_64-msvc
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 17, 2024
@bors
Auto merge of rust-lang#130766 - clarfonthey:stable-coverage-attribut…
376a5b7 
…e, r=<try>

Stabilize #[coverage] attribute

Closes rust-lang#84605, which passed FCP.

Stabilisation report here: rust-lang#84605 (comment)

Also added to reference here: rust-lang/reference#1628

---

try-job: aarch64-apple
try-job: x86_64-gnu
try-job: x86_64-msvc
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 17, 2024
@bors
Auto merge of rust-lang#130766 - clarfonthey:stable-coverage-attribut…
1d35638 
…e, r=wesleywiser

Stabilize #[coverage] attribute

Closes rust-lang#84605, which passed FCP.

Stabilisation report here: rust-lang#84605 (comment)

Also added to reference here: rust-lang/reference#1628

---

try-job: aarch64-apple
try-job: x86_64-gnu
try-job: x86_64-msvc
@clarfonthey
Copy link
Contributor Author

(no longer waiting on stabilisation; can be merged now)

clarfonthey and others added 8 commits December 18, 2024 13:17
@clarfonthey @ehuss
Mention coverage attribute
3ff8b84
@ehuss
Unwrap text
081372c
@ehuss
Add rule annotations
f71cbc6
@ehuss
Fix formatting in builtin attribute list
6847eb7
@ehuss
Move mention of rustc to a side note
73b4272 
and link to the rustc documentation.
@ehuss
Move attributes.coverage.allowed-positions below syntax
6fe508f 
Toss up which makes more sense in sequence, but this felt a little
better to me.
@ehuss
Add an example showing the attribute in use.
d92a412
@ehuss
Extend coverage attribute documentation
b2c8b52 
This adds more details about the behavior of the `coverage` attribute,
along with some editorial changes.
ehuss
ehuss approved these changes Dec 18, 2024
View reviewed changes
Copy link
Contributor

@ehuss ehuss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ehuss ehuss added this pull request to the merge queue Dec 18, 2024
Merged via the queue into rust-lang:master with commit 9f41bc1 Dec 18, 2024
5 checks passed
@ehuss ehuss mentioned this pull request Dec 18, 2024
Merged
jhpratt added a commit to jhpratt/rust that referenced this pull request Dec 19, 2024
@jhpratt
Rollup merge of rust-lang#134388 - rustbot:docs-update, r=ehuss
fa75b4d 
Update books

## rust-lang/book

21 commits in 9900d976bbfecf4e8124da54351a9ad85ee3c7f3..ad2011d3bcad9f152d034faf7635c22506839d58
2024-12-16 16:11:34 UTC to 2024-12-05 19:19:24 UTC

- Ch. 10: clarify note about compiler errors and `'static` (rust-lang/book#4164)
- Introduce `let`-`else` statement (rust-lang/book#3702)
- Fix misleading explanation of comma in `$(),*` (rust-lang/book#3800)
- ch18-03: Matching Named Variables: mention `if let`/`while let` (rust-lang/book#3110)
- Ch. 4: Rephrase/clarify paragraph on reference scope (rust-lang/book#3688)
- Simplify note about functions in ch13-01-closures.md (rust-lang/book#3699)
- fix: make the reason more understandable (rust-lang/book#4074)
- Fixed grammatical error in the comment on line 22 (rust-lang/book#3180)
- ch17-02: Monomorphization applies to generics in general  (rust-lang/book#3367)
- Ch. 21: Use `Vec::drain` to teach alternatives to `Option` (rust-lang/book#4159)
- fix(typo): correct punctuation in ch15-06-reference-cycles.md (rust-lang/book#4155)
- Ch. 20: show both `impl Fn` and `Box<dyn Fn>` (rust-lang/book#4152)
- Add `use super::*;` to unit-test examples. (rust-lang/book#4151)
- Remove emphasis on four-space indents (rust-lang/book#4150)
- Fix `.git-blame-ignore-revs` file (rust-lang/book#4149)
- Rust 2024: distinguish `unsafe fn` vs. `unsafe` blocks (rust-lang/book#4148)
- Update README.md typo (rust-lang/book#4146)
- Ch. 15.5: account for improved error message (rust-lang/book#4142)
- Document use of rustfmt and dprint for formatting (rust-lang/book#4138)
- tools: fix nostarch build reference to mdbook-trpl (rust-lang/book#4137)
- Revise sentence to not refer to two subjects as it (rust-lang/book#4136)

## edition-guide

6 commits in 128669297c8a7fdf771042eaec18b8adfaeaf0cd..bc4ce51e1d4dacb9350a92e95f6159a42de2f8c6
2024-12-03 22:02:43 +0000 to 2024-12-18 05:34:59 +0000

- Add chapter for 2024 match ergonomics reservations (rust-lang/edition-guide#349)
- Re-title "Additions to the prelude" (rust-lang/edition-guide#348)
- Show tail expression temporary example that fails in 2024 (rust-lang/edition-guide#345)
- Add more triagebot labeling support (rust-lang/edition-guide#346)
- 2024: Assignment operator RHS indentation (rust-lang/edition-guide#341)
- 2024: Add chapter on single-line `where` clauses (rust-lang/edition-guide#340)

## rust-lang/nomicon

1 commits in 0674321898cd454764ab69702819d39a919afd68..97e84a38c94bf9362b11284c20b2cb4adaa1e868
2024-12-10 02:41:27 UTC to 2024-12-10 02:41:27 UTC

- races.md: data race -> race condition to violate memory safety (rust-lang/nomicon#470)

## reference

8 commits in ede56d1bbe132bac476b5029cd6d7508ca9572e9..9f41bc11342d46544ae0732caf14ec0bcaf27376
2024-12-03 22:26:55 +0000 to 2024-12-18 23:04:30 +0000

- `coverage` attribute (rust-lang/reference#1628)
- Clarify that `extern crate foo as føø` is allowed (rust-lang/reference#1697)
- Fix rule auto-linking on Windows (rust-lang/reference#1698)
- Reflect rust#133422 & rust#133587 to inline assembly documentation (rust-lang/reference#1695)
- Describe async closures (rust-lang/reference#1692)
- Update closures for edition 2021 disjoint closure capturing (rust-lang/reference#1521)
- Fix paragraphs with trailing `\1` (rust-lang/reference#1696)
- Add triagebot autolabel (rust-lang/reference#1694)

## rust-lang/rust-by-example

1 commits in e1d1f2cdcee4d52b9a01ff7c448be4372a377b70..76406337f4131253443aea0ed7e7f451b464117c
2024-12-07 00:24:30 UTC to 2024-12-07 00:24:30 UTC

- Fix rust-lang#1900 (rust-lang/rust-by-example#1901)

## rust-lang/rustc-dev-guide

9 commits in b21d99b..7f7ba48f04abc2ad25e52f30b5e2bffa286b019f
2024-12-16 07:12:01 UTC to 2024-12-05 05:01:46 UTC

- Specify what a CGU is (rust-lang/rustc-dev-guide#2163)
- functionality removed from codebase (part 2) (rust-lang/rustc-dev-guide#2160)
- functionality removed from codebase (rust-lang/rustc-dev-guide#2159)
- remove polymorphization (rust-lang/rustc-dev-guide#2158)
- squashing: recommend --keep-base when squashing without a conflict (rust-lang/rustc-dev-guide#2157)
- update section even more (rust-lang/rustc-dev-guide#2156)
- extend closure constraints section (rust-lang/rustc-dev-guide#2155)
- Remove `//@ compare-output-lines-by-subset` directive (rust-lang/rustc-dev-guide#2151)
- Document `needs-target-has-atomic` directive (rust-lang/rustc-dev-guide#2154)
@clarfonthey clarfonthey deleted the coverage branch December 19, 2024 04:22
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Dec 19, 2024
@rust-timer
Unrolled build for rust-lang#134388
af9a61b 
Rollup merge of rust-lang#134388 - rustbot:docs-update, r=ehuss

Update books

## rust-lang/book

21 commits in 9900d976bbfecf4e8124da54351a9ad85ee3c7f3..ad2011d3bcad9f152d034faf7635c22506839d58
2024-12-16 16:11:34 UTC to 2024-12-05 19:19:24 UTC

- Ch. 10: clarify note about compiler errors and `'static` (rust-lang/book#4164)
- Introduce `let`-`else` statement (rust-lang/book#3702)
- Fix misleading explanation of comma in `$(),*` (rust-lang/book#3800)
- ch18-03: Matching Named Variables: mention `if let`/`while let` (rust-lang/book#3110)
- Ch. 4: Rephrase/clarify paragraph on reference scope (rust-lang/book#3688)
- Simplify note about functions in ch13-01-closures.md (rust-lang/book#3699)
- fix: make the reason more understandable (rust-lang/book#4074)
- Fixed grammatical error in the comment on line 22 (rust-lang/book#3180)
- ch17-02: Monomorphization applies to generics in general  (rust-lang/book#3367)
- Ch. 21: Use `Vec::drain` to teach alternatives to `Option` (rust-lang/book#4159)
- fix(typo): correct punctuation in ch15-06-reference-cycles.md (rust-lang/book#4155)
- Ch. 20: show both `impl Fn` and `Box<dyn Fn>` (rust-lang/book#4152)
- Add `use super::*;` to unit-test examples. (rust-lang/book#4151)
- Remove emphasis on four-space indents (rust-lang/book#4150)
- Fix `.git-blame-ignore-revs` file (rust-lang/book#4149)
- Rust 2024: distinguish `unsafe fn` vs. `unsafe` blocks (rust-lang/book#4148)
- Update README.md typo (rust-lang/book#4146)
- Ch. 15.5: account for improved error message (rust-lang/book#4142)
- Document use of rustfmt and dprint for formatting (rust-lang/book#4138)
- tools: fix nostarch build reference to mdbook-trpl (rust-lang/book#4137)
- Revise sentence to not refer to two subjects as it (rust-lang/book#4136)

## edition-guide

6 commits in 128669297c8a7fdf771042eaec18b8adfaeaf0cd..bc4ce51e1d4dacb9350a92e95f6159a42de2f8c6
2024-12-03 22:02:43 +0000 to 2024-12-18 05:34:59 +0000

- Add chapter for 2024 match ergonomics reservations (rust-lang/edition-guide#349)
- Re-title "Additions to the prelude" (rust-lang/edition-guide#348)
- Show tail expression temporary example that fails in 2024 (rust-lang/edition-guide#345)
- Add more triagebot labeling support (rust-lang/edition-guide#346)
- 2024: Assignment operator RHS indentation (rust-lang/edition-guide#341)
- 2024: Add chapter on single-line `where` clauses (rust-lang/edition-guide#340)

## rust-lang/nomicon

1 commits in 0674321898cd454764ab69702819d39a919afd68..97e84a38c94bf9362b11284c20b2cb4adaa1e868
2024-12-10 02:41:27 UTC to 2024-12-10 02:41:27 UTC

- races.md: data race -> race condition to violate memory safety (rust-lang/nomicon#470)

## reference

8 commits in ede56d1bbe132bac476b5029cd6d7508ca9572e9..9f41bc11342d46544ae0732caf14ec0bcaf27376
2024-12-03 22:26:55 +0000 to 2024-12-18 23:04:30 +0000

- `coverage` attribute (rust-lang/reference#1628)
- Clarify that `extern crate foo as føø` is allowed (rust-lang/reference#1697)
- Fix rule auto-linking on Windows (rust-lang/reference#1698)
- Reflect rust#133422 & rust#133587 to inline assembly documentation (rust-lang/reference#1695)
- Describe async closures (rust-lang/reference#1692)
- Update closures for edition 2021 disjoint closure capturing (rust-lang/reference#1521)
- Fix paragraphs with trailing `\1` (rust-lang/reference#1696)
- Add triagebot autolabel (rust-lang/reference#1694)

## rust-lang/rust-by-example

1 commits in e1d1f2cdcee4d52b9a01ff7c448be4372a377b70..76406337f4131253443aea0ed7e7f451b464117c
2024-12-07 00:24:30 UTC to 2024-12-07 00:24:30 UTC

- Fix rust-lang#1900 (rust-lang/rust-by-example#1901)

## rust-lang/rustc-dev-guide

9 commits in b21d99b..7f7ba48f04abc2ad25e52f30b5e2bffa286b019f
2024-12-16 07:12:01 UTC to 2024-12-05 05:01:46 UTC

- Specify what a CGU is (rust-lang/rustc-dev-guide#2163)
- functionality removed from codebase (part 2) (rust-lang/rustc-dev-guide#2160)
- functionality removed from codebase (rust-lang/rustc-dev-guide#2159)
- remove polymorphization (rust-lang/rustc-dev-guide#2158)
- squashing: recommend --keep-base when squashing without a conflict (rust-lang/rustc-dev-guide#2157)
- update section even more (rust-lang/rustc-dev-guide#2156)
- extend closure constraints section (rust-lang/rustc-dev-guide#2155)
- Remove `//@ compare-output-lines-by-subset` directive (rust-lang/rustc-dev-guide#2151)
- Document `needs-target-has-atomic` directive (rust-lang/rustc-dev-guide#2154)
lnicola pushed a commit to lnicola/rust-analyzer that referenced this pull request Dec 23, 2024
@bors
Auto merge of #130766 - clarfonthey:stable-coverage-attribute, r=wesl…
a9740c9 
…eywiser

Stabilize #[coverage] attribute

Closes #84605, which passed FCP.

Stabilisation report here: rust-lang/rust#84605 (comment)

Also added to reference here: rust-lang/reference#1628

---

try-job: aarch64-apple
try-job: x86_64-gnu
try-job: x86_64-msvc
@ehuss ehuss mentioned this pull request Dec 30, 2024
Merged
@clarfonthey clarfonthey mentioned this pull request Dec 30, 2024
Closed
@clarfonthey clarfonthey mentioned this pull request Jan 1, 2025
Open
6 tasks
github-actions bot pushed a commit to tautschnig/verify-rust-std that referenced this pull request Mar 11, 2025
@bors
Auto merge of rust-lang#130766 - clarfonthey:stable-coverage-attribut…
7f38bd9 
…e, r=wesleywiser

Stabilize #[coverage] attribute

Closes rust-lang#84605, which passed FCP.

Stabilisation report here: rust-lang#84605 (comment)

Also added to reference here: rust-lang/reference#1628

---

try-job: aarch64-apple
try-job: x86_64-gnu
try-job: x86_64-msvc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ehuss ehuss ehuss approved these changes

Assignees

No one assigned

Labels

S-waiting-on-review Status: The marked PR is awaiting review from a maintainer S-waiting-on-stabilization Waiting for a stabilization PR to be merged in the main Rust repository

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@clarfonthey @ehuss