Commit Graph

2393 Commits

Author SHA1 Message Date
İsmail Arılık 2eb3e5e7e8 fix(git.md): remove a confusing end of sentence character
It might cause a confusion since it is not end of a sentence.
2023-07-21 16:57:54 +02:00
İsmail Arılık 3e926f097e refactor(profiling/with_perf): remove a wrong to be verb 2023-07-19 16:54:57 +02:00
İsmail Arılık feaef55f33 refactor(tests/headers): remove duplicate list item 2023-07-18 16:02:36 +02:00
İsmail Arılık 25d42e6901 refactor(test/headers.md): make the meaning more obvious 2023-07-18 16:01:21 +02:00
İsmail Arılık 60f024d3f6 refactor(tests/ui): remove unnecessary duplicate word 2023-07-18 14:04:05 +02:00
İsmail Arılık a014f290dc fix(duplicate): remove unnecessary duplicate word 2023-07-18 12:17:31 +02:00
Mahdi Dibaiee f2555ba137 generic_arguments.md: substs -> GenericArgs
See https://github.com/rust-lang/rust/pull/113591
2023-07-15 02:01:35 +02:00
İsmail Arılık 74d4d9ca74 fix(suggested): remove an unnecessary and confusing statement
This statement is not about Visual Studio Code; it is about Neovim and it is already in that section. And it is also confusing for a VS Code user. So I think it is better to remove it.
2023-07-14 20:41:09 +02:00
Tshepang Mbambo cd6372d916 make it read better 2023-07-14 08:39:30 +02:00
İsmail Arılık 6fece074be fix(how-to-build-and-run): fix a typo ("fromer" -> "former")
I think it is a typo, isn't it? 🤔
2023-07-14 08:39:30 +02:00
İsmail Arılık 14db9a3d53 fix(how-to-build-and-run): remove a wrong paragraph
This paragraph says that given README section have instructions on how to install Python and other prerequisites but it doesn't.

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

* Fix typo in typo fix

* add missing word

---------

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

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

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

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

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

* w

* review

* very good section

* whatever

* review

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

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

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

* Update src/compiler-debugging.md

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

* Update src/compiler-debugging.md

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

---------

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

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

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

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

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

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

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

Co-authored by: @lcnr and @spastorino

* Update src/traits/resolution.md

* Wrapping

* Update src/traits/resolution.md

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

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

* Update src/const-eval.md

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

* Update src/const-eval.md

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

* more syntax fixes

