Commit Graph

46 Commits

Author SHA1 Message Date
bit-aloo e4ddc21c8a
replace config.toml to bootstrap.toml in src:doc:rustc-dev-guide 2025-03-17 12:56:44 +05:30
Stuart Cook 6637742182 Remove stale implementation details of coverage instrumentation (#2179)
This level of detail in the dev guide is a maintenance burden; better to leave
this sort of thing to in-tree comments.
2024-12-30 12:02:52 +11:00
Tshepang Mbambo 4ff8d9a171 still accurate (#2133) 2024-11-10 13:18:32 +08:00
Martin Liška be78802b46 Fix broken links (#2123) 2024-11-04 16:24:05 +08:00
Stuart Cook 0e2bebfe2d Rename `needs-profiler-support` to `needs-profiler-runtime` (#2095) 2024-10-10 09:27:13 +11:00
Martin Liška 9a13c75f11 linkcheck: fix reported broken links (part 2) (#2024)
* linkcheck: fix reported broken links (part 2)

* Apply suggestions from code review

Co-authored-by: León Orell Valerian Liehr <me@fmease.dev>

* Fix mir::Constant link target

* Fix borked links

* Fix one more link name

* Exclude 2 links from checking

* Fix exclude patterns in book.toml

* Fix comment

* Fix rmake-tests URL

* Apply suggestions from code review

Co-authored-by: León Orell Valerian Liehr <me@fmease.dev>

---------

Co-authored-by: León Orell Valerian Liehr <me@fmease.dev>
2024-07-27 14:45:57 +02:00
Tshepang Mbambo ab06b10c89 typo (#2029) 2024-07-26 15:31:20 -07:00
Stuart Cook 47b72731d7 Fix broken links in `llvm-coverage-instrumentation.md` (#2027) 2024-07-26 21:19:51 +08:00
Eric Huss ae9c529137 Update for upcoming markdown changes. (#1880) 2024-02-07 10:23:35 -03:00
Zalathar c829322db7 Prominently mention `profiler = true` on the coverage page
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`.
2023-12-30 11:58:25 +02:00
Zalathar a19ce0794b Update documentation for coverage tests 2023-11-08 16:43:50 +02:00
Zalathar c6f1dc58ba Update some outdated descriptions of coverage instrumentation 2023-11-04 01:17:57 +00:00
Stuart Cook c9eae9076d Remove outdated references to coverage debug code (#1797) 2023-09-22 01:32:45 +09:00
Zalathar 5813662ef3 Revise the docs for coverage instrumentation tests 2023-09-11 23:29:18 +02:00
Tshepang Mbambo 7d6d076db5 make link more pleasant to eye too (#1778) 2023-09-11 19:36:36 +09:00
Tshepang Mbambo 87bd0a01fc remove (excessive) indentation (#1781) 2023-08-27 10:02:25 +09:00
Tshepang Mbambo 0e51bb3360 coverage tests have moved, twice (#1780) 2023-08-27 10:02:12 +09:00
Tshepang Mbambo b8367d2477 remove extraneous word (#1779) 2023-08-27 10:01:25 +09:00
Tshepang Mbambo cc5922b1d2 llvm updates (#1761) 2023-08-27 10:00:45 +09:00
Tshepang Mbambo 8d2fafe1dd make link more pleasant to eye (#1777) 2023-08-27 10:00:20 +09:00
Tshepang Mbambo 5264530f0b indicate full hierarchy of config option (#1776) 2023-08-27 09:58:31 +09:00
Tshepang Mbambo 24688cbfde it is lower-case (#1772) 2023-08-27 09:50:02 +09:00
Emmanuel Ferdman 726dacd3ef fix: update link to function coverage (#1727) 2023-07-09 23:50:50 +09:00
Tshepang Mbambo ae58f5820d tests/run-make files have moved 2023-07-03 09:36:22 +02:00
sslime336 a04ad82e3c Change `./x.py` into `./x` 2023-06-30 23:11:14 +02:00
Eric Huss 1b6f93987d Fix some links 2023-06-29 06:43:19 +02:00
Tshepang Mbambo 45eb9121e0 llvm 13 is now not supported (#1612) 2023-02-18 22:20:46 +09:00
Yuki Okushi 56c7d9f97c Address the change in https://github.com/rust-lang/rust/pull/99715
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
Tshepang Mbambo ac46c61184 version 5 is now not supported (#1568) 2023-01-27 19:09:37 +09:00
Albert Larsan d4ec98736e Change `src/test` to `tests` (#1547) 2023-01-13 07:31:47 +09:00
Tshepang Mbambo 8194045511 make date-check more lightweight (#1394)
* make date-check lightweight

This avoids having to write the date twice when updating date-check.

Before "As of <-- 2022-07 --> July 2022"
After "As of July 2022"

* please clippy

* update date-check docs

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#pullrequestreview-1042163557

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#pullrequestreview-1042167261

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#issuecomment-1189105017

* this breaks markdown

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018268

This led to a more robust regex, though making the tool more picky.
It also found a wrong date format that was missed.

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018419

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018816

* accept review suggestion

This was reverted by mistake

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934019395

* use a more simple fn

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018981

Much more clean

* nit

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* avoid a failed regex

Also, test new shape

* adjust to new regex (which uses named groups)

New regex was introduced by 456008cc35

Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-08-02 13:50:32 -07:00
Eric Huss 55ee2bb081 instrument-coverage has been stabilized. 2022-02-20 13:59:23 -08:00
Eric Huss d3cc250a1c symbol-mangling-version has been stabilized 2022-02-20 13:59:23 -08:00
Rich Kadel 2531a18d3b Update LLVM coverage mapping format version supported by rustc (#1267)
rust-lang/rust#91207 updates the coverage mapping format to Version 5 or
6, depending on the built-in version of LLVM (12 or 13, respectively).

This change updates the dev guide to match the recent changes.
2021-12-03 09:26:47 -08:00
Lucas Kent 363f6ce09c Spelling fixes 2021-11-15 08:23:01 -06:00
Janggun Lee d03c7b8626 Fix `rustc_mir` related links (#1228)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: nhamovitz <18648574+nhamovitz@users.noreply.github.com>
2021-10-29 00:58:26 +09:00
Tomasz Miąsko ee746de3af s/--blessed/--bless/ 2021-09-19 10:36:26 -05:00
Rich Kadel 412d1a75ab Update coverage docs (#1122) 2021-05-13 19:19:43 -07:00
Camelid f7049a868c Fix date-check comment formatting (#1066)
I realized that the format I had been previously using for date-checks

    (as of January 2021 <!-- date: 2021-01 -->)

left a space before the closing parenthesis in the rendered output,
which looks weird.

I could fix this by removing the space between `2021` and `<!-- ...`,
but that looks weird in the source. So I ended up deciding on changing
it to

    (as of <!-- date: 2021-01 --> January 2021)
2021-02-20 19:24:01 -08:00
Yuki Okushi 50e53ccffa Point to main branch on llvm-project's links 2021-02-19 20:25:36 -05:00
Camelid 6e02970f7f Add lots of date-check annotations
Also added dates for things that previously said "as of now" or "as of
this writing" and cleaned up a couple of things along the way.
2021-02-03 19:29:07 -05:00
Iñaki Garay 7a80b01e01 Add mdbook-toc, markers, and documentation (#1028)
* Add mdbook-toc to travis, book.toml  and documentation

* Add toc markers

* Whitespace cleanup and some punctuation

* Addressed comments
2021-01-20 14:33:11 -03:00
Iñaki Garay cd437dc04f Add context to dated information (#1013)
* Fixes #924 Add context to dated information

* Fixes #924 Addressed comments and some uses of 'currently'

* Update src/contributing.md

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

* Update src/salsa.md

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

* Fixes #924 Addressed comments

* Fixes #924 Fixed line lengths.

Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-10 19:23:22 -03:00
Iñaki Garay 7268945c0f rustc invocation standarized (#992)
* rustc invocation standarized

* Addressed comments

* Addressed comments

* Addressed comments

* Updated command output
2020-12-28 23:34:51 +01:00
Yuki Okushi 4e871ea1db Fix some link failures and typos 2020-12-11 16:00:15 -05:00
Rich Kadel a7c82e3ba9 Adds a dev guide section on Rust Coverage 2020-12-07 14:22:45 -05:00