Commit Graph

1975 Commits

Author SHA1 Message Date
Joshua Nelson 3ea1b4022b Update about-this-guide.md 2022-10-02 20:06:43 +02:00
Joshua Nelson 450beef13f Link to the correct page in "about this guide"
Previously, "Building and debugging `rustc`" linked to the getting started page, which isn't correct. If people want that page, it already appears in the sidebar, and is the next sequential page.
2022-10-02 20:06:43 +02:00
Lukas Wirth 21a8552e40 Update r-a config suggestions
The proc-macro server path is required for proc-macros to properly work in r-a when working on rustc.
Pointing the sysroot to the stage0 one is more correct than using the system installed one.
2022-10-01 15:48:54 -05:00
Ralf Jung 6b01ad5a98 don't refer to the compile-time interpreter as "Miri" (#1471) 2022-09-26 18:07:23 +09:00
Jhonny Bill Mena d8eb01ae15 UPDATE - Diagnostic docs to reflect renamed traits and macros in rustc PR#101558 2022-09-22 10:29:32 +01:00
Yuki Okushi 811ac7b30b Fix some typos
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-09-22 10:45:25 +02:00
Alex Saveau 890a32b6e7 Update stability guide to use CURRENT_RUSTC_VERSION (#1468) 2022-09-20 07:43:59 +09:00
Waffle Maybe b18b3edd4d Add a note about building `rust-analyzer-proc-macro-srv` (#1467) 2022-09-19 15:50:02 +09:00
Felix S Klock II 00db68b612 Link from "implementing to new features" to mcp.md (#1465) 2022-09-16 07:06:59 +09:00
Tshepang Mbambo cf7c209ce2 remove stray ** 2022-09-14 09:09:28 -07:00
Oli Scherer 339720081b Explain the new valtree system for type level constants. (#1097)
* Explain the new valtree system for type level constants.

* Update src/const-eval.md

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

* Update src/const-eval.md

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

* more syntax fixes

* add missing lifetime
2022-08-18 17:53:51 -07:00
Nathan Stocks 7536ff8e9a more syntax fixes 2022-08-18 22:41:51 +00:00
Nathan Stocks 499cc7afe2 fix incorrect #[note] syntax 2022-08-18 22:11:03 +00:00
est31 7c8bf03e3d Update slug style to use _ instead of - (#1426) 2022-08-17 23:16:44 +01:00
Tshepang Mbambo a5d21b8533 remove incorrect info (#1435) 2022-08-17 19:33:13 +09:00
Tshepang Mbambo 8156e7f9ab fix lifetime name (#1431) 2022-08-17 19:29:27 +09:00
Tshepang Mbambo 51be0fd27d Update the date reference around Git submodule bug (#1430) 2022-08-17 17:07:40 +09:00
Tshepang Mbambo 6116278158 Improve the "Diagnostic items" chapter (#1427) 2022-08-13 10:00:38 +09:00
Tshepang Mbambo b9ea2a3998 date-check: crates-io 2022-08-11 08:13:27 +02:00
Tshepang Mbambo e6f6103222 fix/improve compiler-debugging 2022-08-10 23:27:09 +02:00
Joshua Nelson 05084c67ff Update src/compiler-debugging.md 2022-08-10 09:23:51 -05:00
yukang c328379974 add gdb tips for symbol-mangling-version 2022-08-10 09:23:51 -05:00
Tshepang Mbambo 7345ceec48 move references down to avoid clutter (#1420)
Also, make link to upstream llvm repo clickable
2022-08-09 14:52:46 -07:00
Noah Lev 04b006fd12 Fix legend colors in dark mode 2022-08-09 16:47:22 -05:00
Noah Lev 31e4869545 Add color for downloaded nodes 2022-08-09 16:44:20 -05:00
Noah Lev 27512fd7ff Add colors to diagram 2022-08-09 16:44:20 -05:00
Noah Lev ebad7d357a Add bootstrapping diagram
This diagram is based on the diagram in Joshua Nelson's talk on
bootstrapping at RustConf 2022 [1]. I converted it to Mermaid and made
some tweaks to simplify it and bring it closer to bootstrap's
terminology, and then Ralf Jung added nodes for copying artifacts.

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

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

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

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

* please clippy

* update date-check docs

* accept review suggestion

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

* address review comment

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

* accept review suggestion

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

* address review comment

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

* address review comment

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

* this breaks markdown

* address review comment

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

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

* address review comment

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

* address review comment

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

* accept review suggestion

This was reverted by mistake

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

* address review comment

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

* use a more simple fn

* address review comment

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

Much more clean

* nit

* accept review suggestion

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

* avoid a failed regex

Also, test new shape

* adjust to new regex (which uses named groups)

New regex was introduced by 456008cc35

Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-08-02 13:50:32 -07:00
Tshepang Mbambo c3aca0df58 address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1402#discussion_r933905339
2022-07-31 07:46:57 +02:00
Tshepang Mbambo 57401f4f39 accept review suggestion
Co-authored-by: Joshua Nelson <github@jyn.dev>
2022-07-31 07:46:57 +02:00
Tshepang Mbambo 1046f3e6e8 try address review comments 2022-07-31 07:46:57 +02:00
Tshepang Mbambo 6469d7444e summary of chapter 2022-07-31 07:46:57 +02:00
Tshepang Mbambo 0c77aa9c9e Update src/building/compiler-documenting.md
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-31 07:46:57 +02:00
Tshepang Mbambo 13a6ec809d revamp doc-build chapter 2022-07-31 07:46:57 +02:00
Tshepang Mbambo f354a7433b minor fixes 2022-07-30 19:54:34 -04:00
Yuki Okushi 769f69ca59 Prefer relative links
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi 77d9ec9476 Fix the link to clippy docs
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi f64e68eafb Fix the link to `ResolverAstLowering`
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi 75fe5e4782 Fix the link to `ProcMacro` trait
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Yuki Okushi f83caba6d0 Fix the link to `Lazy<T>`
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
Urgau 5b3ecceecc Add instructions to fix build errors in std after adding a new target 2022-07-29 17:13:46 -04:00
bstrie 3cf8dd467e Document how to build a cross-compiler 2022-07-26 11:07:55 -04:00
ridwanabdillahi 4c4f344c9d Add documentation about Microsoft provided debuggers and CodeView/PDB… (#1406)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Ridwan Abdilahi <riabdila@microsoft.com>
2022-07-26 07:33:58 +09:00
Amos Wenger 8d227efda1 rust-analyzer is now a subtree
It used to be a submodule.

cf. https://github.com/rust-lang/rust/pull/99603
2022-07-25 11:40:28 +02:00
Luqman Aden afb2eb604d Debuginfo tests now also support revisions. 2022-07-21 04:48:49 +02:00
Amos Wenger 0e30f7c0bf Link to rendered book directly
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-19 15:58:55 +02:00
Amos Wenger 386fc96942 Fix link to clippy sync docs 2022-07-19 15:58:55 +02:00
Tshepang Mbambo 9ca52b51d7 remove stray markup 2022-07-19 09:56:55 +02:00
Tshepang Mbambo b2f0e9c3e6 renamed 2022-07-19 09:56:55 +02:00
Tshepang Mbambo 839725a35d sync with hackmd version
See https://hackmd.io/5t8pLdJcRDmqbfN9ZXje3g
2022-07-19 09:56:55 +02:00
Tshepang Mbambo f55e5dfaa5 replace misleading name (#1401) 2022-07-19 15:56:24 +09:00
Yuki Okushi b6e4058122 Remove a mention to Steve on r? example
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-18 07:31:14 +02:00
Tshepang Mbambo 9dae3a8245 obey line length limit (part 3) 2022-07-17 23:34:12 +02:00
Tshepang Mbambo ddb3d38965 obey line length limit (part 2) 2022-07-17 23:34:12 +02:00
Tshepang Mbambo fbcc81b53a obey line length limit 2022-07-17 23:34:12 +02:00
HackMD 441ab7ef90 sync with hackmd 2022-07-17 23:34:12 +02:00
Niko Matsakis a6ed1bcb45 add draft chapter 2022-07-17 23:34:12 +02:00
Tshepang Mbambo 061577567f use relative links
Used the following command, followed by some manual tweaking:

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

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

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

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

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

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

* line length

* review

* Update src/borrow_check/type_check.md

Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-06-08 14:21:01 -03:00
Jonas Schievink d292267144 Make build scripts and proc macros work with the suggested rust-analyzer config (#1365) 2022-06-08 08:06:32 +09:00
Tshepang Mbambo 6445e007fe improve rustc_interface examples a little (#1362) 2022-06-07 08:42:07 +09:00
Andrew Dona-Couch -- GitHub drop ICE 3552ec5286 Clarify cargo fallback behavior for rustup link (#1273) 2022-06-07 08:37:50 +09:00
Yuki Okushi 388142f167 Update rustc-driver related examples 2022-05-30 13:57:16 +02:00
Yuki Okushi f2a18eae27 Triage some date references related to traits 2022-05-27 21:40:59 -07:00
Yuki Okushi de938b00e2 Cleanup rustdoc-internals 2022-05-24 17:15:35 -07:00
Yuki Okushi d8eea06af3 Fix some wording on the "Incremental Compilation In Detail" page 2022-05-24 16:03:20 -07:00
Eric Huss 7d8e3fd2cd Add note about patching dependencies and warnings. (#1354) 2022-05-21 12:53:51 +09:00
Tshepang Lekhonkhobe 8b5f9d119a make sentence more simple (#1353) 2022-05-20 21:37:01 +09:00
Yuki Okushi 6ec2a84d4d Update some links and docs (#1340) 2022-05-17 07:54:45 +09:00
Yuki Okushi 0312fa6b20 Replace a broken YouTube link (#1295) 2022-05-16 11:36:40 -03:00
pierwill bb427216e5 Edit the "Compiler Source Code" chapter (#1307)
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
Co-authored-by: pierwill <pierwill@users.noreply.github.com>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-05-16 21:02:11 +09:00
Eric Huss cb69a95ade Add docs for logging of queries. (#1350) 2022-05-12 13:56:26 +09:00
Waffle Maybe 0c88f29374 Fix configuration names for vscode/r-a (#1352) 2022-05-12 13:56:14 +09:00
Jacob Pratt 824696ffe2 Update docs for deprecated attribute (#1338) 2022-05-12 13:53:26 +09:00
Soroush Zare 6199edef0f Update overview.md (#1351)
Fix minor typo
2022-05-10 09:45:31 -03:00
Yuki Okushi 10a9ba8019 Update date references on parallel-rustc (#1348) 2022-05-09 08:47:50 -05:00
lcnr b7b14a983a mention `WithOptConstParam` (#1346) 2022-05-09 09:19:43 +09:00
Yutaro Ohno f76f69f603 Fix format (#1349) 2022-05-09 09:17:51 +09:00
Ali MJ Al-Nasrawy d331d7ef96 correct type of SubstsRef (#1347) 2022-05-07 09:58:20 +09:00
Who? Me?! 081e290a26 Document ErrorGuaranteed (#1316)
* document ErrorGuaranteed

* Fix typos

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

* Clarify Niko comment

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

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

* Fix lexer crate

* Edit wording

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

* Update src/constants.md
2022-03-22 14:34:21 +01:00
skippy10110 16d33733da update winget install instructions to ensure proper packages are installed (-e for --exact, and full package names to ensure arbitrary packages from the msstore source aren't installed)
fixes #1324
2022-03-14 08:40:37 -07:00
Guillaume Gomez 3782d52fab Add missing rustdoc tests explanations 2022-03-09 12:45:59 -08:00
Chayim Refael Friedman 133100ead7 Fix incorrectly escaped backtick 2022-03-02 12:18:48 -08:00
James Cole 1d9f534e4e Add architecture suggestion for Apple silicon (#1320) 2022-03-01 10:45:24 -06:00
Eric Huss cc3f7c4417 cargo timings has been stabilized (#1319)
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2022-02-27 22:26:00 -06:00
Eric Huss 07d132e805 Add known-bug header. (#1311) 2022-02-24 22:40:58 -06:00
Téo Bouvard 700361ae97 Fix typo (#1315) 2022-02-24 11:27:21 -08:00
Samuel Moelius 34f726b933 Typo (#1313) 2022-02-22 18:22:28 -06:00
Eric Huss 55ee2bb081 instrument-coverage has been stabilized. 2022-02-20 13:59:23 -08:00
Eric Huss d3cc250a1c symbol-mangling-version has been stabilized 2022-02-20 13:59:23 -08:00
pierwill 8484282c52 Fix `Ty` link (#1308) 2022-02-20 12:14:58 -08:00
pierwill 2098ad6059 Edit glossary (#1302)
Add back-ticks to a few terms that appear in code.

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

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

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

* Update tests chapters for review comments.

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

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

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

* Make some other assorted minor cleanups and improvements
2022-01-18 11:09:16 -03:00
Nicholas Nethercote 08019e25d1 Address more review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote 940fbb5f7a Address review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote e3512c8cd8 Streamline "Getting Started" some more.
This is a follow-up to #1279.

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

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

* Improve `x.py setup` docs.

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

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

* Move details about the repository.

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

* Move details about the prereqs.

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

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

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

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

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