* add missing lifetime
2022-08-18 17:53:51 -07:00
Nathan Stocks 7536ff8e9a more syntax fixes 2022-08-18 22:41:51 +00:00
Nathan Stocks 499cc7afe2 fix incorrect #[note] syntax 2022-08-18 22:11:03 +00:00
est31 7c8bf03e3d Update slug style to use _ instead of - (#1426) 2022-08-17 23:16:44 +01:00
Tshepang Mbambo a5d21b8533 remove incorrect info (#1435) 2022-08-17 19:33:13 +09:00
Tshepang Mbambo 8156e7f9ab fix lifetime name (#1431) 2022-08-17 19:29:27 +09:00
Tshepang Mbambo 51be0fd27d Update the date reference around Git submodule bug (#1430) 2022-08-17 17:07:40 +09:00
Tshepang Mbambo 6116278158 Improve the "Diagnostic items" chapter (#1427) 2022-08-13 10:00:38 +09:00
Tshepang Mbambo b9ea2a3998 date-check: crates-io 2022-08-11 08:13:27 +02:00
Tshepang Mbambo e6f6103222 fix/improve compiler-debugging 2022-08-10 23:27:09 +02:00
Joshua Nelson 05084c67ff Update src/compiler-debugging.md 2022-08-10 09:23:51 -05:00
yukang c328379974 add gdb tips for symbol-mangling-version 2022-08-10 09:23:51 -05:00
Tshepang Mbambo 7345ceec48 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 04b006fd12 Fix legend colors in dark mode 2022-08-09 16:47:22 -05:00
Noah Lev 31e4869545 Add color for downloaded nodes 2022-08-09 16:44:20 -05:00
Noah Lev 27512fd7ff Add colors to diagram 2022-08-09 16:44:20 -05:00
Noah Lev ebad7d357a 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 7e95f0ee6a 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 5ae1208533 note is now too old to be relevant 2022-08-08 15:15:15 +02:00
Tshepang Mbambo 8194045511 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 c3aca0df58 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 57401f4f39 accept review suggestion
Co-authored-by: Joshua Nelson <github@jyn.dev>
2022-07-31 07:46:57 +02:00
Tshepang Mbambo 1046f3e6e8 try address review comments 2022-07-31 07:46:57 +02:00
Tshepang Mbambo 6469d7444e summary of chapter 2022-07-31 07:46:57 +02:00
Tshepang Mbambo 0c77aa9c9e Update src/building/compiler-documenting.md
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-31 07:46:57 +02:00
Tshepang Mbambo 13a6ec809d revamp doc-build chapter 2022-07-31 07:46:57 +02:00
Tshepang Mbambo f354a7433b minor fixes 2022-07-30 19:54:34 -04:00
Yuki Okushi 769f69ca59 Prefer relative links
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi 77d9ec9476 Fix the link to clippy docs
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi f64e68eafb Fix the link to `ResolverAstLowering`
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi 75fe5e4782 Fix the link to `ProcMacro` trait
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi f83caba6d0 Fix the link to `Lazy<T>`
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Urgau 5b3ecceecc Add instructions to fix build errors in std after adding a new target 2022-07-29 17:13:46 -04:00
bstrie 3cf8dd467e Document how to build a cross-compiler 2022-07-26 11:07:55 -04:00
ridwanabdillahi 4c4f344c9d 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 8d227efda1 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 afb2eb604d Debuginfo tests now also support revisions. 2022-07-21 04:48:49 +02:00
Amos Wenger 0e30f7c0bf Link to rendered book directly
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-19 15:58:55 +02:00
Amos Wenger 386fc96942 Fix link to clippy sync docs 2022-07-19 15:58:55 +02:00
Tshepang Mbambo 9ca52b51d7 remove stray markup 2022-07-19 09:56:55 +02:00
Tshepang Mbambo b2f0e9c3e6 renamed 2022-07-19 09:56:55 +02:00
Tshepang Mbambo 839725a35d sync with hackmd version
See https://hackmd.io/5t8pLdJcRDmqbfN9ZXje3g
2022-07-19 09:56:55 +02:00
Tshepang Mbambo f55e5dfaa5 replace misleading name (#1401) 2022-07-19 15:56:24 +09:00
Yuki Okushi b6e4058122 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 9dae3a8245 obey line length limit (part 3) 2022-07-17 23:34:12 +02:00
Tshepang Mbambo ddb3d38965 obey line length limit (part 2) 2022-07-17 23:34:12 +02:00
Tshepang Mbambo fbcc81b53a obey line length limit 2022-07-17 23:34:12 +02:00
HackMD 441ab7ef90 sync with hackmd 2022-07-17 23:34:12 +02:00
Niko Matsakis a6ed1bcb45 add draft chapter 2022-07-17 23:34:12 +02:00
Tshepang Mbambo 061577567f 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 767d2b1135 fix some typos (#1398) 2022-07-17 06:45:36 +09:00
davidrusu 9cdee34a55 typo: monomorph docs 2022-07-16 16:44:10 +02:00
5225225 1fedc2ea70 Rename debugging_opts to unstable_opts, use link 2022-07-16 12:56:25 +02:00
Tshepang Mbambo 8bb80e219a 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 f70a8345b9 update date reference on MIR inliner
cc #1379
2022-07-15 13:24:50 +02:00
Tshepang Mbambo 0390f2b6e5 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 67a564f15b small fixes to ty chapter (#1390) 2022-07-15 15:47:42 +09:00
Joshua Nelson d7ead280b4 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 71bfd5e641 overview.md: Link to existing Macro Expansion and Name Resolution docs (#1388) 2022-07-08 12:55:38 -05:00
Santiago Pastorino 570043de71 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 964a0c4390 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 96c3ff376a Suggest a separate build directory for rust-analyzer (#1378) 2022-07-03 15:17:39 +09:00
Yutaro Ohno 32d3192152 Change the old filename, "src/stage0.txt" to "src/stage0.json" (#1383) 2022-07-03 15:10:25 +09:00
Joshua Nelson 2f2967866f Add the config needed to get rust-analyzer working on src/bootstrap (#1381) 2022-07-03 15:06:54 +09:00
Daniel Xu 7033cd35a8 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 3fea5da33d leave formatOnSave to the user (#1380) 2022-07-02 00:35:13 +09:00
David Wood a2aee4c319 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 82fe7a2b9b Few readability fixes 2022-06-27 02:41:09 +02:00
Alcaro 87ac19a87a humorust: Forbid pineapple on pizza (#1374) 2022-06-26 21:02:21 +09:00
Tshepang Mbambo 1451fecad2 not obvious what Ex is, so rather get rid (#1372) 2022-06-21 22:25:34 +09:00
Tshepang Mbambo 4f9f93c22a small improves (#1371)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-06-21 18:45:30 +09:00
Tshepang Mbambo 27b12c37e5 make clear that other versions can work (#1373) 2022-06-21 13:26:19 +09:00
Omer Tuchfeld 53101e0024 Fix small `src/diagnostics.md` typo (#1370) 2022-06-18 19:42:08 +09:00
Edwin 3152bcbf2b Add an "is" and rearange "We next" to "Next, we" (#1369) 2022-06-18 12:31:49 +09:00
David Wood 17edb681ff 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 2273fee776 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 de46205199 later -> latter 2022-06-13 00:17:41 +02:00
Eric Huss b005279610 Remove mention of -Zborrowck=mir with Polonius. (#1367) 2022-06-08 19:30:43 -03:00
Eric Huss 95d5ac8462 Remove nll compare mode. (#1366) 2022-06-08 14:21:15 -03:00
lcnr 6c8505ff87 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 d292267144 Make build scripts and proc macros work with the suggested rust-analyzer config (#1365) 2022-06-08 08:06:32 +09:00
Tshepang Mbambo 6445e007fe improve rustc_interface examples a little (#1362) 2022-06-07 08:42:07 +09:00
Andrew Dona-Couch -- GitHub drop ICE 3552ec5286 Clarify cargo fallback behavior for rustup link (#1273) 2022-06-07 08:37:50 +09:00
Yuki Okushi 388142f167 Update rustc-driver related examples 2022-05-30 13:57:16 +02:00
Yuki Okushi f2a18eae27 Triage some date references related to traits 2022-05-27 21:40:59 -07:00
Yuki Okushi de938b00e2 Cleanup rustdoc-internals 2022-05-24 17:15:35 -07:00
Yuki Okushi d8eea06af3 Fix some wording on the "Incremental Compilation In Detail" page 2022-05-24 16:03:20 -07:00
Eric Huss 7d8e3fd2cd Add note about patching dependencies and warnings. (#1354) 2022-05-21 12:53:51 +09:00
Tshepang Lekhonkhobe 8b5f9d119a make sentence more simple (#1353) 2022-05-20 21:37:01 +09:00
Yuki Okushi 6ec2a84d4d Update some links and docs (#1340) 2022-05-17 07:54:45 +09:00
Yuki Okushi 0312fa6b20 Replace a broken YouTube link (#1295) 2022-05-16 11:36:40 -03:00
pierwill bb427216e5 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 cb69a95ade Add docs for logging of queries. (#1350) 2022-05-12 13:56:26 +09:00
Waffle Maybe 0c88f29374 Fix configuration names for vscode/r-a (#1352) 2022-05-12 13:56:14 +09:00
Jacob Pratt 824696ffe2 Update docs for deprecated attribute (#1338) 2022-05-12 13:53:26 +09:00
Soroush Zare 6199edef0f Update overview.md (#1351)
Fix minor typo
2022-05-10 09:45:31 -03:00
Yuki Okushi 10a9ba8019 Update date references on parallel-rustc (#1348) 2022-05-09 08:47:50 -05:00
lcnr b7b14a983a mention `WithOptConstParam` (#1346) 2022-05-09 09:19:43 +09:00
Yutaro Ohno f76f69f603 Fix format (#1349) 2022-05-09 09:17:51 +09:00
Ali MJ Al-Nasrawy d331d7ef96 correct type of SubstsRef (#1347) 2022-05-07 09:58:20 +09:00
Who? Me?! 081e290a26 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 105bc3d35d 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 a1340e010c Update some date refs 2022-04-20 13:09:19 -07:00
printfn 5fac76ad20 Fix a small typo (#1343) 2022-04-20 18:57:49 +09:00
Felix S Klock II ab3dadc854 Extend debugging llvm section (#1290) 2022-04-14 20:17:36 +09:00
scottmcm 4e3546bb57 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 c7e77e92c1 Fix typo serious->series (#1336) 2022-04-14 19:46:54 +09:00
Eric Holk 8c4e15a49a Minor type fix (#1337) 2022-04-14 19:44:36 +09:00
David Wood 8b363fba6d sessiondiagnostic: translation (#1333) 2022-04-14 14:57:32 +09:00
Matthew Woodcraft de2dd7ce06 method-lookup.md improvements (#1296) 2022-04-11 23:29:48 +09:00
Ivor Wanders cd09c7d4b7 Consolidate crates.io convention section (#1326) 2022-04-11 22:51:22 +09:00
Noah Lev a6a8701a86 r-a: Use `python3 x.py` instead of `./x.py` (#1335) 2022-04-09 17:31:23 +09:00
Hongbo 66a7e73203 Update miri.md: correct a minor typo (#1334) 2022-04-06 07:47:46 +09:00
xFrednet 64ccc62f03 Add example how lints can be feature gated 2022-04-04 13:16:08 -07:00
lcnr a1d6f341d5 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 16d33733da 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 3782d52fab Add missing rustdoc tests explanations 2022-03-09 12:45:59 -08:00
Chayim Refael Friedman 133100ead7 Fix incorrectly escaped backtick 2022-03-02 12:18:48 -08:00
James Cole 1d9f534e4e Add architecture suggestion for Apple silicon (#1320) 2022-03-01 10:45:24 -06:00
Eric Huss cc3f7c4417 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 07d132e805 Add known-bug header. (#1311) 2022-02-24 22:40:58 -06:00
Téo Bouvard 700361ae97 Fix typo (#1315) 2022-02-24 11:27:21 -08:00
Samuel Moelius 34f726b933 Typo (#1313) 2022-02-22 18:22:28 -06:00
Eric Huss 55ee2bb081 instrument-coverage has been stabilized. 2022-02-20 13:59:23 -08:00
Eric Huss d3cc250a1c symbol-mangling-version has been stabilized 2022-02-20 13:59:23 -08:00
pierwill 8484282c52 Fix `Ty` link (#1308) 2022-02-20 12:14:58 -08:00
pierwill 2098ad6059 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 6d4d4c47d7 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 8c29f8a37c Fix link 2022-02-17 13:30:24 -08:00
pierwill ef226df435 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 3bbd78f532 Link to The Rust Performance Book (#1300) 2022-02-17 17:46:20 -03:00
Raoul Strackx 9a346dc04d Correction, building stage3 compiler (#1298) 2022-02-11 08:42:50 -05:00
Yuki Okushi 3e67d8ee9a Triage some date references (#1293) 2022-02-10 17:34:23 -03:00
Manish Goregaokar 62e5c2a719 mention test folders for cfg(bootstrap) (#1294) 2022-02-05 15:03:17 +09:00
Felix S. Klock II 0f68c8e315 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 638d7fb6ab Clarify that r? works in comments. 2022-01-20 18:01:07 -08:00
Eric Huss 121b57d498 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 99beaada7c Add inline assembly internals (#1266) 2022-01-18 11:12:06 -03:00
Georgiy Komarov e3da6331dd Spelling: Rename `rust` to `Rust` (#1288) 2022-01-18 11:09:37 -03:00
Noah Lev ce956908d0 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 08019e25d1 Address more review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote 940fbb5f7a Address review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote e3512c8cd8 Streamline "Getting Started" some more.
This is a follow-up to #1279.

The "Getting Started" chapter is, TBH, pretty bad when it comes to the
stuff about building and testing. It has far too much detail and lots of
repetition, which would be overwhelming to a newcomer.

This commit removes most of it, leaving behind just quick mentions of
the most common `x.py` commands: `check`, `build`, `test`, `fmt`, with
links to the appropriate chapters for details. There were a few
interesting details that weren't covered elsewhere, so I moved those
into other chapters.
2022-01-05 23:26:43 -06:00
Noah Lev ce4ae4004c Update link to moved section (#1282)
The section was removed in #1030 and re-added in a different place in
2d42cf7.
2021-12-28 22:17:49 -06:00
Ben Reeves 440503e38d Fix link in contributing.md (#1280) 2021-12-27 10:28:15 -06:00
Nicholas Nethercote 2c2ebc2fae Streamline "Getting Started" (#1279)
* Move `x.py` intro section before first use, and shorten it.

* Improve `x.py setup` docs.

In "Getting Started", strip it back to the bare minimum. Some of this is
moved into the later section.

In the later section, add notable details like config.toml.example how
and `profile` works. Also make the config.toml example more concise.

* Move details about the repository.

Less detail in "Getting Started", more in the later sections.

* Move details about the prereqs.

Less detail in "Getting Started", more in the later sections.
2021-12-24 12:52:31 -03:00
Wang Qilin 1349a379b8 remove rustfix item in test intro (#1277) 2021-12-20 21:53:57 +09:00
Noah Lev 924c1fa136 Move date-check comment to fix Markdown syntax
The inline code wasn't being rendered correctly.
2021-12-15 11:59:46 -08:00
Maxwell Elliot Heiber 46d0c2c3a8 Update humor docs for special-casing ferris emoji
update for: https://github.com/rust-lang/rust/pull/91476/files
2021-12-15 09:49:37 -06:00
Badel2 f639a94b4d Fix some broken links (#1274) 2021-12-13 15:16:30 +09:00
Jacob Hoffman-Andrews ddccb87b0d Update rustdoc internals
Use current paths when discussing source files.
Update cheat sheet section with download-rustc.
Add "use cases" section.
2021-12-09 16:05:48 -06:00
Noah Lev 51146cd309 Update HIR chapter to use `HirId` instead of `NodeId`
`NodeId`s are no longer used in the HIR. See #50928 for more information.
2021-12-09 09:11:48 -06:00
Noah Lev 7c8d7c57a4 Fix some broken links 2021-12-09 09:11:48 -06:00
Lucas Kent 99ced2e883 Update src/getting-started.md
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-12-09 09:09:36 -06:00
Lucas Kent 08bc5de96a Improve documentation on r? 2021-12-09 09:09:36 -06:00
Rich Kadel 2531a18d3b Update LLVM coverage mapping format version supported by rustc (#1267)
rust-lang/rust#91207 updates the coverage mapping format to Version 5 or
6, depending on the built-in version of LLVM (12 or 13, respectively).

This change updates the dev guide to match the recent changes.
2021-12-03 09:26:47 -08:00
Lucas Kent 9074afb8da Improve 'Running tests manually' section 2021-11-27 03:45:39 -05:00
Yuki Okushi a7abb26bfe Fix some links 2021-11-24 10:23:07 -05:00
Eric Huss 499f9b9fc9 Update for review comments. 2021-11-24 10:22:37 -05:00
Eric Huss 4aff2ba309 Document rustfix-only-machine-applicable 2021-11-24 10:22:37 -05:00
Eric Huss 9bde256126 Apply suggestions from pierwill
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-11-24 10:22:37 -05:00
Eric Huss c042df7cae Document more compiletest headers. 2021-11-24 10:22:37 -05:00
Dylan MacKenzie 6643adf704 Describe drop elaboration (#1240) 2021-11-18 13:31:13 -05:00
Ken Matsui d4f300263e Fix an invalid link on Diagnostic Items (#1261) 2021-11-16 10:45:40 -03:00
Yuki Okushi 8047e19802 Fix broken links related to `rustc_borrowck` (#1259)
* Fix broken links in region_inference.md

* Fix broken links in lifetime_parameters.md
2021-11-16 10:43:17 -03:00
Ken Matsui e1babf580d Unify `x.py` usage (#1258) 2021-11-16 07:44:50 +09:00
Lucas Kent 363f6ce09c Spelling fixes 2021-11-15 08:23:01 -06:00
Lucas Kent 7b93c858f0 Fix compare-mode documentation 2021-11-14 17:01:35 -06:00
Noah Lev e0ddc301da Fix broken link in "Bootstrapping"
The italics added in #1239 broke the implicitly-resolved link.
2021-11-09 21:46:27 -06:00
chubei 7335f28334 Fix typo: [upv.rs_mentioned] -> [upvars_mentioned] 2021-11-07 07:48:47 -06:00
asquared31415 42e31a049e Add note to emphasize replacing TARGET_TRIPLE (#1250) 2021-11-06 18:32:55 +09:00
Eric Huss b4570015e5 Remove some legacy test suites. 2021-11-04 14:18:39 -05:00
Dmitry Savintsev 07dcb9e148 tiny capitalization fix 2021-11-04 14:15:06 -05:00
Noah Lev 98fe056d6c Fix date
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-11-04 09:33:03 -07:00
Noah Lev b1f655d972 Update some date-check comments
I removed one of them because it doesn't seem necessary.
2021-11-04 09:33:03 -07:00
Caleb Cartwright b26499d1ff enhance subtree docs, link to clippy docs 2021-11-02 20:09:23 -05:00
pierwill b547c04d8e Edit introduction to bootstrapping
Use paragraphs instead of bullet-points.
Edits throughout for clarity.
Use semantic line breaks in edited sections.

Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-11-02 15:06:56 -05:00
xFrednet c0c8c133c7 Some minor adjustments to the diagnostic documentation 2021-10-29 21:51:05 -05:00
pierwill f85c21465f Edit "About this guide" for semantic line feeds
This is work toward #1241.
2021-10-28 15:30:08 -05:00
Janggun Lee d03c7b8626 Fix `rustc_mir` related links (#1228)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: nhamovitz <18648574+nhamovitz@users.noreply.github.com>
2021-10-29 00:58:26 +09:00
Ramon de C Valle 0d3af84fc0 Add documentation for LLVM CFI support
This commit adds initial documentation for LLVM Control Flow Integrity
(CFI) support to the Rust compiler (see rust-lang/rust#89652 and
rust-lang/rust#89653).
2021-10-27 08:55:16 -05:00
Rémy Rakic 2cd36a4f65 Describe how to trigger perf runs (#1237) 2021-10-22 01:00:27 +09:00
Joshua Nelson 4dcc29161b Remove docs on Assemble step (#1233) 2021-10-18 02:17:19 +09:00
Yusuke Abe 48e6d474cc Update some docs from 2021-10 date triage (#1230) 2021-10-12 08:52:21 +09:00
Noah Lev 632f2b7484 Recommend `rustfmt --edition=2021` 2021-10-10 08:28:12 -05:00
Tomasz Miąsko 62955f53ac Update sanitizer documentation 2021-10-08 15:49:53 -05:00
Tomasz Miąsko 84e40d7cbb Mention needs-sanitizer-hwaddress directive 2021-10-08 15:49:53 -05:00
Oli Scherer af8c2d2c7d Address review comments 2021-10-08 15:41:06 -05:00
Oli Scherer 3657acea97 Document tracing awesomeness 2021-10-08 15:41:06 -05:00
Oli Scherer 1620515e37 Move log/tracing instructions to its own file 2021-10-08 15:41:06 -05:00
Eric Holk e0cfc8c17a Update src/closure.md
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-10-07 17:48:12 -05:00
Eric Holk ebbb329734 Fix accidental HTML tag
The markdown parser was interpreting the `<something>` in `adjust_upvar_borrow_kind_for_<something>` as an HTML tag that was hidden in the rendered text. This minor edit fixes that.
2021-10-07 17:48:12 -05:00
Janggun Lee 3e63f3615c Update links to `rustc_mir` in Two Phase Borrows (#1226)
https://github.com/rust-lang/rust/pull/80522 split the `rustc_mir` crates into 5 crates, effectively invalidating all the direct links to `rustc_mir` in the docs.

I found this while looking at the Two Phase Borrows doc, which is why I am giving out this PR to fix this.
2021-10-06 09:07:51 -03:00
Noah Lev 81201b80eb Update some docs from 2021-10 date triage (#1224) 2021-10-05 17:24:24 -03:00