Commit Graph

2135 Commits

Author SHA1 Message Date
Eric Huss d2ca260fcb
Add a chapter on editions. (#1835) 2023-12-12 16:42:10 -03:00
Eric Huss 44b2f27ddd
Remove mentions of plugin lints (#1833) 2023-12-06 10:48:33 -03:00
Eric Huss 993c157a49
Fix typo of unused_parens (#1832) 2023-12-05 18:08:53 -03:00
Santiago Pastorino 2d11bd67d4 Replace experts map with reviewers from triagebot 2023-12-05 18:40:26 +02:00
Krasimir Georgiev 904bb5aa7b 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 03113babc5
notification groups: add information about how to ping them to the respective pages (#1818) 2023-11-27 19:08:19 -03:00
Guillaume Gomez 7620355f54
Add explanations on how to run rustc_codegen_gcc tests (#1821) 2023-11-27 19:05:08 -03:00
Charles Lew f4c8255c79
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 4d43a3b780 emphasize that the experts map is not up to date 2023-11-22 08:13:00 +02:00
Michael Goulet ddb8b1309f Add link for unsize.md 2023-11-18 13:08:13 -08:00
David Spickett a07ec826e4
Fix typo in contribution walkthrough (#1824) 2023-11-11 00:11:39 +09:00
Zalathar 2712dfed5c Update documentation for coverage tests 2023-11-08 16:43:50 +02:00
lcnr 77dbe5782b add a new type system invariant 2023-11-06 08:14:34 -08:00
Zalathar f42a31fd2b Update some outdated descriptions of coverage instrumentation 2023-11-04 01:17:57 +00:00
Michael Goulet cd0eabf4f6 Add some documentation for unsizing 2023-11-02 06:23:08 -04:00
Leonard Hübner 7c285965dc fixing author of "You Can't Spell Trust Without Rust" 2023-10-31 17:58:29 +02:00
Onur Özkan 92cb635e2a
remove change-id from sample build configuration (#1813) 2023-10-30 02:16:41 +09:00
Nicholas Bishop 57061ca79c
Update name of "active" features to "unstable" (#1814) 2023-10-30 02:16:02 +09:00
Oğuz Ağcayazı b0ee9ec8fa
Add WF to glossary (#1810) 2023-10-22 12:18:44 +09:00
Ethan Brierley 3febac0545 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 99157af533
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 2c65ca9a91
Document subtle implied bounds issue in RPITIT inference (#1807) 2023-10-14 15:53:57 +02:00
Ethan Brierley 1a018c8cd6 [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 b98af7d661
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 b7e20c4a05
update rustc_driver examples (#1803) 2023-10-05 19:19:12 +09:00
Ethan Brierley 3735857dc5 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 a13b7c28ed impl traits 2023-09-25 07:14:41 +02:00
Jakub Beránek c41116daf7
Modify build instructions for optimized build (#1795) 2023-09-22 01:33:41 +09:00
Stuart Cook 2025284148
Remove outdated references to coverage debug code (#1797) 2023-09-22 01:32:45 +09:00
Boxy cb4c521e5b line length limit 2023-09-19 10:19:58 -07:00
Boxy 5dbd0293bd add doc and move existing stuff around 2023-09-19 10:19:58 -07:00
Ralf Jung 02a966c83b explain the MIR const vs TY const situation 2023-09-18 03:57:13 +02:00
Tshepang Mbambo 6b347d2e3d
fix type name (#1792) 2023-09-15 23:40:09 +09:00
Zalathar ed55e7d6c9 Clarify that `run-coverage` only runs in some of the CI jobs 2023-09-12 13:27:25 +02:00
Zalathar aafa886329 Revise the docs for coverage instrumentation tests 2023-09-11 23:29:18 +02:00
Zalathar 2eb01f948f Document the `coverage-map` and `run-coverage` test suites 2023-09-11 23:29:18 +02:00
Tshepang Mbambo 08bb147d51
make link more pleasant to eye too (#1778) 2023-09-11 19:36:36 +09:00
Tshepang Mbambo be5a669292 grammar 2023-09-08 12:59:13 +02:00
Tshepang Mbambo 22500eeb08 typo 2023-09-08 12:59:13 +02:00
Prashant-Shekhar-Rao b41735fa2e 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 054eb75f6f Review changes 2023-09-05 23:14:26 +02:00
Jakub Beránek 083cbb42ac Add section about building an optimized version of `rustc` 2023-09-05 23:14:26 +02:00
Ken b02c792794 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 d61a12acdf 1675 move 'failed to push some refs' into its own section 2023-08-30 10:02:41 +02:00
zahash f83c46a12e 1675 add a 'Squash your commits' header to 'Advanced Rebasing' section in git 2023-08-30 10:02:41 +02:00
zahash 1f77525b1b move placement of std-dev-guide link (#1699) 2023-08-29 10:45:38 +02:00
zahash 6ec5335b07 link std-dev-guide from landing page (#1699) 2023-08-29 10:45:38 +02:00
Ethan Brierley 78c9b0b7a0 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 51bae06634
remove (excessive) indentation (#1781) 2023-08-27 10:02:25 +09:00
Tshepang Mbambo 9bdf3d37a6
coverage tests have moved, twice (#1780) 2023-08-27 10:02:12 +09:00
Tshepang Mbambo 64056ea4a3
remove extraneous word (#1779) 2023-08-27 10:01:25 +09:00
Tshepang Mbambo e453e38d00
llvm updates (#1761) 2023-08-27 10:00:45 +09:00
Tshepang Mbambo fefec88ac2
make link more pleasant to eye (#1777) 2023-08-27 10:00:20 +09:00
Tshepang Mbambo 8082f48d43
date-check: test suites/classes using "revisions" (#1738) 2023-08-27 09:59:53 +09:00
Tshepang Mbambo 0985f5d7c7
share link target (#1740) 2023-08-27 09:58:58 +09:00
Tshepang Mbambo 0a886681dc
indicate full hierarchy of config option (#1776) 2023-08-27 09:58:31 +09:00
Tshepang Mbambo 2c22cee942
remove stray word (#1773) 2023-08-27 09:50:17 +09:00
Tshepang Mbambo 17fba0e2a8
it is lower-case (#1772) 2023-08-27 09:50:02 +09:00
Ethan Brierley 24c8e8cf88
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 8fd4dd12ed Fix long lines 2023-08-22 15:31:14 +01:00
Wesley Wiser 0322fb4585 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 196b7f4555 avoid repetition 2023-08-22 08:52:56 +02:00
yukang 844d5812fb Fix broken links format 2023-08-22 08:52:56 +02:00
Tshepang Mbambo 9061333dda fix link 2023-08-21 07:28:56 +02:00
Tshepang Mbambo 745d796921 missing space 2023-08-21 07:28:56 +02:00
Tshepang Mbambo 94bd1b105a fix link 2023-08-21 07:28:56 +02:00
Tshepang Mbambo 40a4798e87 avoid link rot 2023-08-21 07:28:56 +02:00
yukang 28713ffc3a update internal terminology: Substs -> GenericArgs 2023-08-21 07:28:56 +02:00
Absobel 59030cb780 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 973e4f379e
Update outdated doc for types (#1768) 2023-08-20 00:40:18 -07:00
Santiago Pastorino 101bfc8748
Add dropck documentation (#1767) 2023-08-18 23:13:31 +02:00
Emmanuel Ferdman b123ab4754 fix: stabilize debugger_visualizer
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
2023-08-14 10:34:59 +02:00
İsmail Arılık 3c5c7469c1 refactor(parts): remove part numbers to be consistent 2023-08-11 09:55:19 +02:00
İsmail Arılık 4fa0caa0eb 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 49a22eaa34 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 dfa37d5bce 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 d68d69a8ad feat(part-5-intro): make "Part 5" obvious 2023-08-11 09:55:19 +02:00
Nicky Lim fb7ec2cdcf Improve clarity about attribute applicability 2023-08-08 09:16:43 +02:00
Nicky Lim da891f26b9 Update to new warning attribute 2023-08-08 09:16:43 +02:00
Santiago Pastorino 8cd3eb9978
Add RPITIT documentation (#1764) 2023-08-03 18:21:23 -03:00
İsmail Arılık 218da21e5d 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 24eebb6df9 fix(name-resolution): remove unnecessary closing paranthesis 2023-07-30 13:23:23 +02:00
İsmail Arılık d9128a94ed 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 25ca6c5937 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 fb00c85bd6 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 20b988ca1b fix(salsa.md): add punctuation to prevent confusion 2023-07-27 11:28:57 +02:00
İsmail Arılık ff84b69736 fix(salsa.md): remove duplicate "To Be" verb 2023-07-27 11:28:02 +02:00
İsmail Arılık 9ddd128654 feat(fuzzing.md): make `halfempty` word a link 2023-07-24 15:35:47 +02:00
İsmail Arılık 03dbdbe537 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 214b39656b refactor(git.md) use `<>` instead of long `[...](...)` syntax for plain links 2023-07-22 14:16:37 +02:00
İsmail Arılık 2c857329e1 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 246dd2526c 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 e24c4997b3 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 d2a9df4066 refactor(profiling/with_perf): remove a wrong to be verb 2023-07-19 16:54:57 +02:00
İsmail Arılık 151dcc1e81 refactor(tests/headers): remove duplicate list item 2023-07-18 16:02:36 +02:00
İsmail Arılık d5d39323bb refactor(test/headers.md): make the meaning more obvious 2023-07-18 16:01:21 +02:00
İsmail Arılık ec0a5f1d3e refactor(tests/ui): remove unnecessary duplicate word 2023-07-18 14:04:05 +02:00
İsmail Arılık f15fd8ba86 fix(duplicate): remove unnecessary duplicate word 2023-07-18 12:17:31 +02:00
Mahdi Dibaiee 6e6f620f83 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 c514440e84 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 3ed56e7562 make it read better 2023-07-14 08:39:30 +02:00
İsmail Arılık a6896cf5b8 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 2f05d62270 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 3448f660a3
linked issue is closed (#1729) 2023-07-13 04:02:06 +09:00
İsmail Arılık 88340e1754 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 ec67371c7a Update src/early-late-bound.md 2023-07-11 16:43:01 -04:00
Boxy 7a8d862e0b caps is so important
Co-authored-by: Michael Goulet <michael@errs.io>
2023-07-11 16:43:01 -04:00
Boxy 6e0f9a28d7 Gats isnt the only cool kid anymore
Co-authored-by: Michael Goulet <michael@errs.io>
2023-07-11 16:43:01 -04:00
Boxy 59f13569d4 split file and replace with deep dive doc 2023-07-11 16:43:01 -04:00
lcnr 1726dad207 add section for normalization with the new solver 2023-07-11 19:59:26 +01:00
İsmail Arılık 492a6a89de 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 b5a12d95e3
fix: update link to function coverage (#1727) 2023-07-09 23:50:50 +09:00
İsmail Arılık c7d6710791
Fix a bug in getting-started.md (#1726) 2023-07-09 19:22:22 +09:00
Tshepang Mbambo b10654acbf
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 6d5b3db86f
various fixes/improvements to Contributing chapter (#1723) 2023-07-08 11:52:53 +09:00
Tshepang Mbambo 065890922b
ty::ConstKind has moved (#1724) 2023-07-08 01:36:13 +09:00
Rémy Rakic 95ce2372ba document `.x test --rustc-args` option 2023-07-05 02:14:36 +02:00
Tshepang Mbambo e59209007e tests/run-make files have moved 2023-07-03 09:36:22 +02:00
Tshepang Mbambo a0f596fbbf
replace dead link (#1717) 2023-07-03 10:34:58 +09:00
Tshepang Mbambo 68967d764c fix link 2023-07-02 16:16:44 -07:00
Tshepang Mbambo 49b868edd1 update link 2023-07-03 00:51:52 +02:00
Tshepang Mbambo 07c92b839d typo 2023-07-02 12:29:13 -07:00
Tshepang Mbambo 605c35a9b2 OwningRef exists no more 2023-07-02 13:17:42 +02:00
sslime336 07f16bb886 Try to avoid confusion 2023-07-01 08:14:17 +02:00
Tshepang Mbambo 8648005e50 typo 2023-06-30 23:11:14 +02:00
sslime336 37ffa3061c Fix line length out of limit 2023-06-30 23:11:14 +02:00
sslime336 50dbcba002 Change `x.py` into `x`, add explanation for `x` 2023-06-30 23:11:14 +02:00
sslime336 d3034ae828 Change `./x.py` into `./x` 2023-06-30 23:11:14 +02:00
jyn 7267158f9d include rustc-dev-guide's own issues in suggested search 2023-06-29 18:21:18 +02:00
jyn c8213e1ceb Improve Windows docs 2023-06-29 10:05:10 -05:00
jyn 1690634099 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 c01a1fa294 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 855a295e83 fix broken link 2023-06-29 10:05:10 -05:00
jyn 5a6171ca9a move the Breaking Changes section later in the guide 2023-06-29 10:05:10 -05:00
jyn 8ff4abb0f8 distinguish language and library processes more consistently 2023-06-29 10:05:10 -05:00
jyn dd45ecfd2c 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 2cbc4c1f2c Reword `messages.ftl` example. 2023-06-29 06:43:19 +02:00
Eric Huss dda77e082f Fix some links 2023-06-29 06:43:19 +02:00
Tshepang Mbambo 7fa8c5507f fix link 2023-06-28 06:55:24 +02:00
Eric Huss f8e4d5c0c8 Define more lint terms 2023-06-28 06:55:24 +02:00
Oleksandr Babak 17fe3e9484 fix_typo 2023-06-26 18:34:26 +02:00
Tshepang Mbambo 54e91b0d59
run-make tests: fix and improve (#1702) 2023-06-26 23:03:03 +09:00
lcnr d3e8307298
add stub for proof trees (#1700) 2023-06-23 23:40:25 +01:00
Zyranivia 7f22c49fa7
Update track_caller reference link (#1688) 2023-06-21 18:14:16 +09:00
Zachary Whiteley ef7bfef63d
Include information about setup defaults in how-to-build guide (#1694) 2023-06-21 18:13:53 +09:00
Caleb Robson d2d2386cd0
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 f3d601fddb Fix typo in thir.md 2023-06-13 21:18:46 -07:00
Eric Huss 73f65f63ac Update triagebot links. 2023-06-13 20:49:13 +02:00
Arthur Cohen 611c9418f5 name-resolution: Fix some typos in "Scopes and ribs" 2023-06-13 19:45:19 +02:00
clubby789 f1e637883f Add note about shell completion scripts 2023-05-17 21:44:05 -05:00