Prominently mention profiler = true on the coverage page
#1844
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Enabling the profiler runtime is an essential part of being able to properly work on the coverage instrumentation code. There's already a mention of it on this page, but it's made in passing and is easy to miss. This patch adds a much more prominent section containing recommended `config.toml` settings, including `profiler = true`.
|
Back when I started looking at the coverage code, this was quite a puzzle to me, so hopefully this can help others avoid the same problems. |
tshepang
approved these changes
Dec 30, 2023
fmease
added a commit
to fmease/rust
that referenced
this pull request
Jan 2, 2024
Update books ## rust-lang/reference 1 commits in f9f5b5babd95515e7028c32d6ca4d9790f64c146..3565c7978cfc9662f5963b135690ff9cbbfa0318 2023-12-29 21:01:19 UTC to 2023-12-29 21:01:19 UTC - Use proper footnote for number literals `_` separator note (rust-lang/reference#1444) ## rust-lang/rust-by-example 1 commits in 4c2b24ff9d9cf19f2fcff799a3a49b9a2c50ae8e..c0be6299e52e4164c30ba6f41bd0ad0aaee64972 2023-12-21 15:22:11 UTC to 2023-12-21 15:22:11 UTC - point to raw indentifiers, talking about fields (rust-lang/rust-by-example#1789) ## rust-lang/rustc-dev-guide 5 commits in 0610665a8687b1b0aa037917a1598b9f2a21e3ef..d13e85152a977cd0bcaf583cf5f49e86225697de 2023-12-30 09:58:25 UTC to 2023-12-19 10:02:34 UTC - Prominently mention `profiler = true` on the coverage page (rust-lang/rustc-dev-guide#1844) - Add a description of `unpretty=hir` to the HIR docs (rust-lang/rustc-dev-guide#1842) - Fix typo in unsize docs (rust-lang/rustc-dev-guide#1843) - Suggest `gcc_multi` to make `mir_opts` run on nixos (rust-lang/rustc-dev-guide#1841) - bootstrapping: Clarify that stage0 std code is not executed to produce stage1 compiler (rust-lang/rustc-dev-guide#1840)
fmease
added a commit
to fmease/rust
that referenced
this pull request
Jan 3, 2024
Update books ## rust-lang/reference 1 commits in f9f5b5babd95515e7028c32d6ca4d9790f64c146..3565c7978cfc9662f5963b135690ff9cbbfa0318 2023-12-29 21:01:19 UTC to 2023-12-29 21:01:19 UTC - Use proper footnote for number literals `_` separator note (rust-lang/reference#1444) ## rust-lang/rust-by-example 1 commits in 4c2b24ff9d9cf19f2fcff799a3a49b9a2c50ae8e..c0be6299e52e4164c30ba6f41bd0ad0aaee64972 2023-12-21 15:22:11 UTC to 2023-12-21 15:22:11 UTC - point to raw indentifiers, talking about fields (rust-lang/rust-by-example#1789) ## rust-lang/rustc-dev-guide 5 commits in 0610665a8687b1b0aa037917a1598b9f2a21e3ef..d13e85152a977cd0bcaf583cf5f49e86225697de 2023-12-30 09:58:25 UTC to 2023-12-19 10:02:34 UTC - Prominently mention `profiler = true` on the coverage page (rust-lang/rustc-dev-guide#1844) - Add a description of `unpretty=hir` to the HIR docs (rust-lang/rustc-dev-guide#1842) - Fix typo in unsize docs (rust-lang/rustc-dev-guide#1843) - Suggest `gcc_multi` to make `mir_opts` run on nixos (rust-lang/rustc-dev-guide#1841) - bootstrapping: Clarify that stage0 std code is not executed to produce stage1 compiler (rust-lang/rustc-dev-guide#1840)
fmease
added a commit
to fmease/rust
that referenced
this pull request
Jan 3, 2024
Update books ## rust-lang/reference 1 commits in f9f5b5babd95515e7028c32d6ca4d9790f64c146..3565c7978cfc9662f5963b135690ff9cbbfa0318 2023-12-29 21:01:19 UTC to 2023-12-29 21:01:19 UTC - Use proper footnote for number literals `_` separator note (rust-lang/reference#1444) ## rust-lang/rust-by-example 1 commits in 4c2b24ff9d9cf19f2fcff799a3a49b9a2c50ae8e..c0be6299e52e4164c30ba6f41bd0ad0aaee64972 2023-12-21 15:22:11 UTC to 2023-12-21 15:22:11 UTC - point to raw indentifiers, talking about fields (rust-lang/rust-by-example#1789) ## rust-lang/rustc-dev-guide 5 commits in 0610665a8687b1b0aa037917a1598b9f2a21e3ef..d13e85152a977cd0bcaf583cf5f49e86225697de 2023-12-30 09:58:25 UTC to 2023-12-19 10:02:34 UTC - Prominently mention `profiler = true` on the coverage page (rust-lang/rustc-dev-guide#1844) - Add a description of `unpretty=hir` to the HIR docs (rust-lang/rustc-dev-guide#1842) - Fix typo in unsize docs (rust-lang/rustc-dev-guide#1843) - Suggest `gcc_multi` to make `mir_opts` run on nixos (rust-lang/rustc-dev-guide#1841) - bootstrapping: Clarify that stage0 std code is not executed to produce stage1 compiler (rust-lang/rustc-dev-guide#1840)
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 3, 2024
Rollup merge of rust-lang#119492 - rustbot:docs-update, r=ehuss Update books ## rust-lang/reference 1 commits in f9f5b5babd95515e7028c32d6ca4d9790f64c146..3565c7978cfc9662f5963b135690ff9cbbfa0318 2023-12-29 21:01:19 UTC to 2023-12-29 21:01:19 UTC - Use proper footnote for number literals `_` separator note (rust-lang/reference#1444) ## rust-lang/rust-by-example 1 commits in 4c2b24ff9d9cf19f2fcff799a3a49b9a2c50ae8e..c0be6299e52e4164c30ba6f41bd0ad0aaee64972 2023-12-21 15:22:11 UTC to 2023-12-21 15:22:11 UTC - point to raw indentifiers, talking about fields (rust-lang/rust-by-example#1789) ## rust-lang/rustc-dev-guide 5 commits in 0610665a8687b1b0aa037917a1598b9f2a21e3ef..d13e85152a977cd0bcaf583cf5f49e86225697de 2023-12-30 09:58:25 UTC to 2023-12-19 10:02:34 UTC - Prominently mention `profiler = true` on the coverage page (rust-lang/rustc-dev-guide#1844) - Add a description of `unpretty=hir` to the HIR docs (rust-lang/rustc-dev-guide#1842) - Fix typo in unsize docs (rust-lang/rustc-dev-guide#1843) - Suggest `gcc_multi` to make `mir_opts` run on nixos (rust-lang/rustc-dev-guide#1841) - bootstrapping: Clarify that stage0 std code is not executed to produce stage1 compiler (rust-lang/rustc-dev-guide#1840)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enabling the profiler runtime is an essential part of being able to properly work on the coverage instrumentation code.
There's already a mention of it on this page, but it's made in passing and is easy to miss. This patch adds a much more prominent section containing recommended
config.tomlsettings, includingprofiler = true.