Commit Graph

2346 Commits

Author SHA1 Message Date
Tbkhi 020d4a8740
Update bibliography.md (#1912)
Minor additions and resorting.
2024-03-11 15:17:28 -03:00
Tbkhi 8a5d647f19
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 aa2a0d1e99 Update rustc-driver-getting-diagnostics.md 2024-03-11 03:11:55 +02:00
许杰友 Jieyou Xu (Joe) f8631011aa
Document that test names cannot contain dots (#1927) 2024-03-08 17:44:41 -03:00
Tbkhi d43fff786b
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 e082dc6f00 and again 2024-03-04 16:35:43 +00:00
lcnr 0d04d711d4 unfk links 2024-03-04 16:32:44 +00:00
lcnr 3af8b74e54
next-solver: document caching (#1923) 2024-03-04 17:26:06 +01:00
Stuart Cook fbea746002
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 d866c3863c
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) a9ab50ba68
Update run-make test description (#1920) 2024-03-01 23:22:50 +01:00
Christopher Smyth cf9fb88049
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 9ef55c55db
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 231c30fcfa
opaque types in new solver (#1918)
* add opaque types doc

* summary
2024-03-01 13:11:55 +01:00
lcnr a539558158
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) 7b0ef5b0be Update compiletest directives to be in `ui_test` style `//@` 2024-02-22 20:15:52 +01:00
Yukang a29bab89af
Add notes on tweak rust-analyzer.check.overrideCommand (#1890) 2024-02-21 12:18:39 -03:00
Yuki Okushi bafd382a4a
Fix more links (#1884) 2024-02-21 12:17:28 -03:00
Matthew Woodcraft 2ae89498fc 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) 75aad4b9d9 Specify ui test suite directives and add note on ignore-tidy directives 2024-02-16 18:26:58 -05:00
Michael Goulet 2c01b499aa Update src/tests/ui.md
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2024-02-16 18:13:52 -05:00
Oli Scherer 2c6117b5ad Update docs about ui tests now using `//@` headers 2024-02-16 18:13:52 -05:00
Jakub Beránek 91332ec5e4
Make git rebase commands more bulletproof (#1889) 2024-02-14 19:00:15 -03:00
Tshepang Mbambo aa797838e8
updating-llvm.md: command does not work (#1887) 2024-02-13 22:39:15 +09:00
Gnana Ganesh e3db7340e5 fix update llvm build command 2024-02-13 14:13:06 +02:00
Tshepang Mbambo 1f30cc7cca separate link target from normal content 2024-02-11 06:36:15 +01:00
Tshepang Mbambo 2c8856ae5b fix sentence 2024-02-11 06:36:15 +01:00
Nicholas Nethercote e3d8733f7b Some updates for recent diagnostics changes. 2024-02-10 04:48:19 +02:00
Gurinder Singh af8e2fe2f8 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 fd6ed0ddcd
Update for upcoming markdown changes. (#1880) 2024-02-07 10:23:35 -03:00
syvb 91150253a1 Update uses of renamed BoxMeUp to PanicPayload 2024-01-30 09:56:43 +00:00
Arthur Milchior 9f9c9d28d4
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 11aa615575
Improving macro expansion section (#1875) 2024-01-30 04:53:39 +09:00
Arthur Milchior ea1767da49
Replace letters by foo, bar and buz in lexing example (#1870) 2024-01-30 04:53:07 +09:00
David Semakula 4875b60780
Fix some broken links (#1877) 2024-01-30 04:49:51 +09:00
Yuki Okushi 3329715501
Fix some links (#1865) 2024-01-28 19:44:41 -03:00
Arthur Milchior f8f61f94ea
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 7c6fe0b0ac
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 9dbff1e8a6
update link to rustc dependencies (#1869) 2024-01-28 12:42:18 +01:00
Arthur Milchior 5a7b5f8643
Followup to #1862 (#1864) 2024-01-28 06:12:41 +09:00
Arthur Milchior a79d2364e7
Clarify debugging graph dependency (#1862) 2024-01-28 05:42:06 +09:00
Shoyu Vanilla c2717f6fe6
Update examples (#1856)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2024-01-21 22:26:41 +09:00
Jakub Beránek 4b5116a5cf Add a perf. bot command and a link to its help page 2024-01-20 18:20:04 +01:00
Yukang a0eee2cfae
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 bd181b2457
update some of the diagnostic translations info (#1711) 2024-01-20 20:47:06 +09:00
matthewjasper 4767d5af94
Document unsafety checking (#1847)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2024-01-20 20:46:58 +09:00
Zalathar 1dc1152ccc 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 f3f15a9c04 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 4af29d1a7f Add guidelines for backport-accepted PRs 2024-01-14 11:42:53 +01:00
León Orell Valerian Liehr fc36182723 Mention label has-merge-commits 2024-01-14 11:42:53 +01:00
Arthur Milchior 8042fcc7d8 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 45fa40412f Explain the important concepts of exhaustiveness checking 2024-01-07 11:54:59 +02:00
Michael Howell 5606d30fcc
Add guide for rustdoc search implementation (#1846) 2024-01-06 18:47:01 +01:00
Zalathar d13e85152a 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 84ea9ec51a
Add a description of `unpretty=hir` to the HIR docs (#1842) 2023-12-29 10:07:07 +09:00
Michael Goulet cb22c581cd
Fix typo in unsize docs (#1843) 2023-12-29 10:06:18 +09:00
Nadrieril 038010ba02
Suggest `gcc_multi` to make `mir_opts` run on nixos (#1841) 2023-12-19 19:07:35 +09:00
Martin Nordholts ef41fc0d87
bootstrapping: Clarify that stage0 std code is not executed to produce stage1 compiler (#1840) 2023-12-19 19:02:34 +09:00
jyn 0610665a86 add a mailmap 2023-12-17 18:21:38 +01:00
Eric Huss 843c390de0
Move Editions chapter to "Contributing to Rust". (#1838) 2023-12-14 20:28:32 +09:00
Eric Huss eb0273ab0b
Remove feature edition fields. (#1836) 2023-12-13 21:19:43 +09:00
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
jyn ee5285347d
filter out S-blocked issues in the "Getting Started" search (#1687) 2023-05-15 05:24:31 +09:00
Ben Kimock 9d8c600cab
Rename InstCombine to InstSimplify (#1684) 2023-05-11 18:59:47 +09:00
Yukang 5f48c757c7
Use unpretty for debugging Hir (#1685) 2023-05-11 18:59:23 +09:00
Eric Huss 28dbeaf5c4 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 533a8ec5ad typo 2023-04-26 12:09:10 -07:00
lcnr 635bab1835 extend the sixth requirement 2023-04-26 12:09:10 -07:00
Lukas Wirth 2a5eb92197
Add docs for compare-output-lines-by-subset flag (#1677) 2023-04-22 20:50:11 +09:00
Tshepang Mbambo d0d581b140
fix typo (#1674) 2023-04-22 20:49:13 +09:00
Brian Kung 27545105c3
Fix links in how-to-build-and-run.md (#1679) 2023-04-22 20:48:44 +09:00
Ezra Shaw a4a1a7cf12 docs: document new `suggest-tests` tool 2023-04-16 13:56:19 +02:00
Ohad Ravid 0ff2326425 Fix extra slash 2023-04-16 13:30:24 +02:00
Tshepang Mbambo 6337ed17fb
fix markup (#1670) 2023-04-10 23:23:05 +09:00
Joshua Nelson 516194c5e8 Link to governance page
It has links to the specific channel/stream for each team.
2023-04-09 22:38:15 +02:00
jyn 8bf09013c0 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 177ca5e602 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 2d2ef1329a 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 0ccf85aa5b Fix link; remove duplicate link 2023-04-09 22:38:15 +02:00
jyn 3780fbf5e4 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 c87993ba74 Clarify cfg(bootstrap) docs 2023-04-09 21:38:54 +02:00
jyn 26315eb365 document that it's rare for books to break 2023-04-09 21:20:55 +02:00
jyn d483584b37 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 4d14b76152 fix incorrect miri mentions in "External Repos" chapter 2023-04-09 21:20:55 +02:00
jyn 40823ca392
Improve the landing page for contributing to the libstd docs (#1666) 2023-04-09 12:10:27 +09:00
jyn cf4daae9a6
Various improvements to `check_line_lengths.sh` (#1667) 2023-04-09 12:08:46 +09:00
jyn c869139156
Document how to ignore specific files in a diff (#1668) 2023-04-09 12:07:16 +09:00
y21 0520099156 fix line length 2023-04-05 19:29:18 -05:00
y21 b141161991 mention `git clone --depth` 2023-04-05 19:29:18 -05:00
Joshua Nelson fca8af6c15 add a few more TOC sections 2023-04-03 06:42:31 -05:00
Joshua Nelson 3cd6d38426 Remove duplicate section on new features in CONTRIBUTING.md 2023-04-03 06:42:31 -05:00
Joshua Nelson 8fc85f17ef Link to bug-fix-procedure.md from the contribution procedure section 2023-04-03 06:42:31 -05:00
Joshua Nelson 2ff743c00b 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 3790dd62b9 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 33c6ea1e8c 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 d436bf134e
Make REUSE ignore section heading as a copyright statement (#1659) 2023-04-03 20:09:34 +09:00
Eric Huss a071dc8c54
Update some links and information for cargo-bisect-rustc (#1657) 2023-04-02 15:15:55 +09:00
Tshepang Mbambo 513a1e4299
update rustc_driver examples (#1655) 2023-04-01 09:35:35 -04:00
Shahar Dawn Or 5eca47362a bootsrapping stages overview list 2023-03-23 15:36:00 +02:00
Eric Huss 8a94e36e0d
Update labels overview (#1639) 2023-03-21 18:07:36 +09:00
Tshepang Mbambo 3b6a1bdb2c
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 9bdc3996c3
Add SIP solution for macOS users (#1636) 2023-03-21 17:50:39 +09:00
Langston Barrett 7cef03afaf Reword to include 'distractions' 2023-03-16 18:40:40 -07:00
Langston Barrett acfe07ccbf Mention debug assertions label 2023-03-16 18:40:40 -07:00
Langston Barrett a65b9c7b0c Mention debug assertions 2023-03-16 18:40:40 -07:00
Langston Barrett b17ff13083 Address review comments 2023-03-16 18:40:40 -07:00
Langston Barrett 34d85e1af8 mir-opt*-level*, not mir-opt 2023-03-16 18:40:40 -07:00
Langston Barrett 435af1971e Address review comments 2023-03-16 18:40:40 -07:00
Langston Barrett 939720e1c6 Add chapter on fuzzing 2023-03-16 18:40:40 -07:00
Hoblovski 7153b94fc1 Fix "Crate disambiguator" in libs-and-metadata.md 2023-03-16 11:11:46 +02:00
Tshepang Mbambo 60402a753a alert when date gets stale (by using date-check annotation) 2023-03-14 05:50:20 +02:00
Tshepang Mbambo 8307567617 fix date-check annotation some more 2023-03-14 05:50:20 +02:00
Tshepang Mbambo 77d01ca1f5 fix date-check annotation 2023-03-14 05:50:20 +02:00
Tshepang Mbambo 87afef07e7 typo 2023-03-14 05:50:20 +02:00
Michael Howell b51fa3c654 Update rustdoc-internals.md 2023-03-14 05:50:20 +02:00
Thom Chiovoloni b1b6d693cd Rename `config.toml.example` to `config.example.toml` 2023-03-13 04:42:00 +02:00
Yutaro Ohno f9d24b3a5b fix typo `SubstRef` to `SubstsRef` 2023-03-12 11:40:45 +02:00
Tshepang Mbambo e7fdb91611 improve accuracy 2023-03-10 09:04:21 +02:00
bohan 477309b6bb tracing log along diff crates 2023-03-10 09:04:21 +02:00
clubby789 8a87736cf1 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 c1d92ca068
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 ce834a2763
improve capacity note (#1634) 2023-03-06 22:08:37 +09:00
Yuki Okushi 7e50a6ab47 Remove mention to lexer/parser refactoring
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:41:21 +02:00
Yuki Okushi d1d6ce85e6 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 4597bb4226 Update explnation about `Body.basic_blocks`
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:25:20 +02:00
apiraino 82e50a669a
Add detail to contributing guide (#1628) 2023-03-03 20:14:53 +09:00
Mika 62f03c2085
Making the sentence more clear (#1624) 2023-03-03 20:13:46 +09:00
Mika b684e3532f
Fixed typing error (#1623) 2023-03-03 20:13:18 +09:00
Ezra Shaw 2d0681e13f
update error code docs to reflect recent changes (#1625) 2023-03-03 20:12:51 +09:00
Mika b06dab8408
Fixed typing errors (#1622) 2023-02-27 07:30:52 +09:00
Tshepang Mbambo 9d769136ee
this remains true (#1620) 2023-02-21 23:12:14 +09:00
Tshepang Mbambo a7d960359a
diagnostics: small fixes/improvements (#1618) 2023-02-21 22:57:34 +09:00
Tshepang Mbambo d01441ded0
typo (#1616) 2023-02-21 22:57:16 +09:00
Tshepang Mbambo ea01bf508c
typo (#1617) 2023-02-21 22:56:16 +09:00
Tshepang Mbambo 110275f990
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 095f27d62a
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 1efd0adb82 bootstrap now creates a usable toolchain when building stage0 std 2023-02-19 13:43:56 +01:00
Tshepang Mbambo 99b6b92dde
llvm 13 is now not supported (#1612) 2023-02-18 22:20:46 +09:00
Tshepang Mbambo 84b9f4d99a
Vetting deps datecheck (#1614) 2023-02-18 22:20:08 +09:00
Tshepang Mbambo 5173d1fb28 accept review suggestion
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-02-18 14:10:03 +02:00
Tshepang Mbambo 727941feae fmt 2023-02-18 14:10:03 +02:00
Tshepang Mbambo b328f82882 add Dev Desktops note 2023-02-18 14:10:03 +02:00
Tshepang Mbambo 8715e8f6e8
fix and clarify llvm bugfix policy (#1611) 2023-02-18 20:46:21 +09:00
Tshepang Mbambo 6f536e44bc 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 64f1af18f5 lower-case "Compiler" in headings, for consistency (and looks) 2023-02-18 05:04:44 +02:00
Noah Lev 1a721616c9 Explain what the rest of the backend agnostic page is about 2023-02-18 03:54:02 +02:00
Tshepang Mbambo 1f4d6ac25e accept review suggestion
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2023-02-17 13:38:10 -08:00
Tshepang Mbambo 4e8110ceb2 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 ed87804535 rustc_codegen_ssa feels permanent enough not to need date-check 2023-02-17 13:38:10 -08:00
Tshepang Mbambo c80a26fc4d
make use of the symlink, to ease things (#1608) 2023-02-17 14:37:01 -06:00
Tshepang Mbambo fdacc773e0
remove stray text (#1604) 2023-02-16 19:33:05 -08:00