Commit Graph

2346 Commits

Author SHA1 Message Date
İ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
Michele df7970bf0d Typo 2023-02-16 07:26:00 +02:00
Michele 4a86a8dd74 Typo 2023-02-16 07:24:32 +02:00
clubby789 74afdfc2f3
Add link to vscode settings in Rust repo (#1591) 2023-02-15 15:46:19 -03:00
Tshepang Mbambo d0ee17f100
avoid code duplication by including files in docs (#1598) 2023-02-15 11:41:35 -03:00
AE1020 77aaf99897
Add sample CodeLLDB launch.json (#1482)
* Add sample CodeLLDB launch.json

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

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

* Update src/compiler-debugging.md

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

* Update src/compiler-debugging.md

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

---------

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

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

* Use separate sections for VSCode and Nvim
* Add a short section on the VSCode tasks.
2023-02-13 23:16:01 -06:00
jyn df5aee0e60
Improve git submodule help (#1587) 2023-02-09 19:08:26 +09:00
Hiroki Fujino 33ea559131
update examples for rustc 1.69.0-nightly (e1eaa2d5d 2023-02-06) (#1590)
Closes https://github.com/rust-lang/rustc-dev-guide/issues/1581
2023-02-09 18:56:06 +09:00
clubby789 ed5b175ef3
Replace settings.json with x.py setup note (#1588) 2023-02-08 14:26:58 -06:00
Ciel 0591410a01
Fixed small grammar mistake in monomorph.md (#1585)
Fixes https://github.com/rust-lang/rustc-dev-guide/issues/1584
2023-02-05 17:28:48 +09:00
Onur 2d1e71ac8b
update bootstrap guide (#1583)
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-02-04 16:53:38 -06:00
Nixon Enraght-Moony 5c65222d4c Use host symlink for custom rustup toolchain 2023-02-04 01:01:48 +02:00
Yuki Okushi d579acb697 Fix broken relative links
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
Yuki Okushi bf4cdde66b Address the change in https://github.com/rust-lang/rust/pull/99715
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
Yuki Okushi 860162abfe Address the change in https://github.com/rust-lang/rust/pull/106718
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
Yuki Okushi e0074c18f0 Address the change in https://github.com/rust-lang/rust/pull/97287
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
Yuki Okushi d30be86ea6 Address the change in https://github.com/rust-lang/rust/pull/107256
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
Yuki Okushi d8c298da43 Update explnation about benchmarks
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
nils 49c93f661f Add param_env and wording 2023-02-02 10:23:24 +02:00
nils 5db974f386 Expand section basedd on review comments 2023-02-02 10:23:24 +02:00
Nilstrieb 98cc718964 Add section on comparing types 2023-02-02 10:23:24 +02:00
Zephaniah Ong c97f571561 Update rustfmt path
As per https://github.com/rust-lang/rust/pull/107297#discussion_r1092764740, the change broke the rust-analyzer config. Hence, changing the docs to match the new path
2023-02-01 18:59:30 -06:00
Tshepang Mbambo c42c13eba2
fix wrong heading level (#1573) 2023-02-01 07:29:15 +09:00
ozkanonur ba809ffab0 fix incorrect position of topic
Right now "Clarification of build command's stdout" topic
shows up under the "Environment Variables" which is not correct.
This commit aims to fix this problem.

Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-01-31 22:57:27 +02:00
ozkanonur 472188e1b9 extend bootstrap related documentations
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-01-31 12:42:30 -06:00
nils e359ee27fc
New infcx usage (#1571)
Fixes https://github.com/rust-lang/rustc-dev-guide/issues/1543
2023-01-31 00:08:16 +09:00
Denis Belik 4a1d5496d5 Apply suggestions from code review
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-01-29 20:58:11 +02:00
Denis Belik 54cfdd74e6 Update ast-validation.md 2023-01-29 20:58:11 +02:00
lcnr c166632b37 update datecheck 2023-01-27 15:03:01 -08:00
lcnr 71766d97b0 review 2023-01-27 15:03:01 -08:00
lcnr 167d22c126 line length 2023-01-27 15:03:01 -08:00
lcnr 7eaff60278 Update src/solve/canonicalization.md
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-01-27 15:03:01 -08:00
lcnr 9656b8ca34 review 2023-01-27 15:03:01 -08:00
lcnr 15bd9e49bb Update src/solve/canonicalization.md
Co-authored-by: Boxy <supbscripter@gmail.com>
2023-01-27 15:03:01 -08:00
lcnr 61771df6d8 fix line lengths 2023-01-27 15:03:01 -08:00
lcnr 0bcdb56e3a add section for the new trait solver 2023-01-27 15:03:01 -08:00
Tshepang Mbambo f4f78f752c
version 5 is now not supported (#1568) 2023-01-27 19:09:37 +09:00
Tshepang Mbambo 21c77d78d0
there are still no locale bundles (#1567) 2023-01-27 07:52:25 +09:00
Tshepang Mbambo 0e18184ce3
bumpt date-check examples to current month (#1566) 2023-01-27 07:51:28 +09:00
Yang Pan b6cc4604d0 Update hir.md
Fix method name and the link, as it's outdated.
2023-01-25 17:29:12 +02:00
Tshepang Mbambo 5ecd75a393 fix review suggestion 2023-01-21 16:12:58 +02:00
Tshepang Mbambo 757ad6dcb9 accept review suggestion
Co-authored-by: lcnr <rust@lcnr.de>
2023-01-21 16:12:58 +02:00
Tshepang Mbambo 042c49c64e rustc_typeck exists no more 2023-01-21 16:12:58 +02:00
Albert Larsan 7d3c1c827e
Correct tests misplacement (#1564)
Since the tests move, this was not correct anymore.
2023-01-20 11:18:15 -03:00
gftea 7313897468
Update resolution.md (#1561) 2023-01-18 07:46:14 +09:00
gftea ea33f70d09
Update asm.md (#1560) 2023-01-17 21:44:19 +09:00
gftea 7352353ae9
fix examples for rustc 1.68.0-nightly (935dc0721 2022-12-19) (#1556) (#1557)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Closes https://github.com/rust-lang/rustc-dev-guide/issues/1556
2023-01-15 05:34:23 +09:00
gftea de053e2975
Update incremental-compilation-in-detail.md (#1553)
Co-authored-by: Michael Woerister <michaelwoerister@users.noreply.github.com>
2023-01-14 12:37:03 +09:00
jyn 0dc2b03ee3
Link to the youtube recording of my talk, not the summary (#1554) 2023-01-13 07:46:15 +09:00
Albert Larsan ec0d134e3b
Change `src/test` to `tests` (#1547) 2023-01-13 07:31:47 +09:00
gftea e799c10502
add full name for ICE (#1552)
Co-authored-by: Yuki Okushi <huyuumi.dev+love@gmail.com>
2023-01-11 22:25:53 +09:00
Mu00 e67f3b8913
Fix incorrect links (#1549) 2023-01-10 22:00:49 +09:00
oskgo d89d417f2d fix rebase link 2023-01-10 08:17:59 +02:00
Joshua Nelson da0a4a0d36
Add a section for how to review code more easily (#1538)
- How to hide whitespace
- Fetching PRs without having to add a new remote or copy-paste the URL of the author's fork
- How to review large blocks that have moved
- Suggest `git range-diff`. This section is still mostly incomplete; fixing an exact command that will work seems kinda tricky and I don't currently have time for it.
2023-01-02 15:35:09 -08:00
Joshua Nelson b3e2a6e6c8 fix typo
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-12-31 23:20:47 -06:00
Joshua Nelson 664346dd7e Give help for when you update a submodule by accident 2022-12-31 23:20:47 -06:00
Joshua Nelson ef12db3ecf Update sentence about LLVM to match the new defaults 2022-12-31 23:20:21 -06:00
Joshua Nelson 51fc2ec1cc Move information about dependencies to the rust-lang/rust readme
This avoids having to maintain the information in two places.
2022-12-31 23:20:21 -06:00
Joshua Nelson f111b885ea Move "create a config.toml" after the section explaning x.py 2022-12-31 23:20:21 -06:00
Joshua Nelson fd9a461220 Remove unnecessary detail in building chapter
Most of these details were not helpful or necessary for building the compiler for the first time.
This section comes very early in the guide and is meant to be a tutorial, so being concise is very important.
2022-12-31 23:20:21 -06:00
Joshua Nelson 8fa9edeccb Remove initial section on submodules
It's not necessary and it takes up valuable space at the very start of the guide.
2022-12-31 23:20:21 -06:00
Joshua Nelson e6fd600417 Replace `$TARGET` with `host`
This avoids having to manually modify the configuration in the docs.
2022-12-31 18:23:52 -06:00
Joshua Nelson 586474f348 Use `origin` consistently and add an example of rebasing over the wrong remote 2022-12-29 11:39:24 -06:00
Joshua Nelson ba1db24140 Add more rebasing help 2022-12-29 11:39:24 -06:00
Dan Mezhiborsky 54e6f5b535
Fix rustc_borrowck crate name typo (#1535) 2022-12-25 21:11:21 +09:00
mejrs 8b42eb5f57 Apply feedback 2022-12-18 00:41:27 +02:00
mejrs a213de4efe Add -Ztrack-diagnostics information 2022-12-18 00:41:27 +02:00
Ramon de C Valle 58077bf772
Add documentation for LLVM KCFI support (#1529)
This commit adds initial documentation for LLVM Kernel Control Flow
Integrity (KCFI) support to the Rust compiler (see rust-lang/rust#105109
and rust-lang/rust#89653).
2022-12-14 12:20:53 +01:00
Tshepang Mbambo 55c2c093dc typo 2022-12-14 05:34:09 +02:00
Mohammad Omidvar 4c516b0b3a Replace NoLandingPad with another alive Visitor
The broken reference to the non-existing `NoLandingPad` is replaced by `LocalUseCounter` to fix this document.
2022-12-14 05:34:09 +02:00
Mohammad Omidvar 1cf62ddb2f Remove todo note 2022-12-14 05:34:09 +02:00
Mohammad Omidvar 1211eebb71 Replace NoLandingPad with another alive MIR pass
The broken reference to `NoLandingPad` is replaced by `RemoveStorageMarkers` to fix this document.
2022-12-14 05:34:09 +02:00
Tshepang Mbambo 9f3efe646d share same link 2022-12-08 19:02:08 -08:00
Yuki Okushi b145e1e1fa fix: Fix broken links
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-12-09 03:13:38 +02:00
Oli Scherer d147c52df4 Remove TyS 2022-12-08 09:06:11 +01:00
Jared Harp d3564ba27b Fix small inaccuracy in monomorph page 2022-12-06 21:42:57 -08:00
Anirudh S e269950a57
Remove duplicate paragraph (#1523) 2022-12-04 08:09:24 +09:00
Ralf Jung a7cd86425d
clarify subtree tool policy (#1518) 2022-12-03 09:32:00 +09:00
Samuel Moelius c4e632eb14
Typo (#1520) 2022-12-03 09:02:26 +09:00
Joshua Nelson 96462f2d9f Fix broken link
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-11-28 19:00:24 -08:00
Joshua Nelson fa3ffbfcca Don't use "incremental" to refer to `--keep-stage`
`-C incremental` is sound and --keep-stage is not.
2022-11-28 19:00:24 -08:00
Joshua Nelson af134d2f6f Link directly to the section on `--keep-stage` 2022-11-28 19:00:24 -08:00
Tshepang Mbambo e85c4c460d
do an actual link to detect if it breaks in future (#1517)
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-11-27 09:49:21 +09:00
Noah Lev 2889c292cb
Triage some date-check items (#1513) 2022-11-26 22:25:58 +09:00
Ghassan Gedeon Achi 0bd5bd1d68 Update path for `try_mark_green` implementation
Updates the location of the `try_mark_green` algorithm from `compiler/rustc_middle/src/dep_graph/graph.rs` to [`compiler/rustc_middle/src/dep_graph/graph.rs`](https://github.com/rust-lang/rust/blob/stable/compiler/rustc_query_system/src/dep_graph/graph.rs#L574) .
2022-11-22 07:27:49 +02:00
Yuki Okushi 32bc13e408 Fix a broken design docs link about unused substs bug
https://github.com/rust-lang/project-const-generics/pull/21 removed the
link. This replaces it with an issue link mentioned on the design docs.

Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-11-20 08:45:56 +02:00
Tshepang Mbambo f98f1e5b86
updating-llvm: keep a calm tone (#1449)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-11-20 15:19:50 +09:00
Tshepang Mbambo 6f3d5e4b00
date-check: updating-llvm (#1424) 2022-11-20 12:55:18 +09:00
lcnr 36e15ae1dd Update src/type-inference.md
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2022-11-10 23:27:01 +02:00
lcnr 39c10de06f extract regions 2022-11-10 23:27:01 +02:00
RCoder01 7354b42b73 Consistent ordered list indexing 2022-11-09 10:39:06 +02:00
Xiretza 01a51b2282
Document multiple alternative suggestions on diagnostic structs (#1486) 2022-11-09 06:35:38 +09:00
lcnr d0dc6c97a6 trans -> codegen 2022-11-07 16:49:22 +02:00
Nilstrieb 63b45c3d94 Remove implementation details 2022-11-05 10:44:35 -05:00
Nilstrieb 090bd5422d Update some more things and improve wording 2022-11-05 10:44:35 -05:00
nils 087224159e Update query.md
- queries always need a description
- `QueryDescription` isn't just for descriptions (it's actually not for
  descriptions at all now) and always implemented by the macro
- queries are not grouped into categories
2022-11-05 10:44:35 -05:00
Tshepang Mbambo 2bdb02c587
replace tabs with spaces (#1504) 2022-11-05 12:32:16 +09:00
Tshepang Mbambo 43e41174c0 align code blocks with their paragraphs 2022-11-04 03:49:25 +02:00
jonathanCogan a6c35fc69e
Fixes some typos (#1502)
* Fix some typos.

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

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

Co-authored by: @lcnr and @spastorino

* Update src/traits/resolution.md

* Wrapping

* Update src/traits/resolution.md

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

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

* Update src/const-eval.md

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

* Update src/const-eval.md

Co-authored-by: lcnr <rust@lcnr.de>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-09-13 14:33:10 +02:00
Joshua Nelson 290ecb9082 fix typos and formatting
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-09-12 18:48:21 -05:00
Joshua Nelson a605591d8f Say "bootstrap" instead of "rustbuild"; the latter is not explained anywhere and is not much more clear. 2022-09-12 18:48:21 -05:00
Joshua Nelson 6b3a5fb9d7 Rewrite the section on passing flags to subcommands
- Move the reference for directories and actions to the very end; it's the most rare to need to know
- Add `RUSTDOCFLAGS*`, `CARGOFLAGS*`, `-vvv`, and `--test-args`
- Remove the incorrect `--on-fail` command
2022-09-12 18:48:21 -05:00
Joshua Nelson c3232c4541 Remove the diagram of all outputs generated by x.py
These are already present in the table below, there's no need to repeat it.
Having it near the middle of the page makes it feel more overwhelming.
2022-09-12 18:48:21 -05:00
Joshua Nelson f29e38c0ba "symbol names" => ABI
ABI is more general and gives a better idea of what goes wrong.
2022-09-12 18:48:21 -05:00
Devin Jeanpierre 5d8825eb0a
Add symbol-addition to the how-to for new features (#1457)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-09-12 06:19:13 +09:00
Eric Holk a5363fb536
Fix typo (#1459) 2022-09-09 10:50:44 +09:00
Xiretza 5be5475b07 Document multipart_suggestion derive on SessionSubdiagnostic 2022-09-05 10:59:20 +01:00
Samyak Sarnayak 859323857e Add reference for updating Windows PATH and fix typo
Yes, the reference is a page on Java's documentation but that's the most complete and most official looking reference I could find.
2022-09-03 06:11:07 +02:00
Eric Huss 6b0a155162
Update for removal of RLS (#1450) 2022-09-02 23:03:15 +09:00
Yuki Okushi 04892c1a6f Fix the link to `Parser` struct
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-08-29 20:07:51 +02:00
Yuki Okushi c0c957cdab Remove a dangling link on "The `#[test]` attribute"
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-08-29 20:07:51 +02:00
est31 2a9f8fbf41 Update the stabilization guide to refer to the new placeholder system
The stabilization process is changed to now use `CURRENT_RUSTC_VERSION`
instead of spelling out whatever version is currently the latest.
This placeholder will be replaced during the release process with the
correct version.
2022-08-27 21:45:28 -04:00
Tshepang Mbambo b5a632f462
Refine the lintstore section (#1429) 2022-08-27 14:59:56 +09:00
Tshepang Mbambo daca4683bb typo 2022-08-27 06:25:51 +02:00
Micah Weston 2bf1b9a32e Updates text to refer to LLVM documentation. 2022-08-27 06:25:51 +02:00
Micah Weston 20e571f6b2 Updates LLVM prereqs since upgrade to C++17. 2022-08-27 06:25:51 +02:00
Tshepang Mbambo 94a29d4b46
we got 3 (#1447) 2022-08-27 00:34:44 +09:00
SparrowLii 8ba0403073 A few corrections 2022-08-26 06:18:21 +02:00
SparrowLii d7832dbb5d Update some statements 2022-08-26 06:18:21 +02:00
SparrowLii 1be023c319 correct typo in parallel-rustc.md 2022-08-26 06:18:21 +02:00
SparrowLii a240e521fe Correct some statements in parallel-rustc.md 2022-08-26 06:18:21 +02:00
SparrowLii 9c9882c3e1 update parallel-rustc.md 2022-08-26 06:18:21 +02:00
Tshepang Mbambo 1e7fe14eea
update thir output (#1445) 2022-08-25 07:45:53 +09:00
Tshepang Mbambo 18fc34b37d
do not offer option to run code (#1442) 2022-08-23 07:46:35 +09:00
Xiretza c2371dae0c Document changes introduced by kind-less SessionDiagnostics 2022-08-21 08:49:30 -07:00
David Wood 0a613525dc
diagnostics: fix outdated use of string slugs (#1436) 2022-08-19 10:47:58 +01:00
Nathan Stocks f3fe248549
Add missing lifetime (#1439)
* fix incorrect #[note] syntax

* more syntax fixes

* add missing lifetime
2022-08-18 17:53:51 -07:00
Nathan Stocks 0a80e53608 more syntax fixes 2022-08-18 22:41:51 +00:00
Nathan Stocks 9334d59398 fix incorrect #[note] syntax 2022-08-18 22:11:03 +00:00
est31 2512667781
Update slug style to use _ instead of - (#1426) 2022-08-17 23:16:44 +01:00
Tshepang Mbambo 47c8189d5c
remove incorrect info (#1435) 2022-08-17 19:33:13 +09:00
Tshepang Mbambo 8ee1ff5a9e
fix lifetime name (#1431) 2022-08-17 19:29:27 +09:00
Tshepang Mbambo 04e1702ebc
Update the date reference around Git submodule bug (#1430) 2022-08-17 17:07:40 +09:00
Tshepang Mbambo d3daa1f28e
Improve the "Diagnostic items" chapter (#1427) 2022-08-13 10:00:38 +09:00
Tshepang Mbambo 452b5abdd6 date-check: crates-io 2022-08-11 08:13:27 +02:00
Tshepang Mbambo 24de0faa96 fix/improve compiler-debugging 2022-08-10 23:27:09 +02:00
Joshua Nelson 4c39d333c4 Update src/compiler-debugging.md 2022-08-10 09:23:51 -05:00
yukang af80d31f49 add gdb tips for symbol-mangling-version 2022-08-10 09:23:51 -05:00
Tshepang Mbambo f979af65e0
move references down to avoid clutter (#1420)
Also, make link to upstream llvm repo clickable
2022-08-09 14:52:46 -07:00
Noah Lev df1743281f Fix legend colors in dark mode 2022-08-09 16:47:22 -05:00
Noah Lev 81a4d04bcd Add color for downloaded nodes 2022-08-09 16:44:20 -05:00
Noah Lev c1c84d67f8 Add colors to diagram 2022-08-09 16:44:20 -05:00
Noah Lev 4b2f038aee Add bootstrapping diagram
This diagram is based on the diagram in Joshua Nelson's talk on
bootstrapping at RustConf 2022 [1]. I converted it to Mermaid and made
some tweaks to simplify it and bring it closer to bootstrap's
terminology, and then Ralf Jung added nodes for copying artifacts.

[1]: https://rustconf.com/schedule#bootstrapping-the-once-and-future-compiler

Co-authored-by: Joshua Nelson <github@jyn.dev>
Co-authored-by: Ralf Jung <post@ralfj.de>
2022-08-09 16:44:20 -05:00
Tshepang Mbambo 6964f75b85 date-check: rustc_codegen_ssa is still alive
Latest reference on it I could find on zulip:
https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/Cursed.3A.20no_core.20Add.20on.20primitive.20int.20returning.20Option.3C.3E/near/287514393
2022-08-08 15:15:15 +02:00
Tshepang Mbambo e305a42eb6 note is now too old to be relevant 2022-08-08 15:15:15 +02:00
Tshepang Mbambo 2557089a44
make date-check more lightweight (#1394)
* make date-check lightweight

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

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

* please clippy

* update date-check docs

* accept review suggestion

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

* address review comment

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

* accept review suggestion

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

* address review comment

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

* address review comment

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

* this breaks markdown

* address review comment

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

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

* address review comment

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

* address review comment

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

* accept review suggestion

This was reverted by mistake

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

* address review comment

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

* use a more simple fn

* address review comment

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

Much more clean

* nit

* accept review suggestion

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

* avoid a failed regex

Also, test new shape

* adjust to new regex (which uses named groups)

New regex was introduced by 456008cc35

Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-08-02 13:50:32 -07:00
Tshepang Mbambo 04f3cf0bb2 address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1402#discussion_r933905339
2022-07-31 07:46:57 +02:00
Tshepang Mbambo 3678b505cb accept review suggestion
Co-authored-by: Joshua Nelson <github@jyn.dev>
2022-07-31 07:46:57 +02:00
Tshepang Mbambo 338907471d try address review comments 2022-07-31 07:46:57 +02:00
Tshepang Mbambo d9596c6b3a summary of chapter 2022-07-31 07:46:57 +02:00
Tshepang Mbambo 6f97f451b8 Update src/building/compiler-documenting.md
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-31 07:46:57 +02:00
Tshepang Mbambo 67af5ca978 revamp doc-build chapter 2022-07-31 07:46:57 +02:00
Tshepang Mbambo ea7e58a0e6 minor fixes 2022-07-30 19:54:34 -04:00
Yuki Okushi 7955bb399f Prefer relative links
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi 637ebaa545 Fix the link to clippy docs
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi bbbd60d245 Fix the link to `ResolverAstLowering`
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi 18fa8fb103 Fix the link to `ProcMacro` trait
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi c0b491ee43 Fix the link to `Lazy<T>`
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Urgau 30a4d2b134 Add instructions to fix build errors in std after adding a new target 2022-07-29 17:13:46 -04:00
bstrie e5e5a9b861 Document how to build a cross-compiler 2022-07-26 11:07:55 -04:00
ridwanabdillahi c7637def78
Add documentation about Microsoft provided debuggers and CodeView/PDB… (#1406)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Ridwan Abdilahi <riabdila@microsoft.com>
2022-07-26 07:33:58 +09:00
Amos Wenger bcc1166bf6 rust-analyzer is now a subtree
It used to be a submodule.

cf. https://github.com/rust-lang/rust/pull/99603
2022-07-25 11:40:28 +02:00
Luqman Aden d5201cddac Debuginfo tests now also support revisions. 2022-07-21 04:48:49 +02:00
Amos Wenger bac43d0fdb Link to rendered book directly
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-19 15:58:55 +02:00
Amos Wenger 5c8febd8cb Fix link to clippy sync docs 2022-07-19 15:58:55 +02:00
Tshepang Mbambo 2b87b31676 remove stray markup 2022-07-19 09:56:55 +02:00
Tshepang Mbambo 6e1ac9dd04 renamed 2022-07-19 09:56:55 +02:00
Tshepang Mbambo 0c2f5c9b77 sync with hackmd version
See https://hackmd.io/5t8pLdJcRDmqbfN9ZXje3g
2022-07-19 09:56:55 +02:00
Tshepang Mbambo 2802da7b37
replace misleading name (#1401) 2022-07-19 15:56:24 +09:00
Yuki Okushi dca7b1b9c1 Remove a mention to Steve on r? example
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-18 07:31:14 +02:00
Tshepang Mbambo 168442374d obey line length limit (part 3) 2022-07-17 23:34:12 +02:00
Tshepang Mbambo 1b62c12bbe obey line length limit (part 2) 2022-07-17 23:34:12 +02:00
Tshepang Mbambo 5cc90f3ab1 obey line length limit 2022-07-17 23:34:12 +02:00
HackMD 857ee492fc sync with hackmd 2022-07-17 23:34:12 +02:00
Niko Matsakis 53395b0e3d add draft chapter 2022-07-17 23:34:12 +02:00
Tshepang Mbambo ade9352771 use relative links
Used the following command, followed by some manual tweaking:

  sd 'https://rustc-dev-guide.rust-lang.org/(.+).html' '$1.md' (fd)
2022-07-17 02:32:44 +02:00
Tshepang Mbambo 56eb8b69b5
fix some typos (#1398) 2022-07-17 06:45:36 +09:00
davidrusu 8bbee4f5a3 typo: monomorph docs 2022-07-16 16:44:10 +02:00
5225225 2e754ba3d7 Rename debugging_opts to unstable_opts, use link 2022-07-16 12:56:25 +02:00
Tshepang Mbambo 0eb86d9bfe address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1392#discussion_r921560851
2022-07-15 13:24:50 +02:00
Tshepang Mbambo 7a99011947 update date reference on MIR inliner
cc #1379
2022-07-15 13:24:50 +02:00
Tshepang Mbambo 47e04448c7 remove outdated info on debugging
Closes #1391

Also, do some small fixes/improvements while at it.
2022-07-15 13:24:07 +02:00
Tshepang Mbambo 4a96ed5165
small fixes to ty chapter (#1390) 2022-07-15 15:47:42 +09:00
Joshua Nelson f92263e45b Update the build instructions for the standard library
Since https://github.com/rust-lang/rust/pull/95503, `library/std` means
"build just std and its dependencies"; to get the old behavior that built
`proc_macro` and `test`, you need `x build library`.

- Update `library/std` to `library`
- Remove the `-i` suggestions; `incremental = true` is already the default for most profiles, in
  which case `-i` does nothing. If you don't have incremental enabled, I still think suggesting `-i`
  is bad idea, because it's easy to forget once, at which point you'll end up rebuilding the whole
  compiler / standard library.
- Remove a few repetitive sections and don't discuss incremental in such detail
  Incremental works well enough that it should "just work" for most people;
  I don't think it needs multiple paragraphs of explanation so early in the guide.
- Clarify that `test library/std` *only* tests libstd in a few places
2022-07-11 07:22:24 +02:00
Martin Nordholts 8accea6a9d
overview.md: Link to existing Macro Expansion and Name Resolution docs (#1388) 2022-07-08 12:55:38 -05:00
Santiago Pastorino f1d10fbf4a Revert "Add the config needed to get rust-analyzer working on src/bootstrap (#1381)"
This reverts commit d955bab63c.
2022-07-07 07:10:35 +02:00
Joshua Nelson 07efe00394
Use `x.py check` instead of `cargo check` for build scripts (#1384)
Cargo check isn't supported and gives an error that CFG_CHANNEL is missing.
It also generates a new target dir and recompiles dependencies.
Use x.py instead, which avoids both issues.
2022-07-06 18:36:22 -03:00
Joshua Nelson eb83839e90
Suggest a separate build directory for rust-analyzer (#1378) 2022-07-03 15:17:39 +09:00
Yutaro Ohno ef73d033d6
Change the old filename, "src/stage0.txt" to "src/stage0.json" (#1383) 2022-07-03 15:10:25 +09:00
Joshua Nelson d955bab63c
Add the config needed to get rust-analyzer working on src/bootstrap (#1381) 2022-07-03 15:06:54 +09:00
Daniel Xu a05e1fd401 Fix path to hir_id_validator.rs
It doesn't look like the old path ever existed.
2022-07-02 21:32:39 +02:00
Ralf Jung f423a3ad95
leave formatOnSave to the user (#1380) 2022-07-02 00:35:13 +09:00
David Wood 11b40654fd
diagnostics: structs with new slug syntax (#1377)
Update the documentation for diagnostic structs to use the new typed
identifier syntax for referring to slugs.

Signed-off-by: David Wood <david.wood@huawei.com>
2022-06-28 13:17:15 -03:00
EdwinRy 03fafb5d85 Few readability fixes 2022-06-27 02:41:09 +02:00
Alcaro 4505f706b1
humorust: Forbid pineapple on pizza (#1374) 2022-06-26 21:02:21 +09:00
Tshepang Mbambo 048d925f0a
not obvious what Ex is, so rather get rid (#1372) 2022-06-21 22:25:34 +09:00
Tshepang Mbambo a3d2f90481
small improves (#1371)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-06-21 18:45:30 +09:00
Tshepang Mbambo 12a613eddb
make clear that other versions can work (#1373) 2022-06-21 13:26:19 +09:00
Omer Tuchfeld bda3e0b23c
Fix small `src/diagnostics.md` typo (#1370) 2022-06-18 19:42:08 +09:00
Edwin cddd59fff8
Add an "is" and rearange "We next" to "Next, we" (#1369) 2022-06-18 12:31:49 +09:00
David Wood c4d5a69945 diagnostics: add translation documentation
- Add documentation on translation infrastructure and use of
  `SessionSubdiagnostic`.
- Update diagnostic examples on other pages to be translatable since
  this is preferred.

Signed-off-by: David Wood <david.wood@huawei.com>
2022-06-13 10:14:40 +02:00
David Wood 56ec010080 diagnostics: line wrapping/heading changes
Minor stylistic changes to some of the diagnostic documentation: adding
line wrapping to the Markdown source and changing the capitalization of
the headings to be consistent with other pages.

Signed-off-by: David Wood <david.wood@huawei.com>
2022-06-13 10:14:40 +02:00
Edwin Rybarczyk ee64179f12 later -> latter 2022-06-13 00:17:41 +02:00
Eric Huss 375a9f06e3
Remove mention of -Zborrowck=mir with Polonius. (#1367) 2022-06-08 19:30:43 -03:00
Eric Huss e83cd73692
Remove nll compare mode. (#1366) 2022-06-08 14:21:15 -03:00
lcnr bc81f9918c
add section on user types (#1359)
* add section on user types

* line length

* review

* Update src/borrow_check/type_check.md

Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-06-08 14:21:01 -03:00
Jonas Schievink 6e4d6435db
Make build scripts and proc macros work with the suggested rust-analyzer config (#1365) 2022-06-08 08:06:32 +09:00
Tshepang Mbambo 438364838a
improve rustc_interface examples a little (#1362) 2022-06-07 08:42:07 +09:00
Andrew Dona-Couch -- GitHub drop ICE 4d43651c90
Clarify cargo fallback behavior for rustup link (#1273) 2022-06-07 08:37:50 +09:00
Yuki Okushi a206009f26 Update rustc-driver related examples 2022-05-30 13:57:16 +02:00
Yuki Okushi 669262932a Triage some date references related to traits 2022-05-27 21:40:59 -07:00
Yuki Okushi 554c00e480 Cleanup rustdoc-internals 2022-05-24 17:15:35 -07:00
Yuki Okushi 5e268730e0 Fix some wording on the "Incremental Compilation In Detail" page 2022-05-24 16:03:20 -07:00
Eric Huss 0cd9842821
Add note about patching dependencies and warnings. (#1354) 2022-05-21 12:53:51 +09:00
Tshepang Lekhonkhobe 12a2e08f72
make sentence more simple (#1353) 2022-05-20 21:37:01 +09:00
Yuki Okushi 0b2c9db969
Update some links and docs (#1340) 2022-05-17 07:54:45 +09:00
Yuki Okushi b389adccc1
Replace a broken YouTube link (#1295) 2022-05-16 11:36:40 -03:00
pierwill 06445e66c4
Edit the "Compiler Source Code" chapter (#1307)
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
Co-authored-by: pierwill <pierwill@users.noreply.github.com>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-05-16 21:02:11 +09:00
Eric Huss b24d550239
Add docs for logging of queries. (#1350) 2022-05-12 13:56:26 +09:00
Waffle Maybe 77f7fa259f
Fix configuration names for vscode/r-a (#1352) 2022-05-12 13:56:14 +09:00
Jacob Pratt 687f6036ca
Update docs for deprecated attribute (#1338) 2022-05-12 13:53:26 +09:00
Soroush Zare 0c02acdb6f
Update overview.md (#1351)
Fix minor typo
2022-05-10 09:45:31 -03:00
Yuki Okushi 425fa202c8
Update date references on parallel-rustc (#1348) 2022-05-09 08:47:50 -05:00
lcnr e4ce969bea
mention `WithOptConstParam` (#1346) 2022-05-09 09:19:43 +09:00
Yutaro Ohno a9d0e35c84
Fix format (#1349) 2022-05-09 09:17:51 +09:00
Ali MJ Al-Nasrawy 2de8cb5dab
correct type of SubstsRef (#1347) 2022-05-07 09:58:20 +09:00
Who? Me?! acb1fcb780
Document ErrorGuaranteed (#1316)
* document ErrorGuaranteed

* Fix typos

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Clarify Niko comment

Co-authored-by: Niko Matsakis <niko@alum.mit.edu>

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2022-05-03 11:28:26 -03:00
pierwill 9ec019011f
Edit "What the compiler does to your code" (#1306)
* Edit overview.md

* Fix lexer crate

* Edit wording

Co-authored-by: pierwill <pierwill@users.noreply.github.com>
2022-05-02 17:10:45 -03:00
Yuki Okushi e827b0aaa1 Update some date refs 2022-04-20 13:09:19 -07:00
printfn 043e60f4f1
Fix a small typo (#1343) 2022-04-20 18:57:49 +09:00
Felix S Klock II a8add664d4
Extend debugging llvm section (#1290) 2022-04-14 20:17:36 +09:00
scottmcm c190ae37e1
Send people doing *library* stabilizations over to the std-dev-guide (#1317)
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2022-04-14 20:10:34 +09:00
Frank Steffahn aa31b10161
Fix typo serious->series (#1336) 2022-04-14 19:46:54 +09:00
Eric Holk e58b4c04cb
Minor type fix (#1337) 2022-04-14 19:44:36 +09:00
David Wood d9bfa3788c
sessiondiagnostic: translation (#1333) 2022-04-14 14:57:32 +09:00
Matthew Woodcraft eeb5a83c15
method-lookup.md improvements (#1296) 2022-04-11 23:29:48 +09:00
Ivor Wanders 885d329928
Consolidate crates.io convention section (#1326) 2022-04-11 22:51:22 +09:00
Noah Lev 664d3c70c0
r-a: Use `python3 x.py` instead of `./x.py` (#1335) 2022-04-09 17:31:23 +09:00
Hongbo f5f6b4f2be
Update miri.md: correct a minor typo (#1334) 2022-04-06 07:47:46 +09:00
xFrednet 127abaa937 Add example how lints can be feature gated 2022-04-04 13:16:08 -07:00
lcnr 155126b1d2
update section for type system constants (#1329)
* update section for type system constants

* Update src/constants.md
2022-03-22 14:34:21 +01:00
skippy10110 0e4b961a9c update winget install instructions to ensure proper packages are installed (-e for --exact, and full package names to ensure arbitrary packages from the msstore source aren't installed)
fixes #1324
2022-03-14 08:40:37 -07:00
Guillaume Gomez 4b8d939889 Add missing rustdoc tests explanations 2022-03-09 12:45:59 -08:00
Chayim Refael Friedman eb90c9c25a Fix incorrectly escaped backtick 2022-03-02 12:18:48 -08:00
James Cole 32f2a5b4e7
Add architecture suggestion for Apple silicon (#1320) 2022-03-01 10:45:24 -06:00
Eric Huss 7d8eb87604
cargo timings has been stabilized (#1319)
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2022-02-27 22:26:00 -06:00
Eric Huss 24e474c276
Add known-bug header. (#1311) 2022-02-24 22:40:58 -06:00
Téo Bouvard 9e2cdee5b3
Fix typo (#1315) 2022-02-24 11:27:21 -08:00
Samuel Moelius e798dc49d7
Typo (#1313) 2022-02-22 18:22:28 -06:00
Eric Huss d335c9c2bb instrument-coverage has been stabilized. 2022-02-20 13:59:23 -08:00
Eric Huss eefbde504f symbol-mangling-version has been stabilized 2022-02-20 13:59:23 -08:00
pierwill 5483b27923
Fix `Ty` link (#1308) 2022-02-20 12:14:58 -08:00
pierwill 68c7649409
Edit glossary (#1302)
Add back-ticks to a few terms that appear in code.

Clarify that `tcx` is a standard.
2022-02-17 14:09:04 -08:00
Noah Lev 1fa751d36e
Fix heading levels in the query chapter (#1305)
This should fix the incorrect TOC rendering in #1303.
2022-02-17 13:48:36 -08:00
pierwill 2c9be18076 Fix link 2022-02-17 13:30:24 -08:00
pierwill cb3fb942e3
Edit "Queries" chapter (#1301)
Makes various edits for clarity, style, readability, and formatting.

Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-02-17 15:12:43 -06:00
pierwill 5e38eb64bf
Link to The Rust Performance Book (#1300) 2022-02-17 17:46:20 -03:00
Raoul Strackx 62f58394ba
Correction, building stage3 compiler (#1298) 2022-02-11 08:42:50 -05:00
Yuki Okushi d1822b9998
Triage some date references (#1293) 2022-02-10 17:34:23 -03:00
Manish Goregaokar dc47b51114
mention test folders for cfg(bootstrap) (#1294) 2022-02-05 15:03:17 +09:00
Felix S. Klock II 8763adb62c git.md: Expanded a note to try to stress what you need to do if you're playing
games with submodules.

(I overlooked this when cherry-picking an LLVM commit today, and wasted some
time wondering why I wasn't seeing any effect in my resulting `rustc` build...)
2022-01-26 14:01:40 -08:00
Ivor Wanders 341abec62a Clarify that r? works in comments. 2022-01-20 18:01:07 -08:00
Eric Huss 78dd6a4684
Reorganize and expand the testing chapters. (#1281)
* Reorganize and expand the testing chapters.

* Update tests chapters for review comments.

* Fix typo.
2022-01-18 14:44:26 -03:00
Amanieu d'Antras 4d46bd0c95
Add inline assembly internals (#1266) 2022-01-18 11:12:06 -03:00
Georgiy Komarov 60bc9abf72
Spelling: Rename `rust` to `Rust` (#1288) 2022-01-18 11:09:37 -03:00
Noah Lev a10c5befc1
Clean up section about FCPs (#1287)
* I've never heard the term "pFCP" used before, so spell it out as
  "proposed final comment period"

* Fix some unclear things (like implying that you need `r+` rights to
  start an FCP)

* Improve the chapter's title, and make it consistent with its TOC entry

* Make some other assorted minor cleanups and improvements
2022-01-18 11:09:16 -03:00
Nicholas Nethercote 18b93ae2ee Address more review comments in #1286. 2022-01-05 23:26:43 -06:00