Commit Graph

2393 Commits

Author SHA1 Message Date
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
Dave Farnham 5926c7e6f4 Fix a typo on closure.md (#1218) 2021-09-24 12:00:29 +09:00
lcnr 7a476c07e1 const generics update 2021-09-20 12:35:16 -05:00
Tomasz Miąsko ee746de3af s/--blessed/--bless/ 2021-09-19 10:36:26 -05:00
Frank Steffahn 99e53983ad Make indentation consistent in example vscode config file 2021-09-17 16:52:56 -05:00
Frank Steffahn ee4b32b958 Suggests `--edition=2018` argument when using stage0/bin/rustfmt directly 2021-09-17 14:53:44 -05:00
lcnr 212a89205b `ty::Unevaluated`: dealing with unused substs (#1190)
* unused ct substs

* q

* q

* Update src/constants.md

Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2021-09-17 15:50:26 -04:00
Sl1mb0 d82208c6f4 Parallel codegen (#1206)
* Described underlying data structures in parallel code generation and crates they are used in
* Added links
* replace crate information with description of types
2021-09-16 20:58:07 -05:00
Eric Huss 428670ca01 Clarify difference of a help vs note diagnostic. 2021-09-12 11:50:44 -05:00
Andrey Cherkashin 6b747c6cf2 remove ctag section 2021-09-08 15:13:44 -05:00
Andrey Cherkashin ce27f4801d Update suggested.md 2021-09-08 15:13:44 -05:00
Andrey Cherkashin af8961775a Update SUMMARY.md 2021-09-08 15:13:44 -05:00
Andrey Cherkashin 4105934b90 Move ctag section to "Suggested Workflow" 2021-09-08 15:13:44 -05:00
Andrey Cherkashin 7c4410ed50 Delete ctags.md 2021-09-08 15:13:44 -05:00
Noah Lev ef35a84098 Clarify paragraph in "Keeping things up to date" 2021-09-08 12:36:10 -05:00
Timothy Maloney f1b5e50437 Docs: added section on rustdoc 2021-09-07 11:08:38 -05:00
Timothy Maloney 3d4f0d91e3 Docs: made suggested fix 2021-09-07 11:08:38 -05:00
Timothy Maloney 0f657e23aa Docs: deleted copy 2021-09-07 11:08:38 -05:00
Timothy Maloney 720084903e Docs: added section discussing core ideas 2021-09-07 11:08:38 -05:00
Timothy Maloney a22f7be4e7 Docs: delete redundant use of correctness 2021-09-07 11:08:38 -05:00
Timothy Maloney 4ebe82a278 Docs: consolidated parallelism information 2021-09-07 11:08:38 -05:00
Dezhi Wu 8887cd3d50 Add links to overview.md (#1202) 2021-09-06 18:34:16 -03:00
sjud 1ffee15da9 Spelling change intermidiate to intermediate
Very importent change.
2021-09-05 12:11:19 -05:00
Dezhi Wu 03420385e1 Fix a typo (#1200) 2021-09-05 09:40:35 -03:00
Fridtjof Stoldt 46fa9e7283 Documenting diagnostic items with their usage and naming conventions (#1192)
* Documenting diagnostic items with their usage and naming conventions

* Fixed typos in diagnostic items documentation

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

Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-09-01 11:26:58 -07:00
Noah Lev dd1feeb7a2 Add link to `Span` 2021-08-31 12:38:30 -05:00
Joshua Nelson 8b64a80ccc Add rustc-source to suggested rust-analyzer config (#1189)
This allows loading the sources for crates loaded from the sysroot.
2021-08-31 10:13:18 -07:00
Noah Lev 5c36f8e2ad Fix typo, clarify backtick wording, and use inline code 2021-08-31 12:08:01 -05:00
Frank Steffahn d789b1c701 Trailing date comments in a line inside of a paragraph caused beginning of a new paragraph. (#1196)
This PR fixes the 2 occurrences of that.
(I'm not sure if there's an underlying issue with mdbook or if this is working as intended.)
2021-08-28 08:26:16 -03:00
Frank Steffahn c98c707872 Fix a code block containing ```rust
This wasn't displayed correctly.
Changing `` ```rust `` to `` ```rust`` made it a code block again,
but the leading space was rendered as-well.
(This may be an issue in mdbook, but I'm not sure.)

This commit changes it to use HTML-syntax in order to get the desired result.
2021-08-27 15:13:38 -05:00
Frank Steffahn 5bfa8c9a9c Fix typo “a Rc” → “an Rc” (#1191) 2021-08-22 11:47:02 -03:00
Smittyvb cfffdd92ea Expand THIR section with more details (#1183)
* Expand THIR section with more details
* Remove incorrect reference to `HirId`s

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-08-21 19:55:56 -04:00
Smitty b5814b34da Remove docs for old -Z profile-queries flag 2021-08-16 08:20:03 -05:00
Rahul Butani 6893645e60 Remove a dead link in `new-target.md` + other nits (#1186) 2021-08-10 20:41:44 +09:00
Bryan Cantrill cb2c542217 Add description of -opt-bisect-limit LLVM option (#1182) 2021-08-07 10:12:22 +02:00
Yoh Deadfall 98d9084c4f Fixed team responsible for stabilization (#1181) 2021-08-05 13:41:16 +02:00
the8472 a6e37389d8 Add S-Inactive PRs as another source of things contributors could work on (#1177) 2021-07-29 06:05:19 +02:00
Dave f0900b2e0f git.md: Fix No-Merge Policy link 2021-07-28 09:45:23 -04:00
Ben Reeves a7f22be835 Fix typo in building/bootstrapping.md (#1175) 2021-07-26 00:37:28 +02:00
Noah Lev f03ae32895 Link directly to stabilization report comments (#1173)
Previously, readers had to scroll through tons of comments to find the
report.
2021-07-20 17:39:41 -07:00
bjorn3 a9dd88ec4c Update for merge of CrateDisambiguator into StableCrateId 2021-07-13 12:45:58 -04:00
Eric Holk 03faa9b900 Minor capitalization fix (#1170) 2021-07-08 01:27:47 +02:00
Yoh Deadfall 0ead7b154f Fixed typos in inline code 2021-07-05 11:21:03 -04:00
Joshua Nelson 9304642bde Document lang items (#1119)
* Document lang items

* Apply suggestions from code review

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

* Add an example of retrieving lang items

* Add two missing words

* Fix line lengths

Co-authored-by: Mikail Bagishov <bagishov.mikail@yandex.ru>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-07-05 08:34:33 +02:00
Ryan Levick b756d157e8 More specifics on what future-incompatible lints are used for 2021-07-04 23:21:24 -04:00
Ryan Levick 7cfaceec67 Fix line lens 2021-07-04 23:21:24 -04:00
Ryan Levick e0f39fce3a Update information on lints particularly on future-incompatible 2021-07-04 23:21:24 -04:00
Ryan Levick 7a6cf5ce55 Update section of lint store 2021-07-04 23:21:24 -04:00
Ryan Levick 1d25c44b9a Update around half of the January 2021 date references (#1155) 2021-07-02 10:43:34 +02:00
Ryan Levick 6f1c331e94 Create issues for many TODOs (#1163)
* Create issues for many TODOs

* Update src/crates-io.md

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

* Update src/backend/inline-asm.md

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

Co-authored-by: Joshua Nelson <github@jyn.dev>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-07-02 10:43:12 +02:00
Josh Triplett 76c1d45ae5 Links from rustc-dev-guide to std-dev-guide (#1152) 2021-07-01 13:19:06 +02:00
Smittyvb 6641226ba8 Document how to mark features as incomplete (#1151)
* Document how to mark features as incomplete

This was changed in https://github.com/rust-lang/rust/pull/86446 so that
incompleteness is included in the delcaration.

* Footerify link
2021-06-29 18:41:13 +02:00
Jesús Hernández c62c96ee6f Remove requests or suggestions about rebase and fixup contradictory to rust-highfive bot comment (#1111) 2021-06-25 01:50:50 +09:00
Smittyvb 3db8af26f9 Generate glossary table correctly (#1146)
Co-authored-by: Yuki Okushi <yuki.okushi@huawei.com>
2021-06-24 13:57:37 +09:00
二手掉包工程师 5a5098a2a5 Correct the wrong serial number (#1147) 2021-06-23 15:14:09 +09:00
Yuki Okushi a4bbc6547f Update "Inference variables" section (#1145) 2021-06-21 21:50:12 +02:00
Yuki Okushi 1373d5beed Document how to run unit tests (#1141) 2021-06-17 17:25:28 -03:00
Oli Scherer ae62be50bd We stopped using allow_internal_unstable a while ago (#1142)
Co-authored-by: Ralf Jung <post@ralfj.de>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2021-06-15 17:04:54 +09:00
Jade 3559fa7fef Change the feature used as an example of stabilizing lib features (#1143) 2021-06-15 05:57:10 +09:00
Santiago Pastorino 29aeb0b2ae We use HIR to do type inference, trait solving and type checking (#1139)
* We use HIR to do type inference, trait solving and type checking

* Update src/overview.md

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

* Update src/overview.md

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

* Update src/overview.md

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

* Fix type checking brief explanation

Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2021-06-14 20:35:38 +02:00
Jade 18493f62b0 Add suggested settings note for coc (#1144) 2021-06-13 01:17:06 +09:00
Gus Wynn 5e61e50c17 move 7/8 to prose 2021-06-09 14:43:20 -04:00
Gus Wynn 7bfcf8763b Add a section on keeping things up to date in the git section 2021-06-09 14:43:20 -04:00
Yuki Okushi 5154ef98ec Fix some links (#1137)
* Fix some links

* Address review comment
2021-06-04 09:08:56 +02:00
Ralf Jung f4e82623b2 explain Miri engine vs Miri-the-tool 2021-05-30 02:18:51 +02:00
Michael Woerister faaaaf955c Add more information about no_hash query modifier. (#1133) 2021-05-28 17:23:27 +02:00
Ralf Jung 3d9d15d1f5 improve section introduction 2021-05-26 06:24:44 -04:00
Ralf Jung 1353f7fe08 not all tools require waiting for a nightly release before they can be fixed 2021-05-26 06:24:44 -04:00
Eric Huss fe4887b0e2 Describe the difference of rustc_lint vs rustc_lint_defs. 2021-05-25 21:37:21 -04:00
Caleb Cartwright 2d3cc2a192 update rustfmt references to reflect change from submod to subtree (#1129)
* update rustfmt references to reflect change to subtree

* clarify broken toolstate hypothetical scenario
2021-05-20 15:02:20 +02:00
Justus K da1c7b423c Remove `--stage 1` argument from `doc` invocations (#1125) 2021-05-18 19:10:39 +02:00
Rich Kadel 412d1a75ab Update coverage docs (#1122) 2021-05-13 19:19:43 -07:00
Smittyvb 1e1ffdba44 Document -Zunpretty=thir-tree (#1128)
* document -Zunpretty=thir-tree

* Update position/wording
2021-05-13 20:51:43 +02:00
二手掉包工程师 3f01b29957 Unified CPU Requirements (#1126) 2021-05-10 13:38:24 +09:00
Ralf Jung c1e84b6c94 add 'waiting-for-review' incantation to main contrib page (#1124) 2021-05-05 13:53:42 +02:00
Camelid 9ba3b4b62c Suggest using `git range-diff` (#1092)
I have found it to be very helpful when rebasing.
2021-04-27 12:35:37 -07:00
Joshua Nelson 90e1d1fa43 Add sample nix shell
This also suggests using `x.py setup` instead of copying config.toml.
2021-04-27 08:52:22 -04:00
Ralf Jung 6bace78929 more RA config suggestions (#1114) 2021-04-26 18:34:50 -04:00
Nixon Enraght-Moony 8c522aa732 Add Polymorphisation paper (#1093) 2021-04-24 10:53:30 +09:00
Smitty e0055323fd Mention unpretty=mir-cfg for debugging MIR 2021-04-23 16:25:11 -04:00
Camelid 0822830537 Improve formatting and update info in "method lookup" section 2021-04-09 18:12:21 -04:00
Waffle Lapkin ee9bb8e48d Change wording a bit: `module` => `crate`
It seems more correct
2021-04-09 10:34:26 -04:00
Waffle Lapkin 727f212e9a fix typo (#1107) 2021-04-09 12:30:04 +02:00
Waffle Lapkin 88a4aa5308 fix typo 2021-04-08 17:29:13 -04:00
AngelicosPhosphoros fd8f1fee4e Mention CI build of LLVM in build instruction 2021-04-03 22:28:35 -04:00
二手掉包工程师 98c50aacd2 Fix rustdocs test command typo (#1103) 2021-04-04 01:41:35 +09:00
Yuki Okushi 3b9c325e72 Update the "LLVM updates" section 2021-04-02 05:57:57 -04:00
Yuki Okushi 3a25c80892 Fix a link about Rustdoc internals 2021-04-02 05:25:14 -04:00
Camelid 892e9091cb Add quickstart for adding a new optimization (#1094) 2021-04-01 19:24:44 +02:00
Joshua Nelson fd97123fbc Add back example of {{cwd}} (#1099)
I force-pushed this in the last commit and accidentally deleted the
github suggestion.
2021-04-01 04:04:46 +09:00
Joshua Nelson ec260c8f5c Document test input normalization 2021-03-31 14:51:19 -04:00
JohnTitor ae4208314d Add notes about nightly rustc version for the rustc-driver examples 2021-03-28 13:33:56 -04:00
Santiago Pastorino 081624ceaa Fix rust compiler meeting info (#1087)
* Remove dead link
* Make general text a bit better
* Fix Zulip link
* Improve description of what the compiler meeting is about
2021-03-19 19:11:43 -04:00
Santiago Pastorino 1b0372be77 Remove extra the (#1088) 2021-03-11 13:36:25 -08:00
Camelid d6bd146507 Fix double-word typos (#1084)
Inspired by #1079. I used this command to find these typos:

    rg --multiline --pcre2 '\b([a-zA-Z]+) \1\b' src -tmd

There were a couple false positives of the form "that that" meaning
"that it" or "that this".
2021-03-12 03:29:19 +09:00
Santiago Pastorino b8fb35151f I-nominated are nominated for discussion (#1080)
* I-nominated are nominated for discussion

* Generalize meeting expression

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

Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-11 19:05:02 +01:00
Santiago Pastorino 126ea58714 Complete unfinished statement 2021-03-11 13:01:44 -05:00
Léo Lanteri Thauvin 6753e20cbe Update lins 2021-03-10 12:00:27 -05:00
Léo Lanteri Thauvin 9692e9e9a1 Apply suggestions from code review
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-10 12:00:27 -05:00
LeSeulArtichaut d29b1c39cb Add stub about the THIR 2021-03-10 12:00:27 -05:00
Santiago Pastorino 4163ac0d6a Adjust a bit better P- label text 2021-03-10 11:35:23 -05:00
Santiago Pastorino b70deb1f65 Fix typos (#1079) 2021-03-10 23:56:51 +09:00
Wesley Wiser 0c6cccc215 Update cmake version in prerequisites.md (#1077)
LLVM requires at least cmake 3.13.4.

https://www.llvm.org/docs/CMake.html
2021-03-09 20:00:12 +01:00
Chayim Refael Friedman 2f006eabe1 Fix typo: suceed -> succeed 2021-03-09 12:37:10 -05:00
Wesley Wiser 4ddb696206 Add article on using WPA to profile rustc memory usage on Windows (#1074)
Document how to use WPA to profile rustc and what the normal workflow
should be for investigating bootstrap memory usage issues.

Co-authored-by: Ryan Levick <ryan.levick@gmail.com>
2021-03-09 04:42:56 +09:00
Tomasz Miąsko 0319b90a25 Use more accurate estimate of generated LLVM IR with llvm-lines
The `--emit=llvm-ir` emits an optimized LLVM IR. For optimized builds it will be
highly inaccurate estimate of the amount IR generated initially.  While the
inaccuracy can be somewhat reduce after disabling the optimization, that in turn
has other unintended consequences, since opt-level controls the emission of
lifetime markers, sharing of generics between crates, instantiation of inline
functions, etc.

Use `-Csave-temps` and `no-opt` bitcode as a basis for more accurate estimate of
initial work handed of to the LLVM.
2021-03-07 10:57:13 -05:00
Camelid a959fee323 Cleanup rustdoc chapters a bit
* Rename "The walking tour of rustdoc" to "Rustdoc overview",
  which I think is a more accurate name
* Use same name in sidebar TOC as in chapter text
* Make links between the two chapters prominent
* Convert a few `.html` links to `.md`

Probably we should just merge the chapters, but leaving that for later.
2021-02-28 16:35:20 -05:00
Yuki Okushi 295234161c Fix broken links 2021-02-28 11:01:07 -05:00
Camelid 47722b22e9 Document how to enable CI LLVM without using `x.py setup` 2021-02-26 15:38:01 -05:00
Camelid 15c1f01c2f Remove some unrelated changes 2021-02-26 15:38:01 -05:00
Camelid 44f4197fa5 Fix typos 2021-02-26 15:38:01 -05:00
Camelid d6f81b211f Restore instructions for using system LLVM
They were removed in #1030, but are still useful.
2021-02-26 15:38:01 -05:00
Camelid 4895d26d5e Update some out-of-date information 2021-02-26 15:38:01 -05:00
Daniel Santos 7fde8950cf Fixes typo in getting started guide 2021-02-24 21:20:36 -05:00
Camelid 9539f6c271 Fix formatting of more date references (#1067) 2021-02-22 18:22:23 +09:00
Hirochika Matsumoto b4b1fb0058 Fix broken links in query.md (#1068) 2021-02-21 09:51:34 +01:00
Camelid 7f5a39d318 Update docs from date triage for 2021-02 (#1048)
The biggest change was updating the list of rustdoc passes. Several new
ones have been added since that documentation was written, so I added
those, and I also sorted the list so it is roughly alphabetical (except
for the part for the `strip-*` passes, which I left in the same order
since one of the list items has two passes so there's no "correct"
order).
2021-02-20 19:27:24 -08:00
Camelid f7049a868c Fix date-check comment formatting (#1066)
I realized that the format I had been previously using for date-checks

    (as of January 2021 <!-- date: 2021-01 -->)

left a space before the closing parenthesis in the rendered output,
which looks weird.

I could fix this by removing the space between `2021` and `<!-- ...`,
but that looks weird in the source. So I ended up deciding on changing
it to

    (as of <!-- date: 2021-01 --> January 2021)
2021-02-20 19:24:01 -08:00
r00ster 4f0142ce11 Make "URL" show up (#1065)
* Make "URL" show up

* Use `<URL>`

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-02-20 13:58:22 +01:00
Yuki Okushi 50e53ccffa Point to main branch on llvm-project's links 2021-02-19 20:25:36 -05:00
dmezh c6cf4c04da Fix typo (#1063) 2021-02-18 19:37:43 +01:00
bstrie 87b317f966 Update running.md 2021-02-17 17:13:07 -05:00
pierwill 1ab6279cea Add Oxide paper to bibliography 2021-02-15 10:14:03 -05:00
Camelid 4f16f7cc1d Fix typo 2021-02-07 22:12:28 -05:00
Yusuke Tanaka b0ff83f007 Fix typo in Bug Fix Procedure (#1050) 2021-02-07 11:15:54 -05:00
Eric Huss 768f07b196 Add chapter on libs and metadata. (#1044) 2021-02-04 11:34:52 -05:00
Camelid 6e02970f7f Add lots of date-check annotations
Also added dates for things that previously said "as of now" or "as of
this writing" and cleaned up a couple of things along the way.
2021-02-03 19:29:07 -05:00
Joshua Nelson 2e19c8ecc0 Document how to stabilize a library feature (#1036)
* Move 'force-unstable-if-unmarked' to the bootstrapping chapter

* Document how to stabilize a library feature

Note that features can't be stabilized until they go through FCP and
that FCP happens on the tracking issue, not the PR.

* Fix wrong glob

By default `**` behaves the same as two `*` side by side, i.e. it only
globs file paths, not directories. `shopt -s globstar` needs to be set
for it to mean a directory. I didn't notice this before now because
`globstar` is set by default in interactive mode, but not otherwise.
2021-02-01 19:31:00 +01:00
Eric Huss f6e4a5f851 Update test suite descriptions. (#1042) 2021-01-30 20:12:01 +09:00
Henry Boisdequin 21745b2014 put `x.py` in ticks 2021-01-30 10:59:57 +02:00
LeSeulArtichaut 470d5afe98 Update links to `librustc_llvm` and `rustllvm` 2021-01-24 08:18:34 -05:00
Joshua Nelson 584ccc7608 Add link to promotion.md (#1033)
* Add link to promotion.md

* Improve link text

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

Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-01-22 11:49:52 +01:00
Camelid 7547e6af9a Add missing period 2021-01-21 14:26:25 -05:00
Joshua Nelson 53a45a9a19 Remove "Skipping LLVM build" section
`download-ci-llvm` is available and enabled by default for all tier 1
platforms, so there is no need to change it. Using system LLVM over CI
llvm is still supported, but is not recommended. Building LLVM from
source is still supported.

This also notes that you need to explicitly disable downloading LLVM
when updating the submodule.
2021-01-20 13:45:05 -05:00
Iñaki Garay 7a80b01e01 Add mdbook-toc, markers, and documentation (#1028)
* Add mdbook-toc to travis, book.toml  and documentation

* Add toc markers

* Whitespace cleanup and some punctuation

* Addressed comments
2021-01-20 14:33:11 -03:00
Joshua Nelson d8d5bbcfe3 Link to `feature_err` in stability section (#1022) 2021-01-19 11:47:45 -08:00
Martin Geisler b2d6a16e58 Fix typo (#1027) 2021-01-17 11:50:04 -03:00
Joshua Nelson 403521f1b9 Note that `--check` now allows using any stage 2021-01-17 05:51:00 +02:00
ashosive 4bb7ee493f improved the readablity of a line 2021-01-16 12:04:07 -05:00
saki-osive f7e62ecccb Fixed a grammatical error in hardawre requirements section 2021-01-16 10:03:23 -05:00
saki-osive eeb696d8a4 Corrected MIR file path and fixed a typo (#1020) 2021-01-14 14:10:08 -08:00
Yuki Okushi 261ec50fa9 Add a note about UI test entry limitation (#1019) 2021-01-12 07:55:13 +09:00
Iñaki Garay cd437dc04f Add context to dated information (#1013)
* Fixes #924 Add context to dated information

* Fixes #924 Addressed comments and some uses of 'currently'

* Update src/contributing.md

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

* Update src/salsa.md

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

* Fixes #924 Addressed comments

* Fixes #924 Fixed line lengths.

Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-10 19:23:22 -03:00
Camelid 296a37bf7b Update 'Workspace structure' section (#1017)
* Update description of `src/`
* Note that `library/` also contains the Rust runtime
2021-01-10 16:19:39 -05:00
Camelid afaa42043c Point to `HirId` instead of `NodeId` 2021-01-09 21:05:10 -05:00
Camelid c16ce78347 Fix typo (#1016)
"currenty"!
2021-01-09 17:18:57 -08:00
Ryan Levick 1db26c008c Break up long line 2021-01-05 16:13:58 -05:00
Ryan Levick d01012ada8 Remove backticks and comment about possible bug 2021-01-05 16:13:58 -05:00
Ryan Levick 8a8bb49afa Update src/compiler-debugging.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-05 16:13:58 -05:00
Ryan Levick 27174ca131 Make instructions for configuring compiler for debug more explicit 2021-01-05 16:13:58 -05:00
Camelid 8bb02718e9 Remove old sentence that should have been removed
It was mistakenly not removed in #997.
2021-01-04 22:43:03 -05:00
Yuki Okushi 37a1ca9416 Fix "Potential incomplete link" error on compiler-debugging.md 2021-01-04 20:12:37 -05:00
Ryan Levick 5ca0f2dc26 Add link to rust-analyzer docs on getting started page 2021-01-04 10:09:49 -05:00
Sebastian Widua 1b4d37b32b Fix some typos 2021-01-04 10:02:33 -05:00
Camelid a0cdbb5675 Tweak wording around provider purity 2021-01-03 22:31:09 -05:00
Laurențiu Nicola d225a12cab Fix typo (reflex -> reflect) 2021-01-02 09:25:03 -05:00
Joshua Nelson c74f970ae3 Clarify that `check` uses a different stage than `build` (#999) 2021-01-01 20:59:23 +00:00
Yuki Okushi 8a8749228b Fix broken link for `BoundRegion` (#998) 2020-12-31 01:13:49 +01:00
Camelid 4142cf8b8d Update logging section and explain `RUSTC_LOG_COLOR` (#997)
* Update logging section and explain `RUSTC_LOG_COLOR`

* Small fixes

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Mention that prefixes of paths work as log filters

* `=debug` matches `debug!` *and higher*

* Note that `MIRI_LOG_COLOR` only applies to logs from Miri

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-31 01:08:00 +01:00
Joshua Nelson 659281e739 Fix broken link in the contributing guide (#996) 2020-12-29 21:08:55 +01:00
Iñaki Garay 7268945c0f rustc invocation standarized (#992)
* rustc invocation standarized

* Addressed comments

* Addressed comments

* Addressed comments

* Updated command output
2020-12-28 23:34:51 +01:00
Wesley Wiser e0425a9563 Update glossary.md (#994)
* Update glossary.md

- Added additional information to some of the definitions.

- Made term capitalization consistent so that only terms which refer to acronyms or concrete types are capitalized. Please let me know if that isn't desirable for some reason.

* Update src/appendix/glossary.md

Co-authored-by: Joshua Nelson <jyn514@gmail.com>

* Update src/appendix/glossary.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Update src/appendix/glossary.md

Co-authored-by: Joshua Nelson <jyn514@gmail.com>
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-28 20:05:06 +01:00
Iñaki Garay 2f9696bdeb [Fixes #778] Added and reorganized lecture links (#993)
* Added and reorganized lecture links

* Addressed comments

* Addressed comments
2020-12-27 20:50:53 +01:00
Yuki Okushi cb0b7b64ee Document `error-pattern` header (#989)
* Document `error-pattern` header

* Address some reviews
2020-12-12 16:06:30 +01:00
Yuki Okushi 4e871ea1db Fix some link failures and typos 2020-12-11 16:00:15 -05:00
Nixon Enraght-Moony a801509b43 All links to rustdoc-internals.md 2020-12-10 14:51:04 -05:00
Camelid 0265b964a7 Add a section on identifiers in the MIR (#951)
* Add a section on identifiers in the MIR

* Better wording

* Use loose lists; fix typo; fix link

* Update info

* Note how you can retrieve the associated data

Suggested by @LeSeulArtichaut.

* Update src/identifiers.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Add TODO for `Promoted` re `GlobalId`

Co-authored-by: Oli Scherer <github35764891676564198441@oli-obk.de>
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-07 20:56:25 +01:00
Rich Kadel a7c82e3ba9 Adds a dev guide section on Rust Coverage 2020-12-07 14:22:45 -05:00
Siddharth 2adddd99f2 Edit the Mir page to fix infelicities. (#984)
* Edit the Mir page to fix infelicities.

- Remove dead reference to Mir. reflow sentence to talk about
  `Body::local_decls`
- Fix broken links to render properly.
- Add links for `Terminator`, `RETURN_PLACE`, `ProjectionElem`.

* Update src/mir/index.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Edit the Mir page to fix infelicities.

- Remove dead reference to Mir. reflow sentence to talk about
  `Body::local_decls`
- Fix broken links to render properly.
- Add links for `Terminator`, `RETURN_PLACE`, `ProjectionElem`.

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-06 15:36:52 +01:00
Siddharth a4871f5013 Add links to the rust documentation for all MIR structs (#982)
* Add links to the rust documentation for all MIR structs

* Update src/mir/index.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Update src/mir/index.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-06 14:40:45 +01:00
Joshua Nelson 903f6277f4 Link to the Rustdoc book in the rustdoc chapter (#981)
This makes a) makes it easier to find info about rustdoc's features and
b) redirects people in the wrong place to where they should be looking.
2020-12-04 18:23:46 +01:00
mark b3fc04e298 fix a couple links 2020-12-03 00:06:19 -05:00
jumbatm e98d87a670 Use shorter [][]-style link to not pass 100 chars. 2020-12-02 22:34:16 -06:00
jumbatm dc31ca1ca8 Apply suggestions from review.
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-12-02 22:34:16 -06:00
jumbatm 0e7f5c08b1 Document SessionDiagnostic 2020-12-02 22:34:16 -06:00
Camelid d89703684b Use shorter 'rustbot label' command
'rustbot modify labels: ...' -> 'rustbot label ...'
2020-12-01 13:56:48 -05:00
Joshua Nelson f6f9e0957c Move the bootstrapping section later in the guide (#975)
Now that `x.py build` works in most cases, I don't think we need to
teach people all the intricacies of bootstrap right away. This moves it
to the 'overview of the compiler' section instead.
2020-11-30 20:08:17 -03:00
Ben Striegel 5661848ab9 Address feedback 2020-11-30 18:06:43 -05:00
Ben Striegel 680e35a172 Add notes about running the UI test suite 2020-11-30 18:06:43 -05:00
Joshua Nelson 43fa1342f0 Document what 'sysroot' means 2020-11-29 20:02:55 -05:00
Joshua Nelson 844ca6f14d Don't imply that the name of the fork always needs to be changed 2020-11-29 10:42:20 -05:00
Joshua Nelson 1f25130a83 Add information about common git issues 2020-11-29 10:42:20 -05:00
Hirochika Matsumoto 98fdbf9406 Fix a typo 2020-11-28 14:09:03 -05:00
Camelid 5dce3301d4 Link to feature-stabilization docs 2020-11-26 20:43:36 -05:00
Camelid ff24e31a36 Move instructions for adding a feature gate to "Feature Gates" 2020-11-26 20:43:36 -05:00
Camelid ea6df8f903 Document how to modify feature gates
How to remove them and how to rename them.

cc <https://github.com/rust-lang/rust/pull/79336#discussion_r528627318>
cc @varkor
2020-11-26 20:43:36 -05:00
Camelid c63305c6e8 Document when errors should have an associated error code (#967)
Document when errors should have an associated error code
2020-11-24 17:09:59 -08:00
Gabriel de Perthuis ced315b860 Update bootstrap documentation with the new envvars for RUSTFLAGS
This follows <https://github.com/rust-lang/rust/pull/63722>.
2020-11-24 09:06:33 -05:00
Camelid 2fa114e07d Update `param_env` link
`rustc_ty` was recently [renamed] to `rustc_ty_utils`, so this link has
to be updated.

[renamed]: f59d03038c
2020-11-23 18:40:46 -05:00
cjkenn 49069a0233 add small explanation of why fuel can be useful for debugging 2020-11-22 08:43:00 -05:00
cjkenn ed89d6f643 add mir-opt section for optimization fuel 2020-11-22 08:43:00 -05:00
hosseind88 b2a34704a6 add string interning wikipedia link (#960) 2020-11-15 12:14:06 -05:00
Camelid 661ba74612 Provide a brief example of a data-flow analysis 2020-11-12 11:53:00 -05:00
Camelid 3e4c0c70f2 Explain the purpose of the bottom value 2020-11-12 11:53:00 -05:00
Camelid 6a4c0ee05f Add a section on data-flow convergence 2020-11-12 11:53:00 -05:00
Alexis Bourget 4b00bfb892 Links to htmldocck/@has/matches for searchability 2020-11-11 19:02:37 -05:00
Olivier FAURE 7497da24ca Update src/compiler-debugging.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-11 10:39:15 -05:00
Olivier FAURE 4da49360a6 Update link in compiler-debugging.md
Link didn't point to latest version of `env_logger` crate.

Add an explanation to disambiguate the RUSTC_LOG syntax.
2020-11-11 10:39:15 -05:00
Casey Rodarmor d7bb0ad45d Update src/building/how-to-build-and-run.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-09 09:07:41 +02:00
Casey Rodarmor 79d3ceb2fa Fix install command 2020-11-09 09:07:41 +02:00
Casey Rodarmor ac0b94deff Document `src/tools/x`, an `x.py` wrapper
Document the newly added `x` binary that wraps `x.py`, which can be
installed system-wide, and can be run from any subdirectory of a rust
repo checkout.
2020-11-09 09:07:41 +02:00
Joshua Nitschke 3f33422aab correct minor grammar mistake (#944)
correct `a lots to `a lot` on implementing_new_features.md
2020-11-08 19:15:22 +01:00
Yuki Okushi 3de0132a0d Use `provide_both` link instead of `provide(_extern)` 2020-11-06 19:18:15 -06:00
Camelid 17c77b296e Use new-style mdBook internal links in glossary 2020-10-28 18:33:30 -04:00
Camelid 5b6f343c87 Put `TyCtxt` at the right position
It should now be at its alphabetical position.

Also fixed link to `TyCtxt` anchor.
2020-10-28 18:33:30 -04:00
Camelid bbcf9282ac Fix broken tags in glossary 2020-10-28 18:33:30 -04:00
Santiago Pastorino c2606a6d54 Small improvements (#936)
* Fix typo errros -> errors

* an -> a

* hir -> hir()
2020-10-27 19:34:28 +01:00
Camelid bec1897ef7 Add "ctxt" and `TyCtxt` to the glossary (#937) 2020-10-27 19:30:20 +01:00
Camelid e58307a28e Clean up `compiletest` chapter (#935) 2020-10-26 11:58:00 +09:00
Yuki Okushi e55ee68ed0 Improve prerequisites section for Windows (#934)
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-26 08:15:21 +09:00
Nadrieril f0cd34e615 Explain lint renaming/removing 2020-10-22 20:41:09 -04:00
Yuki Okushi 61feec113f Add reference PRs for `r?` and `r+` comments (#928) 2020-10-21 23:53:32 +02:00
Yuki Okushi a6279510e2 Replace links to `buildbot2.r-l.o` with `bors.r-l.o` 2020-10-21 17:34:07 -04:00
Joshua Nelson ee849ff66e Revert "Remove outdated build rustdoc --stage 1"
This reverts commit cd35d2b594.
2020-10-19 23:17:17 -04:00
Ivan Tham e4a7be5779 Remove outdated build rustdoc --stage 1
It builds with stage 1 by default.
2020-10-19 22:23:59 -04:00
Santiago Pastorino 269158b77e Fix typo errros -> errors 2020-10-19 14:11:19 -04:00
Nadrieril d859c9924e Explain why exhaustiveness is necessary for soundness 2020-10-16 18:26:10 -04:00
Nadrieril 5ddfd9bfe9 Explain pattern exhaustiveness checking 2020-10-16 18:26:10 -04:00
Yuki Okushi 2b1e754e83 Fix a link on git.md 2020-10-15 23:11:33 -04:00
1c3t3a 5f06872226 Added description of word Scrutinee to the glossary (#921) 2020-10-13 01:57:18 +09:00
LeSeulArtichaut 66649d9c81 Apply suggestions from code review
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-10 12:12:44 -04:00
LeSeulArtichaut eee78ac90f Talk about git submodules 2020-10-10 12:12:44 -04:00
Joshua Nelson d056730692 Recommend debug-logging instead of debug
This makes the compiler faster to running without sacrificing too much
performance. It still shows logging so contributors aren't confused by
`debug!` doing nothing.
2020-10-08 16:15:06 -05:00
Justus K 1ae9303960 Update more occurrences of system llvm link 2020-10-08 11:47:32 -04:00
Stu ac6fb7efa1 Fix broken "system LLVM" link 2020-10-08 11:47:32 -04:00
mautamu db41bec0c9 Fix typos (#916)
Fixed two typos.
2020-10-08 16:19:56 +09:00
Cass 9ccc69f152 Add section describing git hook functionality
This is a companion to [this PR](https://github.com/rust-lang/rust/pull/76356), which deals with including functionality for automatically running `tidy --bless` on each commit.

Undo editor auto-formatting and clarify git hook renaming

a word

Phrasing

Apply suggestions from code review

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-07 22:30:24 -04:00
Joshua Nelson 5fabea540a Document `Assemble` 2020-10-04 11:59:58 -04:00
Joshua Nelson fcc93a7043 Explain stages in terms of the compiler currently running (take N+1) (#857)
* Explain stages in terms of the compiler currently running

- Address some confusing points
  + stage N+1 -> stage N artifacts
  + Use more likely examples of an ABI break
  + stage N -> stage N compiler

- Mention why rustc occasionally uses `cfg(bootstrap)`
- Note that stage1 is built using two different versions

- Add lots of examples
  + `test src/test/ui` and `test compiler/rustc` run different compilers 😢
  + Separate examples of what to do from examples of what not to do

- 'ship stage 1 artifacts' -> 'ship stage 2 compiler'

  This is hopefully less confusing.

* build -> x.py build

* Add section on build artifacts

* Improve wording

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>

* uplifted -> assembled

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 16:25:02 +02:00
Who? Me?! 3b4462f582 Link to .md files, rather than .html
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 10:14:22 -04:00
mark 42173ef770 address lingering reviewer comments 2020-10-04 10:14:22 -04:00
Gus Wynn 08d244e06c Apply suggestions from code review
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-04 10:14:22 -04:00
Gus Wynn 58255429d8 add note 2020-10-04 10:14:22 -04:00
Gus Wynn c3a67e32dc add suggested workflow to setup nightly rustup for rustc 2020-10-04 10:14:22 -04:00
Julian Wollersberger 9a46f17fab Did more measurements on what exactly affects llvm-lines:
optimize, codegen-units and mir-opt do, but debug-assertions doesn't.
2020-10-04 10:12:47 -04:00
Julian Wollersberger 476dd40f63 Document the usage of cargo-llvm-lines and -Ztimings. 2020-10-04 10:12:47 -04:00
Aleksey Kladov d1651dbd5e Document new way to not build LLVM
Implemented in https://github.com/rust-lang/rust/pull/76349
2020-10-03 20:39:32 -04:00
Santiago Pastorino 773b3c3e95 hir_map -> hir() 2020-10-03 19:38:38 -05:00
LeSeulArtichaut efb9029fc8 Fix time periods for Triage WG procedure 2020-10-03 19:25:05 -05:00
Tshepang Lekhonkhobe c63a20ccbf Update src/getting-started.md
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
Tshepang Lekhonkhobe d3f37158ac Update src/getting-started.md
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
LeSeulArtichaut ff894213a7 Add a paragraph about reviewers and review latency in Getting Started chapter 2020-10-03 19:25:05 -05:00
Camelid b431d8211c Use HTTPS whenever possible in bibliography links (#909)
Also updated a few links that redirected.
2020-10-03 22:56:29 +02:00
Yuki Okushi b61231e905 Fix the report link 2020-10-03 16:12:04 -04:00
Camelid d9a98418f7 Fix instructions for squashing
`git merge-base master` does not work, you need
`git merge-base master HEAD` instead.
2020-10-02 15:08:28 -04:00
Roman 62ae93b3a3 add the last missing code highlight to t-compiler in the docs 2020-10-02 12:37:27 +02:00
Joshua Nelson 1c59aa9409 Fix typo 2020-09-30 22:39:25 +02:00
Jakob Degen 7f590fa025 Incorporated suggestions into git page and edit for more brevity.
The Advanced Rebasing section has been mostly rewritten to include
both a major suggestion from jyn and a general rewrite. Additional
thanks to camelid for some suggestions!
2020-09-30 10:13:42 -04:00
Jakob Degen fb23f10071 Edit using git page for brevity and clarity.
The previous iteration of the page was often wordy and
occasionally unclear. This has been cleaned up in places.

Additionally, the TODO in the no-merge policy section has been
removed and addressed.
2020-09-30 10:13:42 -04:00
Jakob Degen 7fdae85e96 Add a section on using git.
This section addresses the biggest issues that new contributors,
especially those with limited familiarity with git, are likely to
face. This is still a WIP.

Thanks to jyn for the recommended improvements!
2020-09-30 10:13:42 -04:00
Santiago Pastorino 915fabf4cc --verbose is useful when not compiling and when compiling (#901) 2020-09-29 17:18:00 +02:00
follower 506f2e77c1 Use implicit reference links for shorter lines
(As suggested by jyn514.)
2020-09-27 10:37:22 -04:00
follower e2a1deb657 Fix line length error.
Reduced line length to <100 (as indicated by PR build error).

(Also removed extra space character before link.)
2020-09-27 10:37:22 -04:00
follower 1e77d7f743 Add links to documentation sources.
Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them.
2020-09-27 10:37:22 -04:00
Joshua Nelson edc31ef0bc Add docs for x.py setup 2020-09-27 04:24:18 +02:00
follower 3ac6fc75ef Add link from "Writing Documentation" suggestion
A link to the relevant section of the contributing documentation makes it easier for contributors to locate the relevant information. (e.g. via an in-page search for "doc".)

This is particularly important currently as 85072e3303/CONTRIBUTING.md links directly to the (currently `rustc`-focused) "Getting Started" guide rather than the general Rust contribution content to which it used to point.
2020-09-26 11:52:14 -04:00
Shahar Or (mightyiam) 2ad2cb7c97 correct output path in Writing Documentation 2020-09-26 08:45:48 -04:00
Youngsuk_Kim 18c7583466 update link to 'BorrowKind' to be implicit in markdown 2020-09-25 22:55:49 -04:00
Youngsuk_Kim 49611100bf add link to 'BorrowKind' in closure.md 2020-09-25 22:55:49 -04:00
Youngsuk_Kim 06fdc4321e update description of 'ByRef' borrows of closures 2020-09-25 22:55:49 -04:00
Youngsuk_Kim a0958b664c minor punctuation/grammar error fix 2020-09-25 22:55:49 -04:00
Jakob Degen b7970e6c5e Remove reference to copyright notices.
Immediately below the section on copyright notices being removed,
it is mentioned that a particular thing should be placed below the
notices. This seems confusing.
2020-09-24 11:45:35 -04:00
Dániel Buga 727a536ba9 Link to the -Zmir-opt-level proposal
I was confused about what the different levels mean. This PR adds a paragraph that shortly explains the rationale behind different mir-opt-levels and links to the current proposal where there's some information about them.

Let me know if I wrote something unreasonable or incorrect.

Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-23 18:42:23 -04:00
Joshua Nelson 7609eb11ee Don't recommend building the compiler for running tests on the standard library (#887)
Thought of this while reading https://internals.rust-lang.org/t/contributing-changes-to-std/12829/.
2020-09-23 15:46:43 +00:00
Camelid ca00e2eefe `ConstEvalResult` is now `EvalToConstValueResult` (#885)
Also fixed typo.
2020-09-22 22:52:05 +02:00
Joshua Nelson 9c5e356ed5 Improve instructions for adding a new test (#881)
* Improve instructions for adding a new test

- Add a section for library tests
- Expand section on rustdoc tests

* Address review comments

- Say what should be considered a library test
- Mention adding error numbers to doc tests
- Link to #ui section
- Line wrapping

* Fix incorrect link

It shouldn't have been a link in the first place.

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-09-19 23:40:17 +00:00
Camelid 27ff56d829 Fix typo in table of contents 2020-09-17 11:35:14 -04:00
Camelid 0a80107e34 Revert "Mention that places are sometimes called "lvalues""
This reverts commit bf5e1c451d.
2020-09-17 11:35:14 -04:00
Camelid e645304ce9 Mention that places are sometimes called "lvalues" 2020-09-17 11:35:14 -04:00
Camelid fd525a93d6 More improvements 2020-09-17 11:35:14 -04:00
Camelid 231e3d9c83 Improve MIR sections in appendix
Add a new graphical representation of one of the examples of MIR and
basic blocks!

And make other minor improvements.
2020-09-17 11:35:14 -04:00
Macdonald Umoren 7bda848e3c debug-logging=true instead of debug-assertions=yes 2020-09-16 21:56:05 -04:00
Dylan MacKenzie 42be58a751 Add link for `AnalysisDomain::NAME` 2020-09-16 00:21:55 -04:00
Dylan MacKenzie ca60ec06df Describe how to generate graphviz diagrams for dataflow 2020-09-16 00:21:55 -04:00
Santiago Pastorino 9f4e7038fa Remove EN1 2020-09-15 18:13:33 -04:00
Santiago Pastorino a7d0f3f2dd Complete text about salsa base inputs 2020-09-15 18:13:33 -04:00
Santiago Pastorino 6cf849f63b Add Salsa In More Depth lecture 2020-09-15 18:13:33 -04:00
LeSeulArtichaut 0d2b8eb1c4 Fix typo
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-09-14 17:42:19 -05:00
LeSeulArtichaut e6a94b2355 Make the HIR chapter point to the new chapter on IDs 2020-09-14 17:42:19 -05:00
LeSeulArtichaut c7ec4769ab Apply suggestions from code review
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-14 17:42:19 -05:00
LeSeulArtichaut fe19fc65f2 Add a chapter on all the identifiers used through `rustc` 2020-09-14 17:42:19 -05:00
Dylan MacKenzie 1fffd48313 Update `Visitor` and `Cursor` examples 2020-09-13 15:58:02 -04:00
Dylan MacKenzie ddc23efa5f Line edits 2020-09-13 15:58:02 -04:00
Dylan MacKenzie 0cc3a9f8f3 Add missing link to `Engine` 2020-09-13 15:58:02 -04:00
Dylan MacKenzie 3db7809e77 Initial draft of MIR dataflow framework docs 2020-09-13 15:58:02 -04:00
Monadic Cat 3b5a774a61 correct attribute used here 2020-09-12 18:41:06 -04:00
Joshua Nelson 7e42258f16 Address nits 2020-09-12 13:12:14 -05:00
Joshua Nelson 01c34848a3 Note that the default is 2015 2020-09-12 13:12:14 -05:00
Joshua Nelson 71853f5a5c Document edition flag for UI tests 2020-09-12 13:12:14 -05:00
LeSeulArtichaut eb39e07c58 Fix typo 2020-09-12 12:07:04 -04:00
LeSeulArtichaut 5ff253c02a Hide `@rustdoc` implementation details 2020-09-12 12:07:04 -04:00
LeSeulArtichaut ab47942c65 Apply suggestions from code review
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe ade9b19f51 Update src/rustbot.md 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 9f396a3f1e Update src/rustbot.md 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 317a5b33a4 Update src/contributing.md
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 28ca77209b Update src/contributing.md 2020-09-12 12:07:04 -04:00
LeSeulArtichaut a9264c50d6 Add a chapter on useful `@rustbot` commands 2020-09-12 12:07:04 -04:00
Gus Wynn 2ac4ba41ef Improve link and description of entry points in parser section (#876)
This seemed to be out of date!
2020-09-12 08:49:05 +09:00
LeSeulArtichaut 4a8945792e Fix typo
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-11 13:42:39 +02:00
LeSeulArtichaut 57794fe4dc Apply suggestions from code review
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-11 13:42:39 +02:00
LeSeulArtichaut d26f268757 Clean up 'Contributing to Rust - Pull Requests' 2020-09-11 13:42:39 +02:00
Joshua Nelson 81f52ce0db Fix other library commands 2020-09-10 23:56:41 -04:00
Joshua Nelson 86e02cda81 Fix incorrect docs about stages
`build library/core` builds the compiler, not just the standard library.
2020-09-10 23:56:41 -04:00
Camelid f0d769ea49 Add back information about Googling
Also cleaned up some other things.
2020-09-09 22:58:18 -04:00
Camelid 53a9cde26c Add back comma
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 22:58:18 -04:00
Camelid 38d726f367 Add more info about Rustdoc 2020-09-09 22:58:18 -04:00
Camelid dd3b2059b6 Update "Helpful Links" section 2020-09-09 22:58:18 -04:00
Joshua Nelson 185f43c746 Use imprecise times, because the time to build depends on your computer
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-09 20:58:30 -04:00
Camelid 350ee4b260 Minor cleanup for "How to build and run" 2020-09-09 20:58:30 -04:00
Rich Kadel ca3b0a5571 broken intra-page link from spanview to graphviz
Just noticed the link was not correct. Fixed here.
2020-09-09 19:01:14 -04:00
Joshua Nelson f3b5db1057 Fix nit 2020-09-09 21:39:55 +02:00
Tshepang Lekhonkhobe dc0cff54bb Update src/building/new-target.md 2020-09-09 21:39:55 +02:00
Joshua Nelson 059ad38ddf Document how to promote a target from cross-compiled to hosted 2020-09-09 21:39:55 +02:00
Santiago Pastorino 3d0543b644 Update src/queries/profiling.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 12:30:56 -04:00
Santiago Pastorino 2d1322d62e Update def_id.rs location 2020-09-09 12:30:56 -04:00
Santiago Pastorino 8638351e9d Fix typo, hellow -> hello 2020-09-09 12:30:56 -04:00
Santiago Pastorino 6d3eb2bc75 Add ./ to run x.py 2020-09-09 12:30:56 -04:00
Joshua Nelson 6dd6d868e5 Update prerequisites, with an eye towards windows (#863)
* Update prerequisites, with an eye towards windows

* Address review comments

- Say version of MSVC needed
- Link to more details windows section
- Fix grammar
2020-09-09 16:24:01 +00:00
Joshua Nelson 808774289f Fix broken hyperlink (#862)
* Fix broken hyperlink

* Link to previous pages instead of skipping ahead

* Fix line lengths
2020-09-09 16:22:56 +00:00
Joshua Nelson 8623da3dab Add information about default stages for x.py 2020-09-09 11:05:26 -04:00
Joshua Nelson 794b32feac Fix typo 2020-09-09 16:58:05 +02:00
Joshua Nelson 45f6000c37 Document speculative crate loading (#859) 2020-09-09 10:19:01 +03:00
Joshua Nelson 60f15f096e Update error codes to match the current implementation
- All codes are in one crate, `rustc_error_codes`
- Extended descriptions are loaded using `include_str!`
- Give an example of a PR adding an error code
2020-09-08 13:59:34 +02:00
Joshua Nelson 1b40f033d2 Consolidate information about bootstrapping into one place (#851)
Previously, 'How to build and run' had a long section on the different
stages of boostrap. But new contributors aren't interested in bootstrap;
they want to start their build (because they heard it takes forever and
want to start it so they aren't waiting more than necessary).

This moves the section on stages into the bootstrapping page, and links
there instead of discussing it on the main page.
2020-09-07 15:25:11 +00:00
Aman Arora cc121cd4c5 Document CGU partioning in case of generic and inline functions 2020-09-07 10:07:40 -04:00
Tshepang Lekhonkhobe 68407cbe37 Update src/building/how-to-build-and-run.md 2020-09-07 08:55:08 -04:00
Joshua Nelson 5fac3dca3d Link to 'prerequisites' immediately
Several of the commands on 'how to build' use python.
But we haven't yet told the user how to install it!
Do that first before going into detail on how x.py works.
2020-09-07 08:55:08 -04:00
Ivan Tham 33efb2a2ab Rename src/rustc to compiler/rustc 2020-09-06 16:21:08 +02:00
Gus Wynn 4ce4873606 update docs to refer to the move 2020-09-03 19:25:02 -04:00
Santiago Pastorino 1519df6945 Fix dep-graph-caller-callee test location 2020-09-03 16:21:30 +02:00
Rich Kadel 7b4ab23cc7 Adds documentation to cover spanview output
Documents the feature introduced in #76074.
2020-09-02 12:39:47 +02:00
Joshua Nelson 4411cf2001 Use fewer stages in bootstrapping docs
After https://github.com/rust-lang/rust/pull/73964, they're redundant.
2020-08-31 05:19:36 +02:00
Joshua Nelson f6b1f9d49d Fix misguided suggestions in config.toml
- `verbose-tests` is for debugging the test harness, not the tests
themselves. See also https://github.com/rust-lang/rust/pull/76141
- `codegen-units` defaults to `256` whenever `incremental = true`. So
there's no need to explicitly set it to `0` if we already recommend
incremental. See also https://github.com/rust-lang/rustc-dev-guide/pull/795#discussion_r479762977.
2020-08-31 05:18:50 +02:00
Who? Me?! b3e17b1b1f Typo
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-31 05:12:13 +02:00
mark 54ffd393c9 fix typos 2020-08-31 05:12:13 +02:00
mark b361ef92ac fix line lengths 2020-08-31 05:12:13 +02:00
mark 89f0b60ccc fix links and names after compiler mv to compiler/ 2020-08-31 05:12:13 +02:00
Tshepang Lekhonkhobe cd2f461d9c nits 2020-08-26 08:07:52 -04:00
Camelid 51da18c90d Apply review suggestion
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-26 13:13:14 +02:00
Camelid 014d434f46 Clarify section on MIR construction 2020-08-26 13:13:14 +02:00
Guillaume Gomez a49fce9a12 Add new section to have a local HTTP server easily (#833) 2020-08-23 14:36:45 +02:00
Gurwinder Singh 9b803e1dfe fix type in example (#832)
Because the below explanation says that function type is `fn(u32) -> u32`
2020-08-21 18:54:59 +09:00
Yuki Okushi 908d4ff483 Remove duplicate MIR chapter entry (#830) 2020-08-19 11:46:02 +00:00
Aleksey Kladov 776e14a3f0 Document how to use build task for x.py check (#828) 2020-08-17 23:10:29 +09:00
Lzu Tao 8effbe65b6 Link ref to edge concept in graph theory 2020-08-17 09:00:47 -04:00
Who? Me?! 369ec46a1b Remove unneeded hashmarks (#826)
Co-authored-by: Joshua Nelson <jyn514@gmail.com>
2020-08-17 04:51:37 +09:00
Matthew Jasper 0ecf777a50 Address revuew comments 2020-08-16 14:14:35 -05:00
Matthew Jasper 281526c5a2 Document serialization in rustc 2020-08-16 14:14:35 -05:00
Takayuki Nakata 463489182d Some small fixes (#823)
* Fix some typos
* Update from `typeck_tables_of` to `typeck`
* Fix comment
2020-08-11 19:36:48 -04:00
Takayuki Nakata 5462868f4b Use angle brackets to turn URL into a link 2020-08-04 09:50:19 -04:00
Takayuki Nakata 68daabb4bf Fix typo 2020-08-04 09:50:19 -04:00
Takayuki Nakata 1fd664124d Fix a broken link 2020-08-04 09:50:19 -04:00
Takayuki Nakata f24f0b15e0 Enable a link 2020-08-04 09:50:19 -04:00
Takayuki Nakata 574f709928 Some small fixes 2020-08-03 11:07:57 -05:00
Takayuki Nakata cb87579a2f Fix typo 2020-08-03 11:07:57 -05:00
Takayuki Nakata e7b3cd7f6a Fix: crates -> a list of crates 2020-08-03 11:07:57 -05:00
Takayuki Nakata ff9814cc3c Avoid "whitelist"
Fixed according to 62cf767a4a
2020-08-03 11:07:57 -05:00
Yuki Okushi 9522f3e934 Prefer `::` than `.` 2020-08-02 23:16:01 -05:00
Yuki Okushi 65770bcd1f Fix link/wording for `parse_nt` 2020-08-02 23:16:01 -05:00
Who? Me?! 14c2f80da2 Typo
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
mark a8eab86aa0 some updates after std libs move 2020-08-02 19:44:04 -05:00
Who? Me?! c693f66a8e Typo
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
mark 8e76708b6c mention the overview chapter 2020-08-02 19:44:04 -05:00
Who? Me?! 12bf5b4747 Link to overview ch instead of internals
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
mark e10dbb8586 missing link 2020-08-02 19:44:04 -05:00
mark a9024bd3b2 add a bit more discussion of big picture 2020-08-02 19:44:04 -05:00
mark a1ef8389eb fix typo 2020-08-02 19:44:04 -05:00
mark 63a0c1f3da line length 2020-08-02 19:44:04 -05:00
mark 3852cb1592 rewrite/update compiler source code chapter 2020-08-02 19:44:04 -05:00
Yuki Okushi f31532d3b2 Mention `HAIR` to clarify 2020-08-02 08:39:33 -05:00
Yuki Okushi 8a3e706aca Rename `HAIR` to `THIR` 2020-08-02 08:39:33 -05:00
Yuki Okushi 9c351189e9 Adjust mentions about CI to GitHub Actions 2020-08-02 08:38:26 -05:00
Yuki Okushi 68a2b034c5 Rename `src/libstd` to `library/std` etc. (#815) 2020-07-30 22:47:22 +09:00
Jake Goulding 38aef99f68 Add basic steps for a new target (#805)
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-07-29 04:41:28 +09:00
Joshua Nelson 879ca582de Update docs to match the new x.py defaults (#813) 2020-07-29 04:20:00 +09:00
Yuki Okushi 593facff2a Add RISC-V notification group instructions (#814)
* Clean-up notification groups instructions

* Add RISC-V notification group instructions

* Re-order summary of notification groups

* Add a list of the notification groups

* Apply review suggestion
2020-07-28 19:06:07 +02:00
Santiago Pastorino a99182921c Fix MIR to LLVM IR sentence (#811) 2020-07-28 05:03:37 +09:00
David Wood 50706fc2a2 Expand on the documentation for polymorphization. (#803)
This commit elaborates on the existing documentation for
polymorphization now that polymorphization has almost landed
in rustc.

Signed-off-by: David Wood <david@davidtw.co>
2020-07-22 19:42:50 +09:00
Yuki Okushi bc72178000 Fix links for cranelift (#809) 2020-07-22 19:32:21 +09:00
Federico Ponzi ed2e2b1d3f Fixes menu for rustdoc page (#804) 2020-07-18 19:18:06 +09:00
Yuki Okushi 9085f687dd Clean-up minor issues (#802) 2020-07-18 00:00:34 +09:00
Felix S Klock II aca4e6b2a4 Update chat info to reflect decision to close down Discord `#compiler`. (#800)
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-07-17 13:01:31 +09:00
Takayuki Nakata 973ced6951 Change `rustc::*` to `rustc_middle::*` (#798) 2020-07-16 11:13:49 +09:00
Santiago Pastorino a93d729018 Resync config.toml and suggest better settings 2020-07-14 15:03:16 -05:00
Yuki Okushi bda916e75d Fix typos 2020-07-14 14:26:41 -05:00
Yuki Okushi 1e14491218 Fix distortions of "representation" 2020-07-14 14:26:41 -05:00
Joshua Nelson a03162ec35 Improve getting-started guide
- Clean up wording
- Suggest `build --stage 1 src/libstd`, which doesn't recompile rustc
twice unnecessarily
- Fix rustdoc globs which only work on Linux
- Add suggestion for `build --stage 0 src/libstd`
- Suggest `-j1` for very slow builds
- Suggesting letting CI run tests when using a slow machine
2020-07-14 14:24:40 -05:00
Takayuki Nakata e2389e57d8 Fix the difference of title in appendix A (#793) 2020-07-14 10:06:22 +09:00
Ivan Veselov 87554a233a Earlier clarification of pFCP abbreviation (#791) 2020-07-12 10:29:17 +09:00
Ivan Veselov a744c0ae04 Fix typo: review -> reviewer 2020-07-11 09:30:19 -05:00
Santiago Pastorino e17cf59c30 inluding -> including 2020-07-10 16:47:54 -05:00
Matt Kraai e89e5fecc5 Canonicalize part 1 name (#788) 2020-07-05 08:19:10 +09:00
Nadrieril 6889dcc7d5 Suggest selectively disabling optimizations 2020-07-04 18:06:41 -05:00
Eric Huss 20e080bf38 Update bug report links. 2020-07-04 13:09:55 -05:00
Yuki Okushi 85b8077831 Fix link for armhf-gnu Dockerfile 2020-07-04 13:06:27 -05:00
Eric Huss 401d0bf12b Update docs on using Docker images. 2020-07-04 12:44:57 -05:00
Takayuki Nakata 45fb510957 Fix jump marker of debruijn index (#783) 2020-07-04 00:31:52 +09:00
Eric Huss 434631397b Minor updates to stage docs. (#781) 2020-07-04 00:28:44 +09:00
Who? Me?! f86c34e7d7 add stub inline asm chapter (#773) 2020-07-03 07:37:29 +09:00
Takayuki Nakata 0fd8abe5bf Fix the names of table of contents and heading are different
Not to write the part of Appendix `A` in heading along with other appendix.
2020-07-02 15:44:52 -05:00
mark 27b9565b71 fix links 2020-07-01 22:07:52 -05:00
Who? Me?! 92cbc030cd Escape other non-link
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
Who? Me?! d3c6f899cb Fix non-link
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
mark 6bc1c18282 fix links 2020-07-01 22:07:52 -05:00
mark 638073deb1 fix links 2020-07-01 22:07:52 -05:00
mark 6796449f88 line length 2020-07-01 22:07:52 -05:00
mark 60b8d21d5c move CONTRIBUTING.md to rustc-dev-guide 2020-07-01 22:07:52 -05:00
pierwill 431c3a3be2 Edit Part 2 introduction (#777)
* Edit Part 2 introduction

* needs a pause

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-07-01 13:26:25 +02:00
mark 3d657229ad fix file name 2020-06-30 16:04:28 -05:00
Who? Me?! 342c4b7ba9 Move Getting Started to a "prefix chapter" 2020-06-30 16:04:10 -05:00
Who? Me?! 3e6097db7e Move Errors and Lints to Analysis 2020-06-30 16:03:50 -05:00
Yuki Okushi 38d14755b3 Rename resolvers following the latest rustc change (#776) 2020-06-30 16:22:38 +02:00
pierwill d18ab7154a Edit ty.md
Makes various edits throughout for formatting, punctuation, and typo fixes.
Also makes some edits and re-wording for clarity.
2020-06-28 18:39:46 -05:00
Joshua Nelson 089dd18f03 Fix line lengths 2020-06-28 12:15:23 -05:00
Joshua Nelson e4d6bfe303 Improve wording and fix typos
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-06-28 12:15:23 -05:00
Joshua Nelson 38e0461def Revamp bootstrapping section
- Move most of the overview to building/bootstrapping.md
- Add things besides stages to bootstrapping.md
2020-06-28 12:15:23 -05:00
Aaron Hill e362fdc8c7 Add 'recovery' to the gloassary 2020-06-27 11:05:32 -05:00
Who? Me?! 7884fdfdb0 Fix formatting 2020-06-24 21:38:54 -05:00
Who? Me?! 32c4f1aa61 Upgrade to mdbook 0.4 and switch to book parts (#764)
* upgrade to mdbook 0.4 and switch to book parts

* update linkcheck

* fix links, update about-this-guide
2020-06-24 14:47:50 -03:00
Joshua Nelson 541f88e8dd Move x.py commands to overview 2020-06-23 17:40:16 -05:00
Joshua Nelson bf38f1b6f8 Split up rustdoc page 2020-06-23 17:40:16 -05:00
Joshua Nelson ee73a81989 Move rustdoc to 'How to build the compiler'
The old layout was less about rustdoc and more about the compiler:
"Here is an example of a project using rustc_interface".
This gives focus to rustdoc on something you might want to work on for
its own sake. It also makes the page much easier to find for newcomers.
2020-06-23 17:40:16 -05:00
Drew Youngwerth cb950b77e8 Small spelling fix. 2020-06-23 12:44:15 -05:00
mark 93c21dd722 address review comments 2020-06-23 12:42:06 -05:00
Florian Gilcher 59e5e68074 Add prerequisite page 2020-06-23 12:42:06 -05:00
Andy Russell 20d3370db9 add suggestion style guide
The guide is based on [existing rustdoc].

[existing rustdoc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_errors/struct.Diagnostic.html#method.span_suggestion
2020-06-23 12:35:07 -05:00
Who? Me?! 98a67dc23b Fix links for now. 2020-06-23 00:35:54 -05:00
ThePuzzlemaker c398a14f33 Add information about size for building the Rust Compiler
The Rust codebase is large, not to mention the submodules. It would be helpful for some to have a warning or note about storage required before they spend possible hours to build, only to get a message in some form that they are running out/already out of storage. I did a stage1 build incrementally and it produced a build directory of about 14 gigabytes.
2020-06-22 15:48:14 -05:00
Who? Me?! 8011445536 Fix master branch links (#757)
* fix links

* some debugging

* more debugging

* fix git checkout in ci

* try again

* already tests with a merge

* Typo

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

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-06-21 20:25:43 +02:00
Who? Me?! 92fafef00a new tykind::error convention (#715) 2020-06-19 07:55:58 +02:00
mark 8017824161 fix line length 2020-06-18 12:16:00 -05:00
mark b5864347d0 address a bunch of review comments 2020-06-18 12:16:00 -05:00
Who? Me?! d94394322b LeSeulArtichaut wording/typo fixes
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
mark d4056d0820 address review comments 2020-06-18 12:16:00 -05:00
Who? Me?! b24d9eb1fa Apply suggestions from code review
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
Who? Me?! 28ccf26223 Better wording
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
mark 4250a4030a Slightly reorganize to first present the slow command then the fast commands 2020-06-18 12:16:00 -05:00
mark d829ce6f9b add a note about disk space 2020-06-18 12:16:00 -05:00
mark 0acd363057 python 3 also 2020-06-18 12:16:00 -05:00
Who? Me?! b7e8d5f398 Apply suggestions from code review
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
Co-authored-by: Phil Hansch <dev@phansch.net>
2020-06-18 12:16:00 -05:00
mark c6766dfb7c add forge 2020-06-18 12:16:00 -05:00
Who? Me?! e492cf389b Apply suggestions from code review
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
mark 5e2d3c35ed add note on submodules 2020-06-18 12:16:00 -05:00
mark 3bedf5c442 add a bit more 2020-06-18 12:16:00 -05:00
mark a9a82c4420 fix link 2020-06-18 12:16:00 -05:00
mark 1f0f15f380 mention incremental disk space 2020-06-18 12:16:00 -05:00
mark 6e482fb047 a couple more small changes 2020-06-18 12:16:00 -05:00
mark 96a7a9a49c some minor updates 2020-06-18 12:16:00 -05:00
mark 7942336575 write about processes 2020-06-18 12:16:00 -05:00
mark 655b6ba886 address some review comments 2020-06-18 12:16:00 -05:00
Who? Me?! 78e224ca52 Typo fixes
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
mark 4cbb4c384e start a getting started guide 2020-06-18 12:16:00 -05:00
Eric Huss 7c51350dfc Add a link to the forge procedure on adding new options. (#754) 2020-06-18 10:33:15 +02:00
Joshua Nelson b5be6012f6 Don't give `x.py clean` as the first x.py example
This command shouldn't be used very often, and it has its own whole
section below anyway.
2020-06-18 04:41:59 +02:00
Joshua Nelson 7e3da5c2ee Document rustdoc behavior
- `RUSTDOC_LOG`
- `// aux-build:filename.rs`
- `// build-aux-docs`
2020-06-17 09:24:41 -05:00
Eric Huss 6d921020b6 Add some more detail on compiletest normalization. 2020-06-16 23:14:05 -05:00
Ralf Jung 4c48d4c0eb tag/niche terminology (#747) 2020-06-11 12:38:42 +02:00
LeSeulArtichaut a50d9c590a Clean up the paragraph about aliases for pinging the notification groups (#743)
* Clean up the paragraph about aliases for pinging the notification groups

* Add windows and arm command invocations

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

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
2020-06-10 18:04:19 -04:00
LeSeulArtichaut 78b302c3a9 Include "Lint" in the title of the diagnostics chapter (#742) 2020-06-10 15:19:59 -03:00
Niko Matsakis a7a83e664d complete the ICE-breaker => notification group rename 2020-06-09 18:03:33 -05:00
Niko Matsakis df8ee5af1f add the ARM notification group (#740) 2020-06-09 23:58:22 +02:00
Niko Matsakis d152893e86 Rebrand ICE-breakers, introduce Windows notification group (#739)
* rename ice-breakers to the more general notification-group

also less confusing

* add windows notification group

* rebrand LLVM ICE-breakers as a "notification group"

* include the link to example windows PR
2020-06-09 16:42:00 -03:00
Tomasz Miąsko df23757b09 Document needs-* compiletest directives 2020-06-08 12:33:35 -05:00
Who? Me?! 98d000fb3c Add a bit about various type system concepts (#697)
* add a bit on dataflow analysis

* add a bit on quanitification

* add a bit on debruijn index

* add a bit on early and late bound params

* add missing link

* Typos

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

* clarify dataflow example

* fix formatting

* fix typos

* Typos

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

* fix errors in background

* remove dup material and make early/late intro short

* adjust intro

* Niko's intro

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

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2020-06-05 13:11:09 -03:00
Bastian Kauschke e74b4ab3a4 update conventions (#735)
* update conventions

* typo

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

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
2020-06-05 13:06:39 -03:00
Bastian Kauschke f9c6c1b117 braces 2020-06-05 10:34:56 -05:00
Bastian Kauschke c9f49c6581 words 2020-06-05 10:33:15 -05:00
Who? Me?! 138c73f545 Fix link (#734) 2020-06-05 17:10:01 +02:00
LeSeulArtichaut c4590c0644 Add more info on useful workflows (#727)
* Add more info on useful workflows

* Apply suggestions from code review

Co-authored-by: mark-i-m <mark-i-m@users.noreply.github.com>
Co-authored-by: spastorino <spastorino@gmail.com>

Co-authored-by: mark-i-m <mark-i-m@users.noreply.github.com>
Co-authored-by: spastorino <spastorino@gmail.com>
2020-06-03 22:46:04 +02:00
Yuki Okushi 6b85d54752 Update lint declaration example (#713) 2020-05-30 08:49:25 +09:00
Tom Eccles 01f01823ed Document more //ignore-X test headers 2020-05-29 13:27:03 -05:00
Tom Eccles d56a31f73c Document remote testing 2020-05-29 13:27:03 -05:00
LeSeulArtichaut 2b3522a840 Document `RUSTFLAGS_STAGE_` bootstrap environment variables (#728)
* Document `RUSTFLAGS_STAGE_`

* Fix typos

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-30 01:20:24 +09:00
Chris Simpkins 1036ac82ed Update src/tests/adding.md
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-28 19:57:59 -05:00
Chris Simpkins 154e750ec5 add documentation of UI test error annotation substring support 2020-05-28 19:57:59 -05:00
Chris Simpkins f086b737ef Expand error annotations section with examples (#724)
* expand error annotations section with examples

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-29 02:43:22 +09:00
Eric Huss 3bb5fc53b5 Clarify lint vs fixed diagnostic. 2020-05-27 20:33:46 -05:00
Eric Huss 000f04e2f9 Updates from review. 2020-05-27 20:33:46 -05:00
Eric Huss 9befa0d9cc Apply suggestions from code review
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-27 20:33:46 -05:00
Eric Huss 5ae9e9191e Add some guidelines on diagnostics. 2020-05-27 20:33:46 -05:00
LeSeulArtichaut cf38ea60b2 Apply suggestions from code review
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-05-27 15:17:33 -05:00
LeSeulArtichaut bc9d1d0d76 Fix typo
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-27 15:17:33 -05:00
LeSeulArtichaut fc379a898f Add definition of `niche` to the glossary 2020-05-27 15:17:33 -05:00
Eric Huss 865e5542ad Move CLI to part 3. 2020-05-27 12:35:13 -05:00
Eric Huss 3d077bb26e Apply suggestions from code review
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-05-27 12:35:13 -05:00
Eric Huss 8f7abbdf41 Add some guidelines on the CLI. 2020-05-27 12:35:13 -05:00
Michael Bryan e4c502318f It looks like the high-level-overview was renamed (#721) 2020-05-28 00:04:56 +09:00
LeSeulArtichaut a3287df2ad Add section for debugging rustc type layouts (#720) 2020-05-27 14:17:39 +02:00
Yuki Okushi 523e300c04 Rename `upvars` query to `upvars_mentioned` 2020-05-26 11:05:21 -05:00
Yuki Okushi 85d815d11d Update docs related to const-eval/Miri (#676)
* Update docs related to const-eval

Co-authored-by: Ralf Jung <post@ralfj.de>
2020-05-25 17:23:15 +09:00
Adam Perry c777d434f5 Extern blocks are allowed for #[track_caller] now. (#710)
since https://github.com/rust-lang/rust/pull/70916
2020-05-23 22:40:23 +02:00
Paul Daniel Faria 9272d05ea7 Fix BodyId link typo in glossary (#709)
* Fix BodyId link typo in glossary

* Fix broken link to rustc_middle's Predicate
2020-05-23 16:25:53 -04:00
Chris Simpkins 78cf9b2ba1 typo fix (#706) 2020-05-19 11:30:27 +09:00
Jade McGough 05aee3ef6c Add missing closing paren (#705) 2020-05-16 21:19:52 -04:00
Tshepang Lekhonkhobe bd6a1ae84d Update src/appendix/glossary.md
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-05-11 23:52:00 +02:00
Tshepang Lekhonkhobe 37322a7f26 glossary: make soundness definition more readable 2020-05-11 23:52:00 +02:00
Who? Me?! dc7ffdecc3 fix links (#702) 2020-05-11 16:51:33 -03:00
Tshepang Lekhonkhobe c740ef0a26 glossary: intro feels like not adding much (#699) 2020-05-11 07:57:46 +02:00
Who? Me?! dcf75a8e60 Fix typo 2020-05-08 12:02:56 -05:00
Who? Me?! d7f14b5093 Typo
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
mark 692e2799ce add some section headers 2020-05-08 09:42:27 -05:00
mark 67ab79a722 move discussion of eager expansion to the end 2020-05-08 09:42:27 -05:00
Who? Me?! 09c665aa12 Use full path of span
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
Who? Me?! f4824c83c3 Typos
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
mark 09a6c18ccb fix some links 2020-05-08 09:42:27 -05:00
mark 79c7718b63 fix line length 2020-05-08 09:42:27 -05:00
mark 5f5e48f5bd SPRINKLE ALL THE THINGS 2020-05-08 09:42:27 -05:00
mark 5ab21a1318 sprinkle around a bunch of links 2020-05-08 09:42:27 -05:00
mark 6fee71e345 expand notes on expansion heirarchies 2020-05-08 09:42:27 -05:00
mark c53e21fdb9 add a bit more info about eager exp 2020-05-08 09:42:27 -05:00
mark 1471e109c2 expand some notes about expansion :P 2020-05-08 09:42:27 -05:00
mark 07b7e2c65b reorganize the macro expansion chapter 2020-05-08 09:42:27 -05:00
mark 4e3759adb8 add note about macros in parser chapter 2020-05-08 09:42:27 -05:00
mark 0bb8093581 reorder some chapters 2020-05-08 09:42:27 -05:00
mark 1e41004cbf add a bit to syntax intro 2020-05-08 09:42:27 -05:00
mark 325d0a00f4 add a bit to part 3 intro 2020-05-08 09:42:27 -05:00
mark 5ade22c7fc get rid of old todo 2020-05-08 09:42:27 -05:00
mark 1d92a6a465 finish going through discussion 2020-05-08 09:42:27 -05:00
mark 543f5eaa93 more notetaking 2020-05-08 09:42:27 -05:00
mark e5dff9e753 start working through discussion 2020-05-08 09:42:27 -05:00
mark 2b43588de7 some cleanup in the macros chapter 2020-05-08 09:42:27 -05:00
George Fraser 3a5328d4f7 Reference complete examples 2020-05-07 17:30:27 -05:00
George Fraser 1ac14631e8 Line length 2020-05-07 17:30:27 -05:00
George Fraser d0702a0b3b Example of getting diagnostics 2020-05-07 17:30:27 -05:00
Hanif Ariffin ebd97c81b5 Added link to the `ty::Adt` (#696)
* Added link to the `ty::Adt`

* Formatting fixes

Thanks @JohnTitor

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-07 23:44:39 +09:00
Who? Me?! 40bb43d2d1 typo
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-06 17:03:52 -05:00
mark 10c6b7a749 add a bit more on parallel compilation 2020-05-06 17:03:52 -05:00
Bastian Kauschke e5dbc6f534 Fix example for winnowing 2020-05-02 21:23:21 -05:00
Tshepang Lekhonkhobe 5aad3d043d improve info regarding incremental a little 2020-05-01 09:18:42 -05:00
Tshepang Lekhonkhobe c518e9d49d I confirmed this 2020-05-01 09:17:27 -05:00
Who? Me?! c035c846ec tidy 2020-04-30 21:25:29 -05:00
Hanif Ariffin 68aa2de832 Update src/queries/incremental-compilation.md
Removed `at`.

Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-30 21:25:29 -05:00
Hanif Ariffin 16229dd3af Hide link behind a clickable text
It currently does not appear as a clickable link here https://rustc-dev-guide.rust-lang.org/queries/incremental-compilation.html
Additionally, this is a particularly long and nasty link.
2020-04-30 21:25:29 -05:00
Hanif Ariffin 2b6a77ea0a Minute formatting fix 2020-04-30 21:25:17 -05:00
Santiago Pastorino a056d24ef6 It's just ICE-breaker (#685) 2020-04-28 21:19:37 +02:00
Santiago Pastorino abd9ddb16b Remove extra the 2020-04-27 15:45:00 -05:00
Santiago Pastorino 1bb6b0937f Fix sub-diagnostic typo 2020-04-27 15:45:00 -05:00
Who? Me?! ed380c3b77 remove info about diag ice breakers; doesn't exist yet (#682) 2020-04-25 16:23:59 -03:00
Charles Lew 024e7f366d Address review comments.
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-04-25 06:57:48 -05:00
Charles Lew 0895f6eca0 Fix links. 2020-04-25 06:57:48 -05:00
Charles Lew 37ffada957 Address review comments. 2020-04-25 06:57:48 -05:00
Charles Lew 4b1b22464f Fix links and CI error. 2020-04-25 06:57:48 -05:00
Charles Lew 7d843fcd4f Remove details about chalk and point to Chalk Book instead. 2020-04-25 06:57:48 -05:00
Santiago Pastorino 1b0f87c8dc treat-err-as-bug=n means panic on nth error 2020-04-24 13:48:01 -05:00
Bastian Kauschke 07c46e7dcf Replace `rustc` with `rustc_middle` (#680) 2020-04-20 15:16:27 +02:00
Who? Me?! 7f78165cb5 Typo 2020-04-19 13:08:39 -05:00
Esteban Küber 4266d9d902 review comments: move text to more relevant section 2020-04-19 13:08:39 -05:00
Esteban Küber d738fed623 Add diagnostics ICE-breakers page 2020-04-19 13:08:39 -05:00
Santiago Pastorino 9cf06ca801 Fix typo (#678) 2020-04-19 17:54:45 +02:00
Yuki Okushi ede5d97881 Apply suggestions from Zoxc 2020-04-18 20:58:14 -05:00
Michael Woerister d4c57c9269 Apply feedback. 2020-04-18 20:58:14 -05:00
Michael Woerister 2f9724f4a3 Add documentation about incr. comp. query attributes and the projection query pattern. 2020-04-18 20:58:14 -05:00
Who? Me?! 5cf8fea638 Fix some whitespace (#677) 2020-04-19 01:40:16 +09:00
Yuki Okushi 262237683d Apply suggestions from code review
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
2020-04-18 11:11:33 -05:00
mark 38927a594e add link to intrinsic 2020-04-18 11:11:33 -05:00
Who? Me?! 6b521a2504 Remove various todos
With some items added to https://github.com/rust-lang/rustc-dev-guide/issues/674

Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
2020-04-18 11:11:33 -05:00
mark 034cb09659 line length 2020-04-18 11:11:33 -05:00
Chris Simpkins 25227a8314 [overview.md] add lexer updates, parser updates
includes feedback from matklad (lexer) and centril (parser)
2020-04-18 11:11:33 -05:00
Chris Simpkins 276d2b6268 [overview.md] add initial parser documentation 2020-04-18 11:11:33 -05:00
mark a1f86d6af8 fix links 2020-04-18 11:11:33 -05:00
mark bf6c05c005 add intrinsics to glossary 2020-04-18 11:11:33 -05:00
mark cd8801485f minor wording change on bootstrapping 2020-04-18 11:11:33 -05:00
mark 160e142616 update mono entry points 2020-04-18 11:11:33 -05:00
Chris Simpkins a12e9e31a3 [overview.md] add documentation of lexer support for Unicode encoding 2020-04-18 11:11:33 -05:00
mark 18d695aa13 correct entry points for codegen 2020-04-18 11:11:33 -05:00
mark 5cc816afd2 some cleanup 2020-04-18 11:11:33 -05:00
mark 8600655969 add entry points for type check and type inference
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
mark 3bf10201ac add a para on interning and arenas 2020-04-18 11:11:33 -05:00
Chris Simpkins 85533c23ff [overview.md] add parser entry point links 2020-04-18 11:11:33 -05:00
mark 27e440e369 fix lexer entry point 2020-04-18 11:11:33 -05:00
Who? Me?! 79eec5bc6c Improve wording
Co-Authored-By: Santiago Pastorino <spastorino@gmail.com>
2020-04-18 11:11:33 -05:00
mark ba961af42f add an entry point 2020-04-18 11:11:33 -05:00
mark ff3f073ad3 remove a todo 2020-04-18 11:11:33 -05:00
mark 14eb19f2b9 fix links 2020-04-18 11:11:33 -05:00
mark 256a690b7c line lengths 2020-04-18 11:11:33 -05:00
mark b496d8de63 add a few todos 2020-04-18 11:11:33 -05:00
mark 29765d08d8 write a bit about bootstrapping 2020-04-18 11:11:33 -05:00
mark 5c27142364 add a note on tcx name 2020-04-18 11:11:33 -05:00
mark dd2fa1b863 break long sentence 2020-04-18 11:11:33 -05:00
mark b7c0121552 Improve description of MIR
Co-Authored-By: Centril <twingoow@gmail.com>
2020-04-18 11:11:33 -05:00
mark edcf8ab931 correct the note about HAIR 2020-04-18 11:11:33 -05:00
mark 1424834cd1 mention token stream as an IR 2020-04-18 11:11:33 -05:00
mark cc49d816bc mention the hair 2020-04-18 11:11:33 -05:00
mark a37e554d42 Add some entry points
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
mark fdb20d6801 fix old rustc-dev-guide links 2020-04-18 11:11:33 -05:00
Chris Simpkins 5f43e74c25 Update src/overview.md
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
Chris Simpkins 72a378bcfc Update src/overview.md
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
Chris Simpkins 0ed7c0a7f3 [overview.md] Add command line argument parsing, lexer stages, and parser outline 2020-04-18 11:11:33 -05:00
mark 1775a945aa Apply Centril suggestions
Co-Authored-By: Centril <twingoow@gmail.com>
2020-04-18 11:11:33 -05:00
mark 91ae0ab7e0 correct a few links 2020-04-18 11:11:33 -05:00
mark 4272a80c38 add overview 2020-04-18 11:11:33 -05:00
Jan-Erik Rediger 3b6defe682 Start with the basics (#675)
* The very first step should be to clone the repository

* Make the command copy-able

By having the plain command users can select and copy the text and paste
it, without needing to fiddle around to remove extra characters.

Now that the previous command switched directories it is not necessary
to be called out here again either.

* Update src/building/how-to-build-and-run.md

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-04-17 21:16:56 +09:00
Ralf Jung 61f246ef7c codegen tests: add link to LLVM FileCheck docs (#673) 2020-04-12 02:34:25 +09:00
Arlo Siemsen 620878ba6b Add section describing source file checksums in debug info 2020-04-08 15:50:31 -05:00
Who? Me?! 4c9670a6c2 fix a link (#672) 2020-04-08 08:52:05 +02:00
Chris Simpkins 50910ad220 mark-i-m review edits 2020-04-07 12:11:56 -05:00
Chris Simpkins 8021d3e707 consistent section title casing 2020-04-07 12:11:56 -05:00
Chris Simpkins 1ab6693c00 update about-this-guide.md with new Guide sections 2020-04-07 12:11:56 -05:00
Who? Me?! 10a4d76ecd Reorganize the guide (#651)
* start on guide reorg

* backend intro

* part 2, 3, 4 intros

* some missing files

* Fix typos

Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>

* add links from intro

* rename compiler source chapter and add placeholder for overview

* rename parts, mv rustc_driver to part 3, make syntax chapter

* update part intros

* add syntax ch intro

* address review comments

* Better overview chapter placeholder

Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>

* fix link

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-04-06 13:23:34 -03:00
Paul Daniel Faria e2ea943091 Remove duplicate trait reference entry from glossary, fix alphabetical sorting 2020-04-06 10:41:28 -05:00
LeSeulArtichaut 277da2317e Rework commit message 2020-04-05 12:49:29 -05:00
LeSeulArtichaut 4c24f41e0a Note that the invocation now are aliases 2020-04-05 12:49:29 -05:00
LeSeulArtichaut 0cd5910a37 Change ICE-breaker ping to use the aliases
Related to rust-lang/rust#69949
2020-04-05 12:49:29 -05:00
Paul Daniel Faria fa8048117c Wrap link in borrow_check.md to satify line length checks 2020-04-05 12:46:22 -05:00
Paul Daniel Faria ef8048d986 Add ids to all glossary items, make existing glossary links point to glossary, add links for def id in query.md 2020-04-05 12:46:22 -05:00
Tshepang Lekhonkhobe 858b0440a9 remove stupid-stats, and some references to removed API 2020-04-04 13:36:17 -05:00
Tshepang Lekhonkhobe a05591ab58 add pre-requisite for calling into compiler API (#663) 2020-04-04 09:37:39 +02:00
Paul Daniel Faria b54c64cb0f Add BodyId to glossary, and links for ids to HIR identifiers section (#660) 2020-04-03 19:22:08 +02:00
Santiago Pastorino 0a31a71b7d Update some projects locations (#658) 2020-04-02 18:40:15 +02:00
Who? Me?! f57ba1f6e2 Shorten line 2020-04-01 20:09:08 -05:00
George Fraser c956778dbe Update src/SUMMARY.md
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-04-01 20:09:08 -05:00
George Fraser 5753bb54d6 Update src/rustc-driver-interacting-with-the-ast.md
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-04-01 20:09:08 -05:00
George Fraser 6b2cb50b76 How to get the type of an expression using rustc_interface 2020-04-01 20:09:08 -05:00
Santiago Pastorino 80ba3e282e Remove left overs from HackMD migration (#655) 2020-04-01 16:25:14 +02:00
Tshepang Lekhonkhobe ced2a9c244 Resolver trait moved (#652) 2020-04-01 11:04:45 +02:00
Tshepang Lekhonkhobe 271115f85d add link for Resolver::resolve_crate (#653) 2020-04-01 10:57:35 +02:00
Tshepang Lekhonkhobe 8edc4bc160 add some type inference links, and fix/improve some stuff (#654) 2020-04-01 10:52:31 +02:00
Tshepang Lekhonkhobe 3c82384ac8 it is rustc_parse, not rustc_parser 2020-03-31 22:17:35 -05:00
Tshepang Lekhonkhobe 32c8cd6a2d follow 4-space indent idiom 2020-03-31 22:17:15 -05:00
Tshepang Lekhonkhobe 08c37897c0 point to new Cranelift home 2020-03-31 21:35:36 -05:00
Adam Perry 5da1faa4ff fix broken links 2020-03-31 21:34:55 -05:00
Adam Perry c110b812c5 Implicit Caller Location section. 2020-03-31 21:34:55 -05:00
mark 4589ebf70e and a few more links 2020-03-31 15:43:14 -05:00
mark f0c9f6dca6 fix a few more links 2020-03-31 15:43:14 -05:00
Tshepang Lekhonkhobe 137ebb6521 QueryDescription has moved 2020-03-31 15:43:14 -05:00
LeSeulArtichaut cb99cfcc1e Rename `librustc` to `librustc_middle` 2020-03-31 15:43:14 -05:00
ecstatic-morse c7bf757148 Update reference to `has_any_child_of` in docs
This function was obsoleted by `find_in_move_path_or_its_descendants`.
2020-03-31 15:43:14 -05:00
Tshepang Lekhonkhobe dd144563af glossary: misc improvements (#638) 2020-03-28 21:29:57 +02:00
Alex Aktsipetrov 7f3f063b5c Fix typo (#635)
* Typo

* Update src/queries/query-evaluation-model-in-detail.md

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-03-27 19:42:53 +09:00
Michael Woerister ce5a554075 Update description of incremental compilation. 2020-03-26 15:50:51 -05:00
Alex Aktsipetrov 027cd18682 Update high-level-overview.md
Remove an obsolete clarification about libsyntax and co.
2020-03-25 14:46:29 -05:00
Chris Simpkins 4f7c689ef7 minor grammar edit 2020-03-22 19:27:23 -05:00
Chris Simpkins 28cb56c4a5 change title
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-03-22 19:27:23 -05:00
Chris Simpkins b7c8ade866 Update src/licenses.md
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-03-22 19:27:23 -05:00
Chris Simpkins 6c4b60dd52 add rust-lang/rust license documentation 2020-03-22 19:27:23 -05:00
Chris Simpkins fd19872109 [stupid-stats] replace removed rustc_codegen_utils with rustc_codegen_ssa 2020-03-22 17:58:00 -05:00
George Fraser ea4db5371c run_compiler is exported by rustc_interface 2020-03-22 14:33:47 -05:00
George Fraser ae0f419582 Fix reference
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-03-21 19:48:32 -05:00
George Fraser fe5b3786ef Reference example from #621 2020-03-21 19:48:32 -05:00
Who? Me?! 824815f19b Move GenericArgs chapter under ty (#624) 2020-03-21 01:32:33 +09:00
Bastian Kauschke 3b1dc7307e words (#622) 2020-03-20 03:57:12 +09:00
bjorn3 b154e3bf15 Fix typo (#618) 2020-03-17 21:14:48 +02:00
Santiago Pastorino 3c9fb4140d Update src/walkthrough.md
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-03-17 12:16:02 -05:00
Santiago Pastorino d1b6bc8c3b Update src/bug-fix-procedure.md
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-03-17 12:16:02 -05:00
Santiago Pastorino 41acd4400a use-jemalloc -> jemalloc 2020-03-17 12:16:02 -05:00
Santiago Pastorino 9c853c9a23 Fix line lengths 2020-03-17 12:16:02 -05:00
Santiago Pastorino e3c9c55b2f Remove typo 2020-03-17 12:16:02 -05:00
Santiago Pastorino 5a97e0aace This page is diagnostics.html now 2020-03-17 12:16:02 -05:00
Santiago Pastorino 15ce51670c It may Take a lot of time instead of 2 hours 2020-03-17 12:16:02 -05:00
Santiago Pastorino a6fd9bc595 All the text is at the time of this writing 2020-03-17 12:16:02 -05:00
Santiago Pastorino 07adbd3e18 Suites are defined in enum Mode 2020-03-17 12:16:02 -05:00
Santiago Pastorino 464f90bd19 This is no longer true since rust#49219 2020-03-17 12:16:02 -05:00
Santiago Pastorino 9015b33c7e Avoid as of this writing given that everything is as of this writing :) 2020-03-17 12:16:02 -05:00
Santiago Pastorino 028660b6c0 Rephrase where compiletest is located 2020-03-17 12:16:02 -05:00
Who? Me?! fc6fe52313 Add some more info to param_env (#610)
* add some more info to param_env

* Remove some trailing spaces

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-03-17 20:11:37 +09:00
Solomon Ucko 5f6514575c Changed rustc-ty link to go to first message 2020-03-16 21:25:37 -05:00
Solomon Ucko 52147d7ca2 Change Rust Koans link to point to first koan 2020-03-16 21:00:47 -05:00
Who? Me?! f87d8e1cc5 Fix broken link (#612) 2020-03-17 08:20:38 +09:00
DillionMango b504d9c3a7 quote some commands by to make the style more consistent (#611) 2020-03-16 17:43:48 +09:00
Youngsuk Kim b51dfaa0d1 Clarify sentence meaning 2020-03-15 21:27:40 -05:00
Yuki Okushi aa1e3f5a08 Fix broken link 2020-03-15 12:47:04 -05:00
Who? Me?! 4da109a593 Fix sentence grammar 2020-03-12 14:11:01 -05:00
Who? Me?! 0e05dea45a Use common (American) spellings
Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
2020-03-12 14:11:01 -05:00
Who? Me?! 0dd7f6291c Update src/backend/codegen.md
Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
2020-03-12 14:11:01 -05:00
Mark Mansi da7894aa29 update backend chapters from nagisa's notes 2020-03-12 14:11:01 -05:00
Mark Mansi 44cba6e075 monomorphization chapter 2020-03-12 14:11:01 -05:00
Mark Mansi e19762b57c add some placeholder text, short intro 2020-03-12 14:11:01 -05:00
Mark Mansi cc50f978e1 skeleton for backend chapters 2020-03-12 14:11:01 -05:00
Santiago Pastorino c05ed676d2 Rename rustc-guide to rustc-dev-guide (#601)
* Rename rustc-guide to rustc-dev-guide

* rust-lang.github.io/rustc-dev-guide -> rustc-dev-guide.rust-lang.org
2020-03-10 11:01:43 -03:00
Chris Simpkins 3524cac4b4 Update ./x.py tidy testing documentation (#607)
* update all docs to use ./x.py test tidy syntax
2020-03-10 12:02:24 +09:00
Who? Me?! fc0700a63b Just lol (#603)
* Just lol

* Update src/appendix/humorust.md

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-03-08 11:05:26 +09:00
Yuki Okushi b9d723f727 Remove references to chalkify tests (#604) 2020-03-08 00:24:56 +09:00
Who? Me?! b99990cbe7 typo (#599) 2020-03-04 01:41:36 +09:00
LeSeulArtichaut 3e3f0363f5 Get rid of references to the refractored `libsyntax` crate (#598)
* Get rid of references to the refractored `libsyntax` crate

* Apply suggestions from code review

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-03-03 04:41:41 +09:00
LeSeulArtichaut fb1c1376e2 Make all links in Appendix E active 2020-03-01 20:54:40 -06:00
Yuki Okushi 47b5a863ac Move bless section to running chapter 2020-02-27 11:10:14 -06:00
SarthakSingh31 8e0f4d1629 Fixed wrong variable name (#593) 2020-02-27 09:08:34 +09:00
Philipp Hansch ff764756e3 Don't reference librustc_resolve just yet.
It's mentioned further down with more details.
2020-02-25 22:39:16 -06:00
Philipp Hansch 5d735ad4d4 typo: eg. -> e.g. 2020-02-25 22:39:16 -06:00
Philipp Hansch e4a2974e31 Name resolution: Add intro section 2020-02-25 22:39:16 -06:00
Mark Mansi cc4f5ce105 add back link 2020-02-20 16:01:35 -06:00
Mark Mansi bc5c726295 update glossary 2020-02-20 16:01:35 -06:00
Mark Mansi d6c9c42df5 create a separate chapter on arenas/interning 2020-02-20 16:01:35 -06:00
Mark Mansi 43ca498a19 mention tidy bless 2020-02-20 10:28:24 -06:00
Mark Mansi f6291ab302 tidy runs rustfmt check 2020-02-20 10:28:24 -06:00
Mark Mansi 209fa47503 document ./x.py fmt 2020-02-20 10:28:24 -06:00
Who? Me?! 9c939f4df0 spit of type folder and generics subchapters (#586) 2020-02-19 10:31:20 -03:00
Mark Mansi 0d606a5b08 fix link 2020-02-18 16:05:50 -06:00
Yuki Okushi f1e7112d9f Update section following current state 2020-02-18 11:29:39 -06:00
LORIS INTERGALACTIQUE 4525b72263 Add links to the rustc docs (#578) 2020-02-15 09:35:11 +09:00
Yuki Okushi 7e862e9ebf Fix link 2020-02-14 16:21:53 -06:00
Youngsuk Kim ff66b6f813 Add link to `rustc::mir::Location` (#579) 2020-02-14 23:56:21 +09:00
Youngsuk Kim 1923edf526 Correction of type name (#576)
`ConstraintSet` => `OutlivesConstraintSet`
2020-02-12 17:15:44 -03:00
Loris-intergalactique e924dc5032 Minor typo correction 2020-02-12 10:55:46 -06:00
Youngsuk Kim 99243950eb minor typo fix 2020-02-10 23:07:17 -06:00
Youngsuk Kim 6a31c24e83 minor typo fix 2020-02-10 16:26:29 -06:00
Tomasz Miąsko c83c96402a Update sanitizers documentation (#562) 2020-02-10 10:53:59 -05:00
Felix S Klock II 7e93524143 Added example of icebreakers-cleanup-crew
(I figure its low cost to just list all the possible pings, compared to the cost of people getting the command wrong or not even knowing the full set of teams possible.)
2020-02-06 17:10:27 -06:00
Eduard-Mihai Burtescu 7be25179bd mir: begin documenting user variable debuginfo. (#571) 2020-02-05 23:55:42 +01:00
Wesley Wiser c1d96c73b8 Add a mention of the new `-Zllvm-time-trace` flag 2020-02-02 23:54:00 -06:00
Who? Me?! da4be3ac20 Fix broken links (#570) 2020-02-03 14:26:13 +09:00