Commit Graph

2393 Commits

Author SHA1 Message Date
Ardi 8b88776316 Toc here is overkill 2024-05-15 09:45:05 +02:00
许杰友 Jieyou Xu (Joe) 34b055b8f8 Link to lint L-* labels 2024-05-13 20:09:18 +02:00
Matthew Woodcraft 0bfce7989f Update the rustc_interface examples for current rustc (#1974) 2024-05-11 00:06:30 +01:00
surechen 4f5d764758 Edit `Parameter Environments`'s url as it has been edited in #1953 2024-05-09 15:22:03 +02:00
Urgau d0cd4f5dbb Improve FALSE sentence
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2024-05-06 08:48:21 +02:00
Urgau f4c400cdf2 Add documentation for check-cfg by-default in UI tests 2024-05-06 08:48:21 +02:00
Mads Marquart b07fb9546d Add Apple notification group (#1964) 2024-05-05 14:13:50 -04:00
Jakub Beránek 4874368185 Add an example how to add a job to PR CI 2024-05-04 08:04:25 +02:00
Jakub Beránek dff746fb9c Update CI documentation to avoid mentioning `expand-yaml-anchors` 2024-05-04 08:04:25 +02:00
Yutaro Ohno cbd09807b0 Rename `-Z verbose` to `-Z verbose-internals`
The `-Z verbose` option has been renamed to `-Z verbose-internals` in
commit  b5d83619 [1] (PR #119129 [2]). This commit updates the remaining
`-Z verbose` to `-Z verbose-internals`.

[1]: b5d8361909
[2]: https://github.com/rust-lang/rust/pull/119129
2024-04-30 10:15:49 +02:00
Emanuel Czirai 588fd8f4da typo traige->triage 2024-04-28 20:31:21 +02:00
Trevor Gross 34aaf19626 Add a note about checks with multiple revisions (#1963) 2024-04-13 16:16:44 +01:00
许杰友 Jieyou Xu (Joe) 75c164f9c5 compiletest: clarify that headers must be one header per line 2024-04-11 05:14:52 +02:00
needsure 2dd74894e8 chore: fix some typos in conments
Signed-off-by: needsure <qinzhipeng@outlook.com>
2024-04-09 10:59:59 +02:00
许杰友 Jieyou Xu (Joe) 43f390bed0 compiletest: specify which special env var and which particular CI job (#1960)
* compiletest: specify which special env var and which particular CI job

* compiletest: fix grammar and add link to Dockerfile
2024-04-08 21:00:54 +02:00
许杰友 Jieyou Xu (Joe) 1b1b3b4627 Explicitly mention compiletest directives are supported in rmake.rs (#1949) 2024-04-06 22:41:09 +02:00
Michael Howell c56637ddb2 Add docs for sharded descriptions 2024-04-06 22:17:41 +02:00
Martin Nordholts 4f4e8ee67d Add basic docs for the new `aux-bin` header (#1942) 2024-04-06 21:01:03 +01:00
Eric Huss 522ca9b495 Add needs-threads header command (#1943) 2024-04-06 20:57:34 +01:00
Prashanth Mundkur 4065bd5d9d Fix some broken links under bootstrapping. (#1958)
* Fix some broken links under bootstrapping.

* Fix more broken links for bootstrapping.
2024-04-06 20:55:06 +01:00
Tim Neumann ef095092e5 Replace -Zno-parallel-llvm with -Zno-parallel-backend
This was renamed by https://github.com/rust-lang/rust/pull/116791.
2024-04-05 07:05:33 +02:00
Boxy af587b635f Fix some broken links 2024-04-01 17:25:54 +01:00
Boxy 3c8a96562f Reorganise into subchapters and explain `Reveal` 2024-04-01 17:25:54 +01:00
Boxy a8dac4064c reviews 2024-04-01 17:25:54 +01:00
Boxy 43f38ca174 Change location in guide 2024-04-01 17:25:54 +01:00
Boxy 83bfea8e88 Initial rewrite 2024-04-01 17:25:54 +01:00
Nilstrieb cc608ba78e Add quickstart for how to build and run the compiler (#1951)
* Add quickstart for how to build and run the compiler

The chapter is quite long, and a lot of the information is, while
valuable, not very important for newcomers. I think it makes sense to
have a condensed version for anyone just wanting to get started with
only the most important information.

* A few improvements to quickstart
2024-03-31 06:23:21 +02:00
Nilstrieb 023c0f2592 Delete length check (#1952)
It's super annoying to be forced to use this bad convention, and
apparently everyone agrees. The only reason no improvements have been
done is because those were blocked on writing a better checker.

I strongly believe that no checker is better than a bad checker, so
let's just delete it in the meantime. I kindly asked anyone who sees
this to complain about overly long sentences in review in the future, I
think we can make this turn out fine.
2024-03-30 17:46:30 +01:00
JohnEndson 69c820a470 Fix some comments
Signed-off-by: JohnEndson <jiayuzhen@outlook.com>
2024-03-28 13:58:43 +02:00
Ali MJ Al-Nasrawy b93095aade summary: opaque-types-region-inference-restrictions 2024-03-27 09:49:05 +01:00
Ali MJ Al-Nasrawy 47293569fe add opaque-types-region-inference-restrictions 2024-03-27 09:49:05 +01:00
León Orell Valerian Liehr efcb2806af Rename AstConv to HIR ty lowering 2024-03-23 08:44:42 +01:00
lcnr d53598ae3f add chapter to summary 2024-03-22 12:46:08 +01:00
lcnr 2c12c0cae1 explain rigid aliases 2024-03-22 11:11:41 +00:00
lcnr 3c54328ea1 Update src/solve/significant-changes.md
Co-authored-by: Oli Scherer <github35764891676564198441@oli-obk.de>
2024-03-22 11:11:41 +00:00
lcnr 46a378f87e Update src/solve/significant-changes.md
Co-authored-by: Oli Scherer <github35764891676564198441@oli-obk.de>
2024-03-22 11:11:41 +00:00
lcnr 31dbcb4cef is this sensible? idk 2024-03-22 11:11:41 +00:00
lcnr 89110e1b69 explore significant changes with the new solver 2024-03-22 11:11:41 +00:00
lcnr 086da07147 canonicalization is out of date 2024-03-22 11:11:41 +00:00
Christopher B. Speir 562d701eb8 Fix broken link in chapter '1. How to build and run the compiler'
The 'read this chapter' link under the 'What is x.py?' section
returned a Document not found (404) error.
2024-03-22 10:49:12 +02:00
Tshepang Mbambo 9137b87dec typo 2024-03-19 19:12:28 +01:00
Seo Sanghyeon 2cf4220754 Reflect rustc_codegen_cranelift move 2024-03-18 20:37:35 +02:00
Tbkhi 2f7e0ceb36 Update rustdoc-internals.md (#1911)
* Update rustdoc-internals.md

Minor updates to syntax and some clarifications.

* updates

* Update rustdoc-internals.md
2024-03-13 18:56:14 -03:00
Tbkhi 6df2f59951 Update test-implementation.md (#1937)
* Update test-implementation.md

* Update test-implementation.md
2024-03-13 18:23:20 -03:00
许杰友 Jieyou Xu (Joe) 1d2ddcf7d1 Extract Bootstrap into its own section (#1939)
* Extract Bootstrap into its own section

Add brief explanation for `Step` and `Builder::ensure` as core
Bootstrap internal concepts.

* Drop common commands page (use `x --help` instead)

* Add `make` as an alternative entry point

* Add src/bootstrap/README.md link
2024-03-13 18:18:29 -03:00
Tshepang Mbambo 5ced644d1f typos
Also
- use proper case for rust-analyzer
- reformat a bit, for sembr
2024-03-13 04:28:30 +01:00
Nicholas Nethercote af8bfec148 More updates for recent diagnostics changes.
A sequel to #1883, this covers diagnostic naming changes from
rust-lang/rust/pull/121489, rust-lang/rust/pull/121780, and
rust-lang/rust/pull/122132.
2024-03-12 02:12:31 +01:00
Tbkhi c70780538d Update bibliography.md (#1912)
Minor additions and resorting.
2024-03-11 15:17:28 -03:00
Tbkhi 5d9c4d8775 update rustc-driver-interacting-with-the-ast.md (#1930)
* adding links

* Update src/rustc-driver-interacting-with-the-ast.md

Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>

* redo links and formatting

* Update rustc-driver-interacting-with-the-ast.md

---------

Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2024-03-11 12:37:18 +02:00
Tbkhi 10809fed2f Update rustc-driver-getting-diagnostics.md 2024-03-11 03:11:55 +02:00
许杰友 Jieyou Xu (Joe) aa0d5c1307 Document that test names cannot contain dots (#1927) 2024-03-08 17:44:41 -03:00
Tbkhi 0a9c758ed5 Update overview.md (#1898)
* Update overview.md

Various link addition and minor edits for clarity.

* generic improvements

* fix line lengths for ci/cd

---------

Co-authored-by: Tbkhi <me.stole546@silomails.com>
Co-authored-by: Oliver Dechant <ol922807@dal.ca>
2024-03-04 17:00:53 -03:00
lcnr 57b23c8566 and again 2024-03-04 16:35:43 +00:00
lcnr f6dea9f9cb unfk links 2024-03-04 16:32:44 +00:00
lcnr e4fd19d73f next-solver: document caching (#1923) 2024-03-04 17:26:06 +01:00
Stuart Cook 4e8bd38dda Add compiletest docs for FileCheck prefixes and `//@ filecheck-flags:` (#1914)
This patch also adds docs for `//@ llvm-cov-flags:`, and notes that coverage
tests support revisions (though none of the current tests actually do so).
2024-03-01 23:30:17 +01:00
Arthur Milchior 9ce24d1cbf Use different type in an example (#1908)
* Use different type in an example

Sentences such as «without the argument u32» were ambiguous, as there were two distincts u32. Having a single one, the one in the monomorphization of the type, remove the ambiguity.

* Update src/ty.md

---------

Co-authored-by: Nilstrieb <48135649+Nilstrieb@users.noreply.github.com>
2024-03-01 23:26:16 +01:00
许杰友 Jieyou Xu (Joe) 6595d0e0f0 Update run-make test description (#1920) 2024-03-01 23:22:50 +01:00
Christopher Smyth da54a3f323 Add some more details on feature gating (#1891)
* Add some more details on feature gating

* Apply suggestions from code review

---------

Co-authored-by: Ross Smyth <rsmyth@electrocraft.com>
Co-authored-by: Nilstrieb <48135649+Nilstrieb@users.noreply.github.com>
2024-03-01 23:20:06 +01:00
Nilstrieb 22c2f7ce79 make shell.nix better (#1858)
* make shell.nix better

* Mention using RUST_BOOTSTRAP_CONFIG

* Move things to `buildInputs` and add `glibc.out glibc.static`

This fixes the nofile-limit.rs UI test.

* short lines for the short line fans

* Fix pkgs
2024-03-01 21:26:19 +01:00
lcnr 45a9ad1b94 opaque types in new solver (#1918)
* add opaque types doc

* summary
2024-03-01 13:11:55 +01:00
lcnr 76ba3342c2 add implied bounds doc (#1915)
* add implied bounds doc

* lazy type aliases also have explicit implied bounds
2024-02-29 10:46:28 +01:00
许杰友 Jieyou Xu (Joe) 601180f306 Update compiletest directives to be in `ui_test` style `//@` 2024-02-22 20:15:52 +01:00
Yukang b88a4c5275 Add notes on tweak rust-analyzer.check.overrideCommand (#1890) 2024-02-21 12:18:39 -03:00
Yuki Okushi e0a9ace640 Fix more links (#1884) 2024-02-21 12:17:28 -03:00
Matthew Woodcraft 0916e9b8f5 Remove reference to -Z ast-json and -Z ast-json-noexpand
These were removed in 2021.
https://github.com/rust-lang/rust/pull/85993
2024-02-17 20:47:05 +01:00
许杰友 Jieyou Xu (Joe) 7bd9e91ef2 Specify ui test suite directives and add note on ignore-tidy directives 2024-02-16 18:26:58 -05:00
Michael Goulet 0d76693d12 Update src/tests/ui.md
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2024-02-16 18:13:52 -05:00
Oli Scherer a4c86d8802 Update docs about ui tests now using `//@` headers 2024-02-16 18:13:52 -05:00
Jakub Beránek e8ff7a3703 Make git rebase commands more bulletproof (#1889) 2024-02-14 19:00:15 -03:00
Tshepang Mbambo d35ba2d211 updating-llvm.md: command does not work (#1887) 2024-02-13 22:39:15 +09:00
Gnana Ganesh 270705068e fix update llvm build command 2024-02-13 14:13:06 +02:00
Tshepang Mbambo 2d723b72d2 separate link target from normal content 2024-02-11 06:36:15 +01:00
Tshepang Mbambo 5db009b4f0 fix sentence 2024-02-11 06:36:15 +01:00
Nicholas Nethercote 164f24ff6d Some updates for recent diagnostics changes. 2024-02-10 04:48:19 +02:00
Gurinder Singh c540dbae9b Rename occurrences of 'delay_span_bug' to 'span_delayed_bug'
since this method has been renamed in rustc.

Also remove a link to  documentation in error-guaranteed.md because it was unused
2024-02-08 20:16:06 +02:00
Eric Huss ae9c529137 Update for upcoming markdown changes. (#1880) 2024-02-07 10:23:35 -03:00
syvb e9b3a0e613 Update uses of renamed BoxMeUp to PanicPayload 2024-01-30 09:56:43 +00:00
Arthur Milchior e8c0bb0557 Add links for arena and interning. (#1868)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2024-01-30 04:55:16 +09:00
Arthur Milchior e73ca04574 Improving macro expansion section (#1875) 2024-01-30 04:53:39 +09:00
Arthur Milchior 48fc9c1f27 Replace letters by foo, bar and buz in lexing example (#1870) 2024-01-30 04:53:07 +09:00
David Semakula 23f15463d9 Fix some broken links (#1877) 2024-01-30 04:49:51 +09:00
Yuki Okushi 7ec01f19d1 Fix some links (#1865) 2024-01-28 19:44:41 -03:00
Arthur Milchior 7cb080b9c9 Add link in salsa (#1866)
* Add link in salsa

* Update src/salsa.md

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

* Update src/salsa.md

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

---------

Co-authored-by: León Orell Valerian Liehr <me@fmease.dev>
2024-01-28 19:42:26 -03:00
Arthur Milchior 53ade300c2 Clarify what rt.rs is. (#1876)
Most files names are relatively explicit and probably don't need to be
explicited.  However `rt.rs` is really not clear, and I believe it clarifies the
text to indicate this is runtime service implementation.
2024-01-28 19:40:36 -03:00
the8472 e334398243 update link to rustc dependencies (#1869) 2024-01-28 12:42:18 +01:00
Arthur Milchior a600635fad Followup to #1862 (#1864) 2024-01-28 06:12:41 +09:00
Arthur Milchior e6de7e3ac2 Clarify debugging graph dependency (#1862) 2024-01-28 05:42:06 +09:00
Shoyu Vanilla a51498f7ed Update examples (#1856)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2024-01-21 22:26:41 +09:00
Jakub Beránek 66c56a44fd Add a perf. bot command and a link to its help page 2024-01-20 18:20:04 +01:00
Yukang b99b876c15 Add some explanations for frequently used rustbot commands (#1849)
* add some explain for rustbot commands

* add more details about shortcuts

* fix words on `r=someone`

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

---------

Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2024-01-20 19:56:35 +08:00
Tshepang Mbambo 9ad9d15da9 update some of the diagnostic translations info (#1711) 2024-01-20 20:47:06 +09:00
matthewjasper 93aeba6e75 Document unsafety checking (#1847)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2024-01-20 20:46:58 +09:00
Zalathar 7650a97c11 Remove outdated references to `-Z dump-mir-spanview`
This flag was removed by <https://github.com/rust-lang/rust/pull/119566>.
2024-01-16 10:28:45 +02:00
onur-ozkan ca6139dd0d update old bootstrap docs
Signed-off-by: onur-ozkan <work@onurozkan.dev>
2024-01-15 19:44:49 +02:00
León Orell Valerian Liehr 4083ae0309 Add guidelines for backport-accepted PRs 2024-01-14 11:42:53 +01:00
León Orell Valerian Liehr 034cee9ed6 Mention label has-merge-commits 2024-01-14 11:42:53 +01:00
Arthur Milchior 1fb019f237 Correct the link to rust reference
The current link provides a link to two versions of the book, both redirecting to the "current version", which is the link this PR uses
2024-01-12 14:08:53 +02:00
Nadrieril 7f49cdcba2 Explain the important concepts of exhaustiveness checking 2024-01-07 11:54:59 +02:00
Michael Howell eb008cbd1e Add guide for rustdoc search implementation (#1846) 2024-01-06 18:47:01 +01: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
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