Commit Graph

1745 Commits

Author SHA1 Message Date
Tshepang Mbambo 2802da7b37
replace misleading name (#1401) 2022-07-19 15:56:24 +09:00
Yuki Okushi dca7b1b9c1 Remove a mention to Steve on r? example
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-18 07:31:14 +02:00
Tshepang Mbambo 168442374d obey line length limit (part 3) 2022-07-17 23:34:12 +02:00
Tshepang Mbambo 1b62c12bbe obey line length limit (part 2) 2022-07-17 23:34:12 +02:00
Tshepang Mbambo 5cc90f3ab1 obey line length limit 2022-07-17 23:34:12 +02:00
HackMD 857ee492fc sync with hackmd 2022-07-17 23:34:12 +02:00
Niko Matsakis 53395b0e3d add draft chapter 2022-07-17 23:34:12 +02:00
Tshepang Mbambo ade9352771 use relative links
Used the following command, followed by some manual tweaking:

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

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

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

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

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

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

* line length

* review

* Update src/borrow_check/type_check.md

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

* Fix typos

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

* Clarify Niko comment

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

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

* Fix lexer crate

* Edit wording

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

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

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

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

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

* Update tests chapters for review comments.

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

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

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

* Make some other assorted minor cleanups and improvements
2022-01-18 11:09:16 -03:00
Nicholas Nethercote 18b93ae2ee Address more review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote acc6718c51 Address review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote a992723654 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 875464457c
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 f6a190e709
Fix link in contributing.md (#1280) 2021-12-27 10:28:15 -06:00
Nicholas Nethercote a11e5f4e15
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 9bf0028b55
remove rustfix item in test intro (#1277) 2021-12-20 21:53:57 +09:00
Noah Lev 7340eb8704 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 35dce028e7 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 5dd756bceb
Fix some broken links (#1274) 2021-12-13 15:16:30 +09:00
Jacob Hoffman-Andrews f9db2f4478 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 b6cf9a7e88 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 6c1f5c780b Fix some broken links 2021-12-09 09:11:48 -06:00
Lucas Kent 0c0e4f2e44 Update src/getting-started.md
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-12-09 09:09:36 -06:00
Lucas Kent 3df5cc9fe5 Improve documentation on r? 2021-12-09 09:09:36 -06:00
Rich Kadel a374e7d8bb
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 2cee5a9be8 Improve 'Running tests manually' section 2021-11-27 03:45:39 -05:00
Yuki Okushi c4776cb94a Fix some links 2021-11-24 10:23:07 -05:00
Eric Huss 8a817bc6ca Update for review comments. 2021-11-24 10:22:37 -05:00
Eric Huss aaf6ccc951 Document rustfix-only-machine-applicable 2021-11-24 10:22:37 -05:00
Eric Huss 9660c153fe Apply suggestions from pierwill
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-11-24 10:22:37 -05:00
Eric Huss 285b3e4410 Document more compiletest headers. 2021-11-24 10:22:37 -05:00
Dylan MacKenzie a2fc963502
Describe drop elaboration (#1240) 2021-11-18 13:31:13 -05:00
Ken Matsui 5fbfe9363d
Fix an invalid link on Diagnostic Items (#1261) 2021-11-16 10:45:40 -03:00
Yuki Okushi 766f9d7b10
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 24132faa13
Unify `x.py` usage (#1258) 2021-11-16 07:44:50 +09:00
Lucas Kent 0fc1fa9f1e Spelling fixes 2021-11-15 08:23:01 -06:00
Lucas Kent f1297f5560 Fix compare-mode documentation 2021-11-14 17:01:35 -06:00
Noah Lev 6b9c8ae1a8 Fix broken link in "Bootstrapping"
The italics added in #1239 broke the implicitly-resolved link.
2021-11-09 21:46:27 -06:00
chubei 196ef69aa6 Fix typo: [upv.rs_mentioned] -> [upvars_mentioned] 2021-11-07 07:48:47 -06:00
asquared31415 ffcc6297c6
Add note to emphasize replacing TARGET_TRIPLE (#1250) 2021-11-06 18:32:55 +09:00
Eric Huss 8a8452cfcc Remove some legacy test suites. 2021-11-04 14:18:39 -05:00
Dmitry Savintsev a034fad804 tiny capitalization fix 2021-11-04 14:15:06 -05:00
Noah Lev 2ad51b6d75 Fix date
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-11-04 09:33:03 -07:00
Noah Lev f146da3734 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 292072d8e2 enhance subtree docs, link to clippy docs 2021-11-02 20:09:23 -05:00
pierwill 0f69d33e16 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 70966e597f Some minor adjustments to the diagnostic documentation 2021-10-29 21:51:05 -05:00
pierwill f3fb373be9 Edit "About this guide" for semantic line feeds
This is work toward #1241.
2021-10-28 15:30:08 -05:00
Janggun Lee ddaebd85aa
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 68dbb4501d 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 87968b466f
Describe how to trigger perf runs (#1237) 2021-10-22 01:00:27 +09:00
Joshua Nelson 4ff071741a
Remove docs on Assemble step (#1233) 2021-10-18 02:17:19 +09:00
Yusuke Abe fba15a46ca
Update some docs from 2021-10 date triage (#1230) 2021-10-12 08:52:21 +09:00
Noah Lev ceec906a31 Recommend `rustfmt --edition=2021` 2021-10-10 08:28:12 -05:00
Tomasz Miąsko afbcc3efa9 Update sanitizer documentation 2021-10-08 15:49:53 -05:00
Tomasz Miąsko cec5879a86 Mention needs-sanitizer-hwaddress directive 2021-10-08 15:49:53 -05:00
Oli Scherer 72906c9bed Address review comments 2021-10-08 15:41:06 -05:00
Oli Scherer dc16b5293b Document tracing awesomeness 2021-10-08 15:41:06 -05:00
Oli Scherer 013c8892dd Move log/tracing instructions to its own file 2021-10-08 15:41:06 -05:00
Eric Holk 0cff8fbeec Update src/closure.md
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-10-07 17:48:12 -05:00
Eric Holk 67faab2aa2 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 b71e9792c7
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 b5b3c0aa04
Update some docs from 2021-10 date triage (#1224) 2021-10-05 17:24:24 -03:00
Dave Farnham d1f03cbaa3
Fix a typo on closure.md (#1218) 2021-09-24 12:00:29 +09:00
lcnr 82d4c5604d const generics update 2021-09-20 12:35:16 -05:00
Tomasz Miąsko 17957567f7 s/--blessed/--bless/ 2021-09-19 10:36:26 -05:00
Frank Steffahn 56f6bdbb70 Make indentation consistent in example vscode config file 2021-09-17 16:52:56 -05:00
Frank Steffahn 60ef9da723 Suggests `--edition=2018` argument when using stage0/bin/rustfmt directly 2021-09-17 14:53:44 -05:00
lcnr 09bf2bd2df
`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 8c39edb660
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 9198465b6c Clarify difference of a help vs note diagnostic. 2021-09-12 11:50:44 -05:00
Andrey Cherkashin 295922ec93 remove ctag section 2021-09-08 15:13:44 -05:00
Andrey Cherkashin 8f98dac74d Update suggested.md 2021-09-08 15:13:44 -05:00
Andrey Cherkashin d1f77858e7 Update SUMMARY.md 2021-09-08 15:13:44 -05:00
Andrey Cherkashin fb62bc398f Move ctag section to "Suggested Workflow" 2021-09-08 15:13:44 -05:00
Andrey Cherkashin 5b607d9862 Delete ctags.md 2021-09-08 15:13:44 -05:00
Noah Lev 9a42b37519 Clarify paragraph in "Keeping things up to date" 2021-09-08 12:36:10 -05:00
Timothy Maloney 0cc70fcaf1 Docs: added section on rustdoc 2021-09-07 11:08:38 -05:00
Timothy Maloney 0eb2c70cf5 Docs: made suggested fix 2021-09-07 11:08:38 -05:00
Timothy Maloney 1df026246a Docs: deleted copy 2021-09-07 11:08:38 -05:00
Timothy Maloney c31ec83e91 Docs: added section discussing core ideas 2021-09-07 11:08:38 -05:00
Timothy Maloney 78afd53e8a Docs: delete redundant use of correctness 2021-09-07 11:08:38 -05:00
Timothy Maloney 0fe44f730b Docs: consolidated parallelism information 2021-09-07 11:08:38 -05:00
Dezhi Wu 71d88b345f
Add links to overview.md (#1202) 2021-09-06 18:34:16 -03:00
sjud a5dea10a46 Spelling change intermidiate to intermediate
Very importent change.
2021-09-05 12:11:19 -05:00
Dezhi Wu 30826ca7d8
Fix a typo (#1200) 2021-09-05 09:40:35 -03:00
Fridtjof Stoldt 139b8fb11b
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 95f1acf9a3 Add link to `Span` 2021-08-31 12:38:30 -05:00
Joshua Nelson 9be3fafda6
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 fa6a787cfd Fix typo, clarify backtick wording, and use inline code 2021-08-31 12:08:01 -05:00
Frank Steffahn 2f447292ff
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 0e5be8a943 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 cf0e151b79
Fix typo “a Rc” → “an Rc” (#1191) 2021-08-22 11:47:02 -03:00
Smittyvb 77a9813ae0
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 9a6bd9fc98 Remove docs for old -Z profile-queries flag 2021-08-16 08:20:03 -05:00
Rahul Butani c4644b427c
Remove a dead link in `new-target.md` + other nits (#1186) 2021-08-10 20:41:44 +09:00
Bryan Cantrill e218184b68
Add description of -opt-bisect-limit LLVM option (#1182) 2021-08-07 10:12:22 +02:00
Yoh Deadfall 809f4d1d33
Fixed team responsible for stabilization (#1181) 2021-08-05 13:41:16 +02:00
the8472 d111b3ea7e
Add S-Inactive PRs as another source of things contributors could work on (#1177) 2021-07-29 06:05:19 +02:00
Dave f094672828 git.md: Fix No-Merge Policy link 2021-07-28 09:45:23 -04:00
Ben Reeves 09343d6f92
Fix typo in building/bootstrapping.md (#1175) 2021-07-26 00:37:28 +02:00
Noah Lev f2c4bba539
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 93422c21ba Update for merge of CrateDisambiguator into StableCrateId 2021-07-13 12:45:58 -04:00
Eric Holk 1b56b09472
Minor capitalization fix (#1170) 2021-07-08 01:27:47 +02:00
Yoh Deadfall 60e2825591 Fixed typos in inline code 2021-07-05 11:21:03 -04:00
Joshua Nelson 33c1eff45e
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 1a51a21243 More specifics on what future-incompatible lints are used for 2021-07-04 23:21:24 -04:00
Ryan Levick c3c110f107 Fix line lens 2021-07-04 23:21:24 -04:00
Ryan Levick 9636fa92ab Update information on lints particularly on future-incompatible 2021-07-04 23:21:24 -04:00
Ryan Levick a4e29c5cb5 Update section of lint store 2021-07-04 23:21:24 -04:00
Ryan Levick 442ba10f1e
Update around half of the January 2021 date references (#1155) 2021-07-02 10:43:34 +02:00