Commit Graph

2393 Commits

Author SHA1 Message Date
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
kim / Motoyuki Kimura 03cf281953 Add a description of `unpretty=hir` to the HIR docs (#1842) 2023-12-29 10:07:07 +09:00
Michael Goulet df5223139a Fix typo in unsize docs (#1843) 2023-12-29 10:06:18 +09:00
Nadrieril ce67594f02 Suggest `gcc_multi` to make `mir_opts` run on nixos (#1841) 2023-12-19 19:07:35 +09:00
Martin Nordholts af59355e3e bootstrapping: Clarify that stage0 std code is not executed to produce stage1 compiler (#1840) 2023-12-19 19:02:34 +09:00
jyn d53f2f6cc4 add a mailmap 2023-12-17 18:21:38 +01:00
Eric Huss cf99b58680 Move Editions chapter to "Contributing to Rust". (#1838) 2023-12-14 20:28:32 +09:00
Eric Huss cf2a10e4fb Remove feature edition fields. (#1836) 2023-12-13 21:19:43 +09:00
Eric Huss f3d449b67f Add a chapter on editions. (#1835) 2023-12-12 16:42:10 -03:00
Eric Huss b7765e5a04 Remove mentions of plugin lints (#1833) 2023-12-06 10:48:33 -03:00
Eric Huss 78e7db5870 Fix typo of unused_parens (#1832) 2023-12-05 18:08:53 -03:00
Santiago Pastorino 01c208cc70 Replace experts map with reviewers from triagebot 2023-12-05 18:40:26 +02:00
Krasimir Georgiev c80cf8cddf Update how-to-build-and-run.md
Trying out the old example command gave me:
```
error: the argument '--target <TARGET>' cannot be used multiple times
```
2023-11-28 15:13:36 +02:00
Ralf Jung b8c4cd1c36 notification groups: add information about how to ping them to the respective pages (#1818) 2023-11-27 19:08:19 -03:00
Guillaume Gomez 68d24f1546 Add explanations on how to run rustc_codegen_gcc tests (#1821) 2023-11-27 19:05:08 -03:00
Charles Lew 10b168e2c7 Add back the `canonicalization` chapter. (#1532)
* Add back the `canonicalization` chapter.

* Add a `FIXME` about reorganizing contents.
2023-11-25 18:21:53 -03:00
Aneesh e3bda8f6fb emphasize that the experts map is not up to date 2023-11-22 08:13:00 +02:00
Michael Goulet 88086cea77 Add link for unsize.md 2023-11-18 13:08:13 -08:00
David Spickett 9bb33f0013 Fix typo in contribution walkthrough (#1824) 2023-11-11 00:11:39 +09:00
Zalathar a19ce0794b Update documentation for coverage tests 2023-11-08 16:43:50 +02:00
lcnr b025ec19a2 add a new type system invariant 2023-11-06 08:14:34 -08:00
Zalathar c6f1dc58ba Update some outdated descriptions of coverage instrumentation 2023-11-04 01:17:57 +00:00
Michael Goulet 1f674ff57b Add some documentation for unsizing 2023-11-02 06:23:08 -04:00
Leonard Hübner a79c64e683 fixing author of "You Can't Spell Trust Without Rust" 2023-10-31 17:58:29 +02:00
Onur Özkan 641a617c61 remove change-id from sample build configuration (#1813) 2023-10-30 02:16:41 +09:00
Nicholas Bishop 9b4c00cc10 Update name of "active" features to "unstable" (#1814) 2023-10-30 02:16:02 +09:00
Oğuz Ağcayazı 5b000fa33a Add WF to glossary (#1810) 2023-10-22 12:18:44 +09:00
Ethan Brierley 2fb3edaa1e recommend `unpretty=hir` alongside `unpretty=hir-tree`
Previously at no point in the guide did we recommend `unpretty=hir`, only `unpretty=hir-tree`. I'm not sure if `unpretty=hir-tree` existed when this chapter was written.

related: https://github.com/rust-lang/rustc-dev-guide/issues/1159

I noticed that there's some duplicate information between here and the parent chapter https://rustc-dev-guide.rust-lang.org/hir.html I may try to merge https://rustc-dev-guide.rust-lang.org/hir-debugging.html into its parent in another PR.
2023-10-18 10:01:49 -07:00
Oli Scherer 2300d2ad31 Start a chapter about the evolving const effect system (#1808)
* Start a chapter about the evolving const effect system

* Address review comments
2023-10-18 19:35:15 +08:00
Michael Goulet 64d33dc570 Document subtle implied bounds issue in RPITIT inference (#1807) 2023-10-14 15:53:57 +02:00
Ethan Brierley 95f806352d [suggested.md] `changelog-seen` -> `change-id`` in `shell.nix`
`changelog-seen` was deprecated in https://github.com/rust-lang/rust/pull/115898

```
WARNING: The use of `changelog-seen` is deprecated. Please refer to `change-id` option in `config.example.toml` instead.
WARNING: The `change-id` is missing in the `config.toml`. This means that you will not be able to track the major changes made to the bootstrap configurations.
note: to silence this warning, add `change-id = 115898` at the top of `config.toml`
```
2023-10-11 08:30:26 +02:00
lcnr 72ff4f4045 update new trait solver docs (#1802)
* rewrite requirements/invariants

* add some more info about the trait solver

* CI

* review
2023-10-05 16:48:35 -03:00
Timo 1b826bea1d update rustc_driver examples (#1803) 2023-10-05 19:19:12 +09:00
Ethan Brierley a03082660c test headers: fix `compile-flags` example
This is more consistent with the other examples in this file such as a13b7c28ed/src/tests/headers.md?plain=1#L196 and
2023-09-28 00:57:27 +02:00
Michael Goulet 090c4eae26 impl traits 2023-09-25 07:14:41 +02:00
Jakub Beránek f7e8378ca1 Modify build instructions for optimized build (#1795) 2023-09-22 01:33:41 +09:00
Stuart Cook c9eae9076d Remove outdated references to coverage debug code (#1797) 2023-09-22 01:32:45 +09:00
Boxy 6b4bf70c2a line length limit 2023-09-19 10:19:58 -07:00
Boxy 36eddefd1a add doc and move existing stuff around 2023-09-19 10:19:58 -07:00
Ralf Jung 70eefbd73e explain the MIR const vs TY const situation 2023-09-18 03:57:13 +02:00
Tshepang Mbambo 70863da5fb fix type name (#1792) 2023-09-15 23:40:09 +09:00
Zalathar b472a7fc8c Clarify that `run-coverage` only runs in some of the CI jobs 2023-09-12 13:27:25 +02:00
Zalathar 5813662ef3 Revise the docs for coverage instrumentation tests 2023-09-11 23:29:18 +02:00
Zalathar f987fe8382 Document the `coverage-map` and `run-coverage` test suites 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 e4c3e370b1 grammar 2023-09-08 12:59:13 +02:00
Tshepang Mbambo c8113266c7 typo 2023-09-08 12:59:13 +02:00
Prashant-Shekhar-Rao a5e35dd106 Updated index.md to add a command which can show unoptimized MIR
The current playground link used in the page of MIR shows a optimized version of MIR which is missing some statements such as StorageLive . Updated to use a local command which shows unoptimized MIR that would be more useful for pedagogical purposes.
2023-09-08 12:59:13 +02:00
Jakub Beránek 3b0eb4cd62 Review changes 2023-09-05 23:14:26 +02:00
Jakub Beránek 665bd2cdcc Add section about building an optimized version of `rustc` 2023-09-05 23:14:26 +02:00
Ken 7463a803be Update minor how-to-build-and-run.md spelling mistake
As of <!-- date-check --> Aug 2023, found:
The spelling mistake "guilde" should be "guide"

This PR only makes this minor correction
2023-08-31 07:28:52 +02:00
zahash 654fd475d0 1675 move 'failed to push some refs' into its own section 2023-08-30 10:02:41 +02:00
zahash d01b87184f 1675 add a 'Squash your commits' header to 'Advanced Rebasing' section in git 2023-08-30 10:02:41 +02:00
zahash 2e94d2d71f move placement of std-dev-guide link (#1699) 2023-08-29 10:45:38 +02:00
zahash 44187c1c87 link std-dev-guide from landing page (#1699) 2023-08-29 10:45:38 +02:00
Ethan Brierley e836be4123 Reword sentence about using `./x` over `./x.py`
The current sentence was confusing when I first read it. I've reworded it to hopefully make it more clear.
2023-08-28 07:06:58 +02: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 ab4a6e1350 date-check: test suites/classes using "revisions" (#1738) 2023-08-27 09:59:53 +09:00
Tshepang Mbambo 991f770374 share link target (#1740) 2023-08-27 09:58:58 +09:00
Tshepang Mbambo 5264530f0b indicate full hierarchy of config option (#1776) 2023-08-27 09:58:31 +09:00
Tshepang Mbambo 075c46f496 remove stray word (#1773) 2023-08-27 09:50:17 +09:00
Tshepang Mbambo 24688cbfde it is lower-case (#1772) 2023-08-27 09:50:02 +09:00
Ethan Brierley a3c226d660 Suggest enabling patch-binaries-for-nix in `shell.nix` (#1774)
Bootstraps nix detection isn't always perfect:
- https://rust-lang.zulipchat.com/#narrow/stream/122651-general/topic/Bootstrapping.20on.20NixOS
- https://github.com/rust-lang/rust/issues/115073
2023-08-22 17:50:21 -04:00
Wesley Wiser 17f7bb3f76 Fix long lines 2023-08-22 15:31:14 +01:00
Wesley Wiser d6c20e4146 Add additional licensing concerns to docs
Content included from https://github.com/rust-lang/compiler-team/issues/220.
2023-08-22 15:31:14 +01:00
Tshepang Mbambo e4ace0f299 avoid repetition 2023-08-22 08:52:56 +02:00
yukang bfacba3ef7 Fix broken links format 2023-08-22 08:52:56 +02:00
Tshepang Mbambo 212b671fb4 fix link 2023-08-21 07:28:56 +02:00
Tshepang Mbambo 57ea2f5ecf missing space 2023-08-21 07:28:56 +02:00
Tshepang Mbambo d197e33e57 fix link 2023-08-21 07:28:56 +02:00
Tshepang Mbambo 10d8a46503 avoid link rot 2023-08-21 07:28:56 +02:00
yukang 384ac6ebbb update internal terminology: Substs -> GenericArgs 2023-08-21 07:28:56 +02:00
Absobel 4285421cd2 Update suggested.md
I imagine that the book meant that a full build isn't needed since it gave as an example the addition of a debug! statement
2023-08-21 06:45:47 +02:00
Yukang 5d598befed Update outdated doc for types (#1768) 2023-08-20 00:40:18 -07:00
Santiago Pastorino 5594a16f64 Add dropck documentation (#1767) 2023-08-18 23:13:31 +02:00
Emmanuel Ferdman cd25260483 fix: stabilize debugger_visualizer
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
2023-08-14 10:34:59 +02:00
İsmail Arılık de8154335f refactor(parts): remove part numbers to be consistent 2023-08-11 09:55:19 +02:00
İsmail Arılık 66d9c823b3 revert(part-5-intro): revert 4806958
I will remove part numbers after that.
2023-08-11 09:55:19 +02:00
İsmail Arılık 501ff59c43 revert(part-2-intro): revert 2f0aa1e
I will remove part numbers after that.
2023-08-11 09:55:19 +02:00
İsmail Arılık 712a1db15d fix(part-2-intro): remove the phrase "from Part 1" which is not exist 2023-08-11 09:55:19 +02:00
İsmail Arılık 124292a49c feat(part-5-intro): make "Part 5" obvious 2023-08-11 09:55:19 +02:00
Nicky Lim 30969cbcee Improve clarity about attribute applicability 2023-08-08 09:16:43 +02:00
Nicky Lim 484ba2cd60 Update to new warning attribute 2023-08-08 09:16:43 +02:00
Santiago Pastorino 06205a1941 Add RPITIT documentation (#1764) 2023-08-03 18:21:23 -03:00
İsmail Arılık 9e0902f9d6 fix(visitor.md): fix a type name in a code sample
From the context, it is understood that this type is `MyVisitor`, not `NoLandingPads`.
2023-08-01 09:55:47 +02:00
İsmail Arılık f6c4e6529f fix(name-resolution): remove unnecessary closing paranthesis 2023-07-30 13:23:23 +02:00
İsmail Arılık 0f86bd1480 fix(macro-expansion.md): fix the article `an` to `a` to have uninterrupted reading 2023-07-28 11:09:30 +02:00
İsmail Arılık c3141f6cf5 fix(serialization.md): fix the name of a derive macro
It should be like this since in the next sentence, it is specified that this should generate an implementation.
2023-07-28 05:20:21 +02:00
İsmail Arılık 6712155316 fix(serialization.md): add a necessary plural suffix
This is better not to have an interruption while reading it fast.
2023-07-27 16:52:51 +02:00
İsmail Arılık cfa6a233be fix(salsa.md): add punctuation to prevent confusion 2023-07-27 11:28:57 +02:00
İsmail Arılık eaa0265b16 fix(salsa.md): remove duplicate "To Be" verb 2023-07-27 11:28:02 +02:00
İsmail Arılık c9ee46783a feat(fuzzing.md): make `halfempty` word a link 2023-07-24 15:35:47 +02:00
İsmail Arılık e1cb438d05 fix(about.md): use `a` instead of `an`
Pronunciation of the next word requires it.
2023-07-24 15:33:43 +02:00
İsmail Arılık 9e6c3595c2 refactor(git.md) use `<>` instead of long `[...](...)` syntax for plain links 2023-07-22 14:16:37 +02:00
İsmail Arılık 38b12730c8 refactor(git.md): make git-scm links clickable
Some of them wasn't clickable.
2023-07-22 14:16:37 +02:00
İsmail Arılık 72d508046b fix(walkthrough.md) add a comma operator to eliminate ambiguity
There was an ambiguity on whether the `it` after `don't` is a subject or object.
2023-07-22 14:15:50 +02:00
İsmail Arılık 2eb3e5e7e8 fix(git.md): remove a confusing end of sentence character
It might cause a confusion since it is not end of a sentence.
2023-07-21 16:57:54 +02:00
İsmail Arılık 3e926f097e refactor(profiling/with_perf): remove a wrong to be verb 2023-07-19 16:54:57 +02:00
İsmail Arılık feaef55f33 refactor(tests/headers): remove duplicate list item 2023-07-18 16:02:36 +02:00
İsmail Arılık 25d42e6901 refactor(test/headers.md): make the meaning more obvious 2023-07-18 16:01:21 +02:00
İsmail Arılık 60f024d3f6 refactor(tests/ui): remove unnecessary duplicate word 2023-07-18 14:04:05 +02:00
İsmail Arılık a014f290dc fix(duplicate): remove unnecessary duplicate word 2023-07-18 12:17:31 +02:00
Mahdi Dibaiee f2555ba137 generic_arguments.md: substs -> GenericArgs
See https://github.com/rust-lang/rust/pull/113591
2023-07-15 02:01:35 +02:00
İsmail Arılık 74d4d9ca74 fix(suggested): remove an unnecessary and confusing statement
This statement is not about Visual Studio Code; it is about Neovim and it is already in that section. And it is also confusing for a VS Code user. So I think it is better to remove it.
2023-07-14 20:41:09 +02:00
Tshepang Mbambo cd6372d916 make it read better 2023-07-14 08:39:30 +02:00
İsmail Arılık 6fece074be fix(how-to-build-and-run): fix a typo ("fromer" -> "former")
I think it is a typo, isn't it? 🤔
2023-07-14 08:39:30 +02:00
İsmail Arılık 14db9a3d53 fix(how-to-build-and-run): remove a wrong paragraph
This paragraph says that given README section have instructions on how to install Python and other prerequisites but it doesn't.

Other than that "Dependencies" section in the README is already given in this section of the rustc-dev-guide: https://rustc-dev-guide.rust-lang.org/building/prerequisites.html#dependencies
So this paragraph seems not necessary.
2023-07-13 11:37:29 +02:00
Tshepang Mbambo f5cd03f2ec linked issue is closed (#1729) 2023-07-13 04:02:06 +09:00
İsmail Arılık 47fc6ba672 remove duplicated reference in about-this-guide.md
Forge is already mentioned in an item above.
2023-07-12 12:38:00 +02:00
Michael Goulet b927ecccc3 Update src/early-late-bound.md 2023-07-11 16:43:01 -04:00
Boxy 16fb433be8 caps is so important
Co-authored-by: Michael Goulet <michael@errs.io>
2023-07-11 16:43:01 -04:00
Boxy a5f2cd5b63 Gats isnt the only cool kid anymore
Co-authored-by: Michael Goulet <michael@errs.io>
2023-07-11 16:43:01 -04:00
Boxy 0effe03071 split file and replace with deep dive doc 2023-07-11 16:43:01 -04:00
lcnr 6e253cdf6c add section for normalization with the new solver 2023-07-11 19:59:26 +01:00
İsmail Arılık 7b7ac5d0e1 Improve cleanup-crew.md with an example post
Add a post which explains how to use C-reduce with Rust in cleanup-crew.md
2023-07-11 08:02:34 +02:00
Emmanuel Ferdman 726dacd3ef fix: update link to function coverage (#1727) 2023-07-09 23:50:50 +09:00
İsmail Arılık eda7119ba7 Fix a bug in getting-started.md (#1726) 2023-07-09 19:22:22 +09:00
Tshepang Mbambo e42495f408 improve explanation of placing tests in separate file (#1721)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-07-08 11:54:25 +09:00
Tshepang Mbambo fd0505a41c various fixes/improvements to Contributing chapter (#1723) 2023-07-08 11:52:53 +09:00
Tshepang Mbambo c7a36abe84 ty::ConstKind has moved (#1724) 2023-07-08 01:36:13 +09:00
Rémy Rakic 5a7307db86 document `.x test --rustc-args` option 2023-07-05 02:14:36 +02:00
Tshepang Mbambo ae58f5820d tests/run-make files have moved 2023-07-03 09:36:22 +02:00
Tshepang Mbambo 222ed9a884 replace dead link (#1717) 2023-07-03 10:34:58 +09:00
Tshepang Mbambo 7dd341037d fix link 2023-07-02 16:16:44 -07:00
Tshepang Mbambo 978cdcb4ee update link 2023-07-03 00:51:52 +02:00
Tshepang Mbambo f2bc089120 typo 2023-07-02 12:29:13 -07:00
Tshepang Mbambo 06757c5a59 OwningRef exists no more 2023-07-02 13:17:42 +02:00
sslime336 44d8b7916a Try to avoid confusion 2023-07-01 08:14:17 +02:00
Tshepang Mbambo 3e328f0ef1 typo 2023-06-30 23:11:14 +02:00
sslime336 774f3f18b3 Fix line length out of limit 2023-06-30 23:11:14 +02:00
sslime336 e2487ebdc4 Change `x.py` into `x`, add explanation for `x` 2023-06-30 23:11:14 +02:00
sslime336 a04ad82e3c Change `./x.py` into `./x` 2023-06-30 23:11:14 +02:00
jyn 71bdc1c631 include rustc-dev-guide's own issues in suggested search 2023-06-29 18:21:18 +02:00
jyn 3630392566 Improve Windows docs 2023-06-29 10:05:10 -05:00
jyn 6de921aef4 Inline alternate x.py invocations from the rust-lang/rust readme
I'm going to make a follow-up PR shortly linking from rust-lang/rust to the dev guide so this info isn't duplicated.
2023-06-29 10:05:10 -05:00
jyn 90773b6b68 cleanup the "tracking issue" section
mostly this just suggests using a tracking issue instead of inlining the info from the issue template
2023-06-29 10:05:10 -05:00
jyn 2959075c26 fix broken link 2023-06-29 10:05:10 -05:00
jyn fa57b7b94e move the Breaking Changes section later in the guide 2023-06-29 10:05:10 -05:00
jyn 9618be3aa7 distinguish language and library processes more consistently 2023-06-29 10:05:10 -05:00
jyn 6578c56f30 Move "Adding a new feature gate" to the "Implementing new features" chapter
Splitting the two was confusing and meant that similar information was in wildly different parts of the guide. Combine them into a single page.
2023-06-29 10:05:10 -05:00
Eric Huss c242e5719c Reword `messages.ftl` example. 2023-06-29 06:43:19 +02:00
Eric Huss 1b6f93987d Fix some links 2023-06-29 06:43:19 +02:00
Tshepang Mbambo b4ecfbc298 fix link 2023-06-28 06:55:24 +02:00
Eric Huss 51f6fe2a1a Define more lint terms 2023-06-28 06:55:24 +02:00
Oleksandr Babak ef3a819b4c fix_typo 2023-06-26 18:34:26 +02:00
Tshepang Mbambo b6c87310d1 run-make tests: fix and improve (#1702) 2023-06-26 23:03:03 +09:00
lcnr d42b320daa add stub for proof trees (#1700) 2023-06-23 23:40:25 +01:00
Zyranivia da1de802ba Update track_caller reference link (#1688) 2023-06-21 18:14:16 +09:00
Zachary Whiteley 93fc2f3c01 Include information about setup defaults in how-to-build guide (#1694) 2023-06-21 18:13:53 +09:00
Caleb Robson 4b15de4985 Fix typo (#1697)
* Fix typo

* Fix typo in typo fix

* add missing word

---------

Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-06-14 06:43:09 +02:00
Ewan Breakey 11bc8caeb7 Fix typo in thir.md 2023-06-13 21:18:46 -07:00
Eric Huss ebb0fd2147 Update triagebot links. 2023-06-13 20:49:13 +02:00
Arthur Cohen 4497151da5 name-resolution: Fix some typos in "Scopes and ribs" 2023-06-13 19:45:19 +02:00
clubby789 c07f051fa5 Add note about shell completion scripts 2023-05-17 21:44:05 -05:00
jyn 1c106b7841 filter out S-blocked issues in the "Getting Started" search (#1687) 2023-05-15 05:24:31 +09:00
Ben Kimock 6917c2ee91 Rename InstCombine to InstSimplify (#1684) 2023-05-11 18:59:47 +09:00
Yukang 0296ecfd1f Use unpretty for debugging Hir (#1685) 2023-05-11 18:59:23 +09:00
Eric Huss 0cae602e50 Add unset-exec-env compiletest header.
This header was added in https://github.com/rust-lang/rust/pull/110644/.
2023-05-02 04:20:21 +02:00
lcnr beecd1cf3b typo 2023-04-26 12:09:10 -07:00
lcnr b9da0a0797 extend the sixth requirement 2023-04-26 12:09:10 -07:00
Lukas Wirth a641ce4bda Add docs for compare-output-lines-by-subset flag (#1677) 2023-04-22 20:50:11 +09:00
Tshepang Mbambo 91bfe51078 fix typo (#1674) 2023-04-22 20:49:13 +09:00
Brian Kung b8cf5aaaa0 Fix links in how-to-build-and-run.md (#1679) 2023-04-22 20:48:44 +09:00
Ezra Shaw 4a5e46f8ab docs: document new `suggest-tests` tool 2023-04-16 13:56:19 +02:00
Ohad Ravid a4ea4aa4a1 Fix extra slash 2023-04-16 13:30:24 +02:00
Tshepang Mbambo 414d4c8ce2 fix markup (#1670) 2023-04-10 23:23:05 +09:00
Joshua Nelson d2ec8cd362 Link to governance page
It has links to the specific channel/stream for each team.
2023-04-09 22:38:15 +02:00
jyn df1d869b36 Apply suggestions from code review
Thank you JohnTitor for finding these!

Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-04-09 22:38:15 +02:00
jyn 65541fee89 Add a "What should I work on?" section
This is the first question I get from nearly all contributors. So far
I've been giving links to individual issues, but they quickly go out of
date or get fixed, and then I have more work to do to help people find
an issue. Add some suggestions for work people can find themselves,
without having to first consult an expert.

This also moves the "Cloning and Building" stub to the bottom of the
page.
2023-04-09 22:38:15 +02:00
jyn e32c45adea Make the "Asking Questions" section more useful
- Update outdated chat platforms
- Link to the community page
- Suggest `git shortlog` for finding experts
2023-04-09 22:38:15 +02:00
jyn a5f0310ba4 Fix link; remove duplicate link 2023-04-09 22:38:15 +02:00
jyn b6e5e27f3a Move "Getting Started" to the first page
This page is better suited for people landing immediately from
CONTRIBUTING.md, or who haven't heard of the guide before. "About This
Guide" is still useful, but doesn't need to be the very first page.
2023-04-09 22:38:15 +02:00
jyn bea76af07d Clarify cfg(bootstrap) docs 2023-04-09 21:38:54 +02:00
jyn ff78970088 document that it's rare for books to break 2023-04-09 21:20:55 +02:00
jyn 558a4f3d06 Remove detailed toolstate section
This is already covered in detail on Forge: https://forge.rust-lang.org/infra/toolstate.html
and linked in the previous paragraph.
2023-04-09 21:20:55 +02:00
jyn 54a87876bd fix incorrect miri mentions in "External Repos" chapter 2023-04-09 21:20:55 +02:00
jyn e379577fd0 Improve the landing page for contributing to the libstd docs (#1666) 2023-04-09 12:10:27 +09:00
jyn c6cd62cf77 Various improvements to `check_line_lengths.sh` (#1667) 2023-04-09 12:08:46 +09:00
jyn 088c7fec78 Document how to ignore specific files in a diff (#1668) 2023-04-09 12:07:16 +09:00
y21 297817bf1f fix line length 2023-04-05 19:29:18 -05:00
y21 42b4a3b105 mention `git clone --depth` 2023-04-05 19:29:18 -05:00
Joshua Nelson 1fd8ddbdc2 add a few more TOC sections 2023-04-03 06:42:31 -05:00
Joshua Nelson 945da7bd13 Remove duplicate section on new features in CONTRIBUTING.md 2023-04-03 06:42:31 -05:00
Joshua Nelson 161b9b3beb Link to bug-fix-procedure.md from the contribution procedure section 2023-04-03 06:42:31 -05:00
Joshua Nelson 92102e0e8c Rearrange the "getting started" and contributing.md sections
There was a lot of information duplicated between the two, and it wasn't
clear which one to look. This commit changes `contributing.md` to be
strictly for contribution procedures, and moves "what should I work on"
sections to "Getting Started".

This also consolidates the links in `about-this-guide.md` rather than
spreading them between about-this-guide, getting-started, and
contributing.

I suggest using https://rustc-dev-guide.org/git.html#moving-large-sections-of-code to review this commit.
2023-04-03 06:42:31 -05:00
Joshua Nelson cdd2e49a7a Outline the external repositories section
This is advanced info that most contributors won't need to know; and for
experienced contributors, it means the info is at the top of the page
instead of needing to scroll.
2023-04-03 06:42:31 -05:00
Joshua Nelson 774a20130a Move some info from "Getting Started" to "How to build and run"
"Getting Started" is already *very* long; this shrinks it a bit, and
puts similar info closer together.
2023-04-03 06:42:31 -05:00
Pietro Albini 030739585a Make REUSE ignore section heading as a copyright statement (#1659) 2023-04-03 20:09:34 +09:00
Eric Huss 0cb6011623 Update some links and information for cargo-bisect-rustc (#1657) 2023-04-02 15:15:55 +09:00
Tshepang Mbambo 7cb957b26f update rustc_driver examples (#1655) 2023-04-01 09:35:35 -04:00
Shahar Dawn Or 266ca693c0 bootsrapping stages overview list 2023-03-23 15:36:00 +02:00
Eric Huss ccef9cb8e1 Update labels overview (#1639) 2023-03-21 18:07:36 +09:00
Tshepang Mbambo ed855b1a00 first mention of type, and add a link (#1643)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-03-21 17:55:42 +09:00
Yukang e6289be8dc Add SIP solution for macOS users (#1636) 2023-03-21 17:50:39 +09:00
Langston Barrett 69dbbd548d Reword to include 'distractions' 2023-03-16 18:40:40 -07:00
Langston Barrett 0a4cfa8e4b Mention debug assertions label 2023-03-16 18:40:40 -07:00
Langston Barrett 2848aadbff Mention debug assertions 2023-03-16 18:40:40 -07:00
Langston Barrett f49ec954c5 Address review comments 2023-03-16 18:40:40 -07:00
Langston Barrett d09a940816 mir-opt*-level*, not mir-opt 2023-03-16 18:40:40 -07:00
Langston Barrett 5de7dd6e4f Address review comments 2023-03-16 18:40:40 -07:00
Langston Barrett 5531ed7c5e Add chapter on fuzzing 2023-03-16 18:40:40 -07:00
Hoblovski f946bd407f Fix "Crate disambiguator" in libs-and-metadata.md 2023-03-16 11:11:46 +02:00
Tshepang Mbambo 82a5c6d47b alert when date gets stale (by using date-check annotation) 2023-03-14 05:50:20 +02:00
Tshepang Mbambo 1ffcb23bbc fix date-check annotation some more 2023-03-14 05:50:20 +02:00
Tshepang Mbambo fa092136c0 fix date-check annotation 2023-03-14 05:50:20 +02:00
Tshepang Mbambo ea585370c8 typo 2023-03-14 05:50:20 +02:00
Michael Howell ba285c2370 Update rustdoc-internals.md 2023-03-14 05:50:20 +02:00
Thom Chiovoloni 31991ba0cb Rename `config.toml.example` to `config.example.toml` 2023-03-13 04:42:00 +02:00
Yutaro Ohno c5ec776f41 fix typo `SubstRef` to `SubstsRef` 2023-03-12 11:40:45 +02:00
Tshepang Mbambo 060b7a17dc improve accuracy 2023-03-10 09:04:21 +02:00
bohan 1b7cd1e2bf tracing log along diff crates 2023-03-10 09:04:21 +02:00
clubby789 88a1bdd470 Fix Rust Analyzer settings location
This file was moved in https://github.com/rust-lang/rust/pull/108618
2023-03-08 00:21:21 +02:00
Yuki Okushi 70e8b3e396 Reflect the changes in rust-lang/rust#67000 (#1632)
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-06 14:22:07 -03:00
Tshepang Mbambo cee03b4dc3 improve capacity note (#1634) 2023-03-06 22:08:37 +09:00
Yuki Okushi b46fe5900b Remove mention to lexer/parser refactoring
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:41:21 +02:00
Yuki Okushi 77e9a17a1d Update date reference about infer context variables
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:39:11 +02:00
Yuki Okushi d8c874e31b Update explnation about `Body.basic_blocks`
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:25:20 +02:00
apiraino 6b2d30b2e5 Add detail to contributing guide (#1628) 2023-03-03 20:14:53 +09:00
Mika a5d3282c90 Making the sentence more clear (#1624) 2023-03-03 20:13:46 +09:00
Mika 30ea647281 Fixed typing error (#1623) 2023-03-03 20:13:18 +09:00
Ezra Shaw 25b0c633d5 update error code docs to reflect recent changes (#1625) 2023-03-03 20:12:51 +09:00
Mika 53e87016e1 Fixed typing errors (#1622) 2023-02-27 07:30:52 +09:00
Tshepang Mbambo 052fe68fb2 this remains true (#1620) 2023-02-21 23:12:14 +09:00
Tshepang Mbambo 1d826b01ef diagnostics: small fixes/improvements (#1618) 2023-02-21 22:57:34 +09:00
Tshepang Mbambo ec33573db8 typo (#1616) 2023-02-21 22:57:16 +09:00
Tshepang Mbambo c7256e75c0 typo (#1617) 2023-02-21 22:56:16 +09:00
Tshepang Mbambo 74a6d8d10a keep "grey area" lint summary green (#1619)
This replaces link to a removed lint with a link to discussion of lints
of its type.
2023-02-20 19:08:35 -06:00
lcnr d3bee3c76d new solver: write canonicalization chapter (#1595)
* write canonicalization chapter first half

* w

* review

* very good section

* whatever

* review

* ok
2023-02-20 14:45:25 +00:00
The 8472 54fe64b775 bootstrap now creates a usable toolchain when building stage0 std 2023-02-19 13:43:56 +01:00
Tshepang Mbambo 45eb9121e0 llvm 13 is now not supported (#1612) 2023-02-18 22:20:46 +09:00
Tshepang Mbambo c1de1a3127 Vetting deps datecheck (#1614) 2023-02-18 22:20:08 +09:00
Tshepang Mbambo 6db1c189d7 accept review suggestion
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-02-18 14:10:03 +02:00
Tshepang Mbambo 0086a2d437 fmt 2023-02-18 14:10:03 +02:00
Tshepang Mbambo 092afc35aa add Dev Desktops note 2023-02-18 14:10:03 +02:00
Tshepang Mbambo bd0f0b77b8 fix and clarify llvm bugfix policy (#1611) 2023-02-18 20:46:21 +09:00
Tshepang Mbambo a326b2525f impl review suggestion
See https://github.com/rust-lang/rustc-dev-guide/pull/1605#discussion_r1110388310
2023-02-18 05:04:44 +02:00
Tshepang Mbambo fcd74f99a3 lower-case "Compiler" in headings, for consistency (and looks) 2023-02-18 05:04:44 +02:00
Noah Lev 279f92f50a Explain what the rest of the backend agnostic page is about 2023-02-18 03:54:02 +02:00
Tshepang Mbambo a5046f57db accept review suggestion
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2023-02-17 13:38:10 -08:00
Tshepang Mbambo 8d9c533ac3 address review comment
See
- https://github.com/rust-lang/rustc-dev-guide/pull/1606#discussion_r1109298849
- https://github.com/rust-lang/rustc-dev-guide/pull/1606#discussion_r1109298280
2023-02-17 13:38:10 -08:00
Tshepang Mbambo fc16473321 rustc_codegen_ssa feels permanent enough not to need date-check 2023-02-17 13:38:10 -08:00
Tshepang Mbambo 4ccbe9182c make use of the symlink, to ease things (#1608) 2023-02-17 14:37:01 -06:00
Tshepang Mbambo 19f6cc82a5 remove stray text (#1604) 2023-02-16 19:33:05 -08:00
Michele 4308463e70 Typo 2023-02-16 07:26:00 +02:00
Michele 51aaeee90d Typo 2023-02-16 07:24:32 +02:00
clubby789 41680031f8 Add link to vscode settings in Rust repo (#1591) 2023-02-15 15:46:19 -03:00
Tshepang Mbambo 03dd097bb0 avoid code duplication by including files in docs (#1598) 2023-02-15 11:41:35 -03:00
AE1020 1827e0c1b3 Add sample CodeLLDB launch.json (#1482)
* Add sample CodeLLDB launch.json

There is a section with [instructions for setting up source analyzer in VSCode](https://rustc-dev-guide.rust-lang.org/building/suggested.html#configuring-rust-analyzer-for-rustc), but
nothing for setting up debugging with CodeLLDB.  This adds a sample configuration
that may not be ideal, but appears to work for me.

To source highlight the snippet, uses JavaScript instead of JSON so that comments
do not show up as errors highlighted in red (VSCode allows comments).

* Update src/compiler-debugging.md

Co-authored-by: jyn <github@jyn.dev>

* Update src/compiler-debugging.md

Co-authored-by: jyn <github@jyn.dev>

---------

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
Co-authored-by: jyn <github@jyn.dev>
2023-02-15 11:31:02 -03:00
Tshepang Mbambo aba825cf33 typo (#1600)
Fixes #1599
2023-02-15 11:02:38 -03:00
Tshepang Mbambo 55c5b384b6 use actual names (#1594) 2023-02-14 15:44:23 +09:00
Tshepang Mbambo 9f02d33a1c Fix a typo (#1597) 2023-02-14 15:43:48 +09:00
Christopher Smyth b4689c9511 Add Neovim configuration information (#1545)
* Add Neovim configuration information
The JSON provided for VSCode works with coc and nlsp-settings.
This is verified by
9d8bdb9290/README.md
for coc, and feeding the JSON in to this schema
215b537cfb/schemas/_generated/rust_analyzer.json
for validating nlsp-settings.

* Make the steps clear
First open a Rust buffer
Then update RA settings
If you don't open a buffer first then nothing will happen. This is because
the plugin makes a raw LSP RPC, so RA must be attached.

* Use separate sections for VSCode and Nvim
* Add a short section on the VSCode tasks.
2023-02-13 23:16:01 -06:00
jyn 2b94321e3d Improve git submodule help (#1587) 2023-02-09 19:08:26 +09:00
Hiroki Fujino 342f72310d update examples for rustc 1.69.0-nightly (e1eaa2d5d 2023-02-06) (#1590)
Closes https://github.com/rust-lang/rustc-dev-guide/issues/1581
2023-02-09 18:56:06 +09:00
clubby789 b4c465275c Replace settings.json with x.py setup note (#1588) 2023-02-08 14:26:58 -06:00
Ciel 5471f42f11 Fixed small grammar mistake in monomorph.md (#1585)
Fixes https://github.com/rust-lang/rustc-dev-guide/issues/1584
2023-02-05 17:28:48 +09:00
Onur 347b3633f1 update bootstrap guide (#1583)
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-02-04 16:53:38 -06:00
Nixon Enraght-Moony 69ef8a3924 Use host symlink for custom rustup toolchain 2023-02-04 01:01:48 +02:00
Yuki Okushi 0e4e3ab221 Fix broken relative links
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02: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
Yuki Okushi 6ea7b0db51 Address the change in https://github.com/rust-lang/rust/pull/106718
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
Yuki Okushi 6213fc1cf5 Address the change in https://github.com/rust-lang/rust/pull/97287
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
Yuki Okushi f13eeec25a Address the change in https://github.com/rust-lang/rust/pull/107256
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
Yuki Okushi f663d1aa06 Update explnation about benchmarks
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
nils 313e8e913c Add param_env and wording 2023-02-02 10:23:24 +02:00
nils ca4b002450 Expand section basedd on review comments 2023-02-02 10:23:24 +02:00
Nilstrieb 083a9a9d09 Add section on comparing types 2023-02-02 10:23:24 +02:00
Zephaniah Ong 118246c17e Update rustfmt path
As per https://github.com/rust-lang/rust/pull/107297#discussion_r1092764740, the change broke the rust-analyzer config. Hence, changing the docs to match the new path
2023-02-01 18:59:30 -06:00
Tshepang Mbambo 343194d258 fix wrong heading level (#1573) 2023-02-01 07:29:15 +09:00
ozkanonur f0dbe6cec7 fix incorrect position of topic
Right now "Clarification of build command's stdout" topic
shows up under the "Environment Variables" which is not correct.
This commit aims to fix this problem.

Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-01-31 22:57:27 +02:00
ozkanonur 375adf22dc extend bootstrap related documentations
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-01-31 12:42:30 -06:00
nils 5edc03f6ad New infcx usage (#1571)
Fixes https://github.com/rust-lang/rustc-dev-guide/issues/1543
2023-01-31 00:08:16 +09:00
Denis Belik 7353fd14ee Apply suggestions from code review
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-01-29 20:58:11 +02:00
Denis Belik 914b409125 Update ast-validation.md 2023-01-29 20:58:11 +02:00
lcnr ccce1437bc update datecheck 2023-01-27 15:03:01 -08:00
lcnr 7a5772a172 review 2023-01-27 15:03:01 -08:00
lcnr ba035fb554 line length 2023-01-27 15:03:01 -08:00
lcnr 020898a81c Update src/solve/canonicalization.md
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-01-27 15:03:01 -08:00
lcnr 17d68d8412 review 2023-01-27 15:03:01 -08:00
lcnr 1e2f272560 Update src/solve/canonicalization.md
Co-authored-by: Boxy <supbscripter@gmail.com>
2023-01-27 15:03:01 -08:00
lcnr f7caa2f553 fix line lengths 2023-01-27 15:03:01 -08:00
lcnr 9899cf3c43 add section for the new trait solver 2023-01-27 15:03:01 -08:00
Tshepang Mbambo ac46c61184 version 5 is now not supported (#1568) 2023-01-27 19:09:37 +09:00
Tshepang Mbambo c0342ec589 there are still no locale bundles (#1567) 2023-01-27 07:52:25 +09:00
Tshepang Mbambo 710cc3eb66 bumpt date-check examples to current month (#1566) 2023-01-27 07:51:28 +09:00
Yang Pan e8b989eb3b Update hir.md
Fix method name and the link, as it's outdated.
2023-01-25 17:29:12 +02:00
Tshepang Mbambo e38fa37202 fix review suggestion 2023-01-21 16:12:58 +02:00
Tshepang Mbambo 8b24a1e9bd accept review suggestion
Co-authored-by: lcnr <rust@lcnr.de>
2023-01-21 16:12:58 +02:00
Tshepang Mbambo 05d22ebd50 rustc_typeck exists no more 2023-01-21 16:12:58 +02:00
Albert Larsan c7064daba1 Correct tests misplacement (#1564)
Since the tests move, this was not correct anymore.
2023-01-20 11:18:15 -03:00
gftea 4583b43b6b Update resolution.md (#1561) 2023-01-18 07:46:14 +09:00
gftea d003669ae5 Update asm.md (#1560) 2023-01-17 21:44:19 +09:00
gftea c58e6d14df fix examples for rustc 1.68.0-nightly (935dc0721 2022-12-19) (#1556) (#1557)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Closes https://github.com/rust-lang/rustc-dev-guide/issues/1556
2023-01-15 05:34:23 +09:00
gftea 589841c29d Update incremental-compilation-in-detail.md (#1553)
Co-authored-by: Michael Woerister <michaelwoerister@users.noreply.github.com>
2023-01-14 12:37:03 +09:00
jyn c154a90ec5 Link to the youtube recording of my talk, not the summary (#1554) 2023-01-13 07:46:15 +09:00
Albert Larsan d4ec98736e Change `src/test` to `tests` (#1547) 2023-01-13 07:31:47 +09:00
gftea 03902fe1f0 add full name for ICE (#1552)
Co-authored-by: Yuki Okushi <huyuumi.dev+love@gmail.com>
2023-01-11 22:25:53 +09:00
Mu00 2d23cff5fc Fix incorrect links (#1549) 2023-01-10 22:00:49 +09:00
oskgo e574dadba0 fix rebase link 2023-01-10 08:17:59 +02:00
Joshua Nelson 48ef16204c Add a section for how to review code more easily (#1538)
- How to hide whitespace
- Fetching PRs without having to add a new remote or copy-paste the URL of the author's fork
- How to review large blocks that have moved
- Suggest `git range-diff`. This section is still mostly incomplete; fixing an exact command that will work seems kinda tricky and I don't currently have time for it.
2023-01-02 15:35:09 -08:00
Joshua Nelson 3b35c4e040 fix typo
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-12-31 23:20:47 -06:00
Joshua Nelson 3093967547 Give help for when you update a submodule by accident 2022-12-31 23:20:47 -06:00
Joshua Nelson a1418a804c Update sentence about LLVM to match the new defaults 2022-12-31 23:20:21 -06:00
Joshua Nelson 91d2393626 Move information about dependencies to the rust-lang/rust readme
This avoids having to maintain the information in two places.
2022-12-31 23:20:21 -06:00
Joshua Nelson 966d6e97a7 Move "create a config.toml" after the section explaning x.py 2022-12-31 23:20:21 -06:00
Joshua Nelson b36e2ff71d Remove unnecessary detail in building chapter
Most of these details were not helpful or necessary for building the compiler for the first time.
This section comes very early in the guide and is meant to be a tutorial, so being concise is very important.
2022-12-31 23:20:21 -06:00
Joshua Nelson 84eea0d580 Remove initial section on submodules
It's not necessary and it takes up valuable space at the very start of the guide.
2022-12-31 23:20:21 -06:00
Joshua Nelson bd26e3aae5 Replace `$TARGET` with `host`
This avoids having to manually modify the configuration in the docs.
2022-12-31 18:23:52 -06:00
Joshua Nelson 7f9af30e5f Use `origin` consistently and add an example of rebasing over the wrong remote 2022-12-29 11:39:24 -06:00
Joshua Nelson d318386762 Add more rebasing help 2022-12-29 11:39:24 -06:00
Dan Mezhiborsky 9a67713d99 Fix rustc_borrowck crate name typo (#1535) 2022-12-25 21:11:21 +09:00
mejrs faf9268f07 Apply feedback 2022-12-18 00:41:27 +02:00
mejrs 43cd55066d Add -Ztrack-diagnostics information 2022-12-18 00:41:27 +02:00
Ramon de C Valle 44e95ec592 Add documentation for LLVM KCFI support (#1529)
This commit adds initial documentation for LLVM Kernel Control Flow
Integrity (KCFI) support to the Rust compiler (see rust-lang/rust#105109
and rust-lang/rust#89653).
2022-12-14 12:20:53 +01:00
Tshepang Mbambo 11c34c7a47 typo 2022-12-14 05:34:09 +02:00
Mohammad Omidvar 6303e165ff Replace NoLandingPad with another alive Visitor
The broken reference to the non-existing `NoLandingPad` is replaced by `LocalUseCounter` to fix this document.
2022-12-14 05:34:09 +02:00
Mohammad Omidvar cfb4531dde Remove todo note 2022-12-14 05:34:09 +02:00
Mohammad Omidvar fe6890245d Replace NoLandingPad with another alive MIR pass
The broken reference to `NoLandingPad` is replaced by `RemoveStorageMarkers` to fix this document.
2022-12-14 05:34:09 +02:00
Tshepang Mbambo 57f1ba022b share same link 2022-12-08 19:02:08 -08:00
Yuki Okushi 48d78e345c fix: Fix broken links
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-12-09 03:13:38 +02:00
Oli Scherer 3ea1f2de88 Remove TyS 2022-12-08 09:06:11 +01:00
Jared Harp 983e101473 Fix small inaccuracy in monomorph page 2022-12-06 21:42:57 -08:00
Anirudh S ab9ea18b59 Remove duplicate paragraph (#1523) 2022-12-04 08:09:24 +09:00
Ralf Jung ce5a4c75c0 clarify subtree tool policy (#1518) 2022-12-03 09:32:00 +09:00
Samuel Moelius 17a43dc86c Typo (#1520) 2022-12-03 09:02:26 +09:00
Joshua Nelson 5d2d898534 Fix broken link
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-11-28 19:00:24 -08:00
Joshua Nelson 4f846480db Don't use "incremental" to refer to `--keep-stage`
`-C incremental` is sound and --keep-stage is not.
2022-11-28 19:00:24 -08:00
Joshua Nelson 19df867789 Link directly to the section on `--keep-stage` 2022-11-28 19:00:24 -08:00
Tshepang Mbambo 276717e9e4 do an actual link to detect if it breaks in future (#1517)
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-11-27 09:49:21 +09:00
Noah Lev 010ab13460 Triage some date-check items (#1513) 2022-11-26 22:25:58 +09:00
Ghassan Gedeon Achi 148930593c Update path for `try_mark_green` implementation
Updates the location of the `try_mark_green` algorithm from `compiler/rustc_middle/src/dep_graph/graph.rs` to [`compiler/rustc_middle/src/dep_graph/graph.rs`](https://github.com/rust-lang/rust/blob/stable/compiler/rustc_query_system/src/dep_graph/graph.rs#L574) .
2022-11-22 07:27:49 +02:00
Yuki Okushi 0bfa71f32e Fix a broken design docs link about unused substs bug
https://github.com/rust-lang/project-const-generics/pull/21 removed the
link. This replaces it with an issue link mentioned on the design docs.

Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-11-20 08:45:56 +02:00
Tshepang Mbambo 29345dcf0c updating-llvm: keep a calm tone (#1449)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-11-20 15:19:50 +09:00
Tshepang Mbambo e764338832 date-check: updating-llvm (#1424) 2022-11-20 12:55:18 +09:00
lcnr d1132b7494 Update src/type-inference.md
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2022-11-10 23:27:01 +02:00
lcnr e53f21a45b extract regions 2022-11-10 23:27:01 +02:00
RCoder01 623c6246e9 Consistent ordered list indexing 2022-11-09 10:39:06 +02:00
Xiretza f541555701 Document multiple alternative suggestions on diagnostic structs (#1486) 2022-11-09 06:35:38 +09:00
lcnr d537ba94b8 trans -> codegen 2022-11-07 16:49:22 +02:00
Nilstrieb 062dd31e33 Remove implementation details 2022-11-05 10:44:35 -05:00
Nilstrieb 4c1505600c Update some more things and improve wording 2022-11-05 10:44:35 -05:00
nils 110000cf39 Update query.md
- queries always need a description
- `QueryDescription` isn't just for descriptions (it's actually not for
  descriptions at all now) and always implemented by the macro
- queries are not grouped into categories
2022-11-05 10:44:35 -05:00
Tshepang Mbambo 2e59ac0e71 replace tabs with spaces (#1504) 2022-11-05 12:32:16 +09:00
Tshepang Mbambo f51a573c19 align code blocks with their paragraphs 2022-11-04 03:49:25 +02:00
jonathanCogan 100e801b36 Fixes some typos (#1502)
* Fix some typos.

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2022-11-02 13:11:03 -05:00
Jhonny Bill Mena 43e20eff99 UPDATE - mention of Diagnostic derive on enums
Updated Diagnostic text to use the same language used in Subdiagnostic
2022-11-01 15:13:38 +00:00
Santiago Pastorino 431fcf5e20 trans -> codegen (#1500) 2022-10-31 13:51:42 -03:00
Rageking8 1d067b8308 add note for err annotation formatting 2022-10-27 20:45:40 +02:00
Chris Denton ffec7d7474 Remove `--bless` from pre-push hook suggestion
According to 8873e33806

> Running with --bless causes the push to succeed if there are fixable
formatting changes, but the changes don't make it into the push.
>
> We should have the user rerun with --bless (or x.py fmt) and commit the
changes themselves (they might want to amend a particular commit, for
instance).
2022-10-27 20:36:34 +02:00
Eric Huss 96c69528ad Update for highfive transition. 2022-10-27 06:07:59 +02:00
Michael Goulet d6540b72c3 Update `traits/resolution.md` (#1494)
* Update `traits/resolution.md`

Co-authored by: @lcnr and @spastorino

* Update src/traits/resolution.md

* Wrapping

* Update src/traits/resolution.md

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
2022-10-25 10:18:58 -07:00
Nilstrieb 015da9686e Update diagnostics to flat fluent message paths
As implemented in rust-lang/rust#103345
2022-10-25 14:36:52 +01:00
Lukas Wirth 2cfe23241b Update rust-analyzer suggestions (#1487) 2022-10-24 19:41:55 +09:00
Luqman Aden 3a21e559be miri is no longer a submodule but a subtree. (#1488) 2022-10-23 08:17:08 +09:00
lcnr bba248984f fix some links (#1490)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-10-22 19:53:46 +09:00
Tshepang Mbambo 83163df624 typo and grammar (#1484) 2022-10-19 07:45:49 +09:00
Sergio de Carvalho 94dec079f7 Add missing prerequisite for some Linux distros (#1481) 2022-10-12 08:52:48 +09:00
Marc Poulhiès f2c4c741b0 Update debugging.md 2022-10-08 12:29:47 +02:00
Marc Poulhiès 68a5db2eb7 Use llvm subdomain for compiler-explorer link
Using `llvm.godbolt.org` subdomain should automatically select the correct LLVM-IR language.
2022-10-08 12:29:47 +02:00
Joshument e864cdb9b7 fix very minor punctuation typo 2022-10-05 17:39:50 +02:00
David Wood a613d5b9e1 diagnostic structs: derive on enum (#1477) 2022-10-05 20:22:46 +09:00
Pietro Albini 397a8f2cf7 Update running tests with the new flags (#1476) 2022-10-05 17:04:49 +09:00
Bruno Kolenbrander c86cf1dd7c Rename typeck to hir_analysis (#1475)
Co-authored-by: mejrs <>
2022-10-04 21:22:00 +09:00
Joshument 14d6444fe5 fix typo and make paragraph consistent (#1474) 2022-10-03 19:38:52 +09:00
Joshua Nelson 3ea1b4022b Update about-this-guide.md 2022-10-02 20:06:43 +02:00
Joshua Nelson 450beef13f Link to the correct page in "about this guide"
Previously, "Building and debugging `rustc`" linked to the getting started page, which isn't correct. If people want that page, it already appears in the sidebar, and is the next sequential page.
2022-10-02 20:06:43 +02:00
Lukas Wirth 21a8552e40 Update r-a config suggestions
The proc-macro server path is required for proc-macros to properly work in r-a when working on rustc.
Pointing the sysroot to the stage0 one is more correct than using the system installed one.
2022-10-01 15:48:54 -05:00
Ralf Jung 6b01ad5a98 don't refer to the compile-time interpreter as "Miri" (#1471) 2022-09-26 18:07:23 +09:00
Jhonny Bill Mena d8eb01ae15 UPDATE - Diagnostic docs to reflect renamed traits and macros in rustc PR#101558 2022-09-22 10:29:32 +01:00
Yuki Okushi 811ac7b30b Fix some typos
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-09-22 10:45:25 +02:00
Alex Saveau 890a32b6e7 Update stability guide to use CURRENT_RUSTC_VERSION (#1468) 2022-09-20 07:43:59 +09:00
Waffle Maybe b18b3edd4d Add a note about building `rust-analyzer-proc-macro-srv` (#1467) 2022-09-19 15:50:02 +09:00
Felix S Klock II 00db68b612 Link from "implementing to new features" to mcp.md (#1465) 2022-09-16 07:06:59 +09:00
Tshepang Mbambo cf7c209ce2 remove stray ** 2022-09-14 09:09:28 -07:00
Oli Scherer 339720081b Explain the new valtree system for type level constants. (#1097)
* Explain the new valtree system for type level constants.

* Update src/const-eval.md

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

* Update src/const-eval.md

Co-authored-by: lcnr <rust@lcnr.de>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-09-13 14:33:10 +02:00
Joshua Nelson 5fe399e27f fix typos and formatting
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-09-12 18:48:21 -05:00
Joshua Nelson 277044dea7 Say "bootstrap" instead of "rustbuild"; the latter is not explained anywhere and is not much more clear. 2022-09-12 18:48:21 -05:00
Joshua Nelson dd57806c2b Rewrite the section on passing flags to subcommands
- Move the reference for directories and actions to the very end; it's the most rare to need to know
- Add `RUSTDOCFLAGS*`, `CARGOFLAGS*`, `-vvv`, and `--test-args`
- Remove the incorrect `--on-fail` command
2022-09-12 18:48:21 -05:00
Joshua Nelson 7bda73f627 Remove the diagram of all outputs generated by x.py
These are already present in the table below, there's no need to repeat it.
Having it near the middle of the page makes it feel more overwhelming.
2022-09-12 18:48:21 -05:00
Joshua Nelson 150bafb8d0 "symbol names" => ABI
ABI is more general and gives a better idea of what goes wrong.
2022-09-12 18:48:21 -05:00
Devin Jeanpierre 01c550ef63 Add symbol-addition to the how-to for new features (#1457)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-09-12 06:19:13 +09:00
Eric Holk 48776510af Fix typo (#1459) 2022-09-09 10:50:44 +09:00
Xiretza 5f7f3e491b Document multipart_suggestion derive on SessionSubdiagnostic 2022-09-05 10:59:20 +01:00
Samyak Sarnayak e1b4fba955 Add reference for updating Windows PATH and fix typo
Yes, the reference is a page on Java's documentation but that's the most complete and most official looking reference I could find.
2022-09-03 06:11:07 +02:00
Eric Huss 4123cb2cd9 Update for removal of RLS (#1450) 2022-09-02 23:03:15 +09:00
Yuki Okushi ae90271297 Fix the link to `Parser` struct
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-08-29 20:07:51 +02:00
Yuki Okushi b2b91374a2 Remove a dangling link on "The `#[test]` attribute"
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-08-29 20:07:51 +02:00
est31 7c9290a5b5 Update the stabilization guide to refer to the new placeholder system
The stabilization process is changed to now use `CURRENT_RUSTC_VERSION`
instead of spelling out whatever version is currently the latest.
This placeholder will be replaced during the release process with the
correct version.
2022-08-27 21:45:28 -04:00
Tshepang Mbambo 22863fbc4b Refine the lintstore section (#1429) 2022-08-27 14:59:56 +09:00
Tshepang Mbambo ea43d6b258 typo 2022-08-27 06:25:51 +02:00
Micah Weston 39fa4dbe24 Updates text to refer to LLVM documentation. 2022-08-27 06:25:51 +02:00
Micah Weston 55b49dbc3b Updates LLVM prereqs since upgrade to C++17. 2022-08-27 06:25:51 +02:00
Tshepang Mbambo f54dffb9e1 we got 3 (#1447) 2022-08-27 00:34:44 +09:00
SparrowLii 4128e99571 A few corrections 2022-08-26 06:18:21 +02:00
SparrowLii bbdb0ca29c Update some statements 2022-08-26 06:18:21 +02:00
SparrowLii 09dd4d4f49 correct typo in parallel-rustc.md 2022-08-26 06:18:21 +02:00