Commit Graph

1834 Commits

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

* Update src/const-eval.md

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

* Update src/const-eval.md

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

* more syntax fixes

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

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

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

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

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

* please clippy

* update date-check docs

* accept review suggestion

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

* address review comment

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

* accept review suggestion

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

* address review comment

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

* address review comment

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

* this breaks markdown

* address review comment

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

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

* address review comment

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

* address review comment

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

* accept review suggestion

This was reverted by mistake

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

* address review comment

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

* use a more simple fn

* address review comment

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

Much more clean

* nit

* accept review suggestion

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

* avoid a failed regex

Also, test new shape

* adjust to new regex (which uses named groups)

New regex was introduced by 456008cc35

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

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

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

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

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

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

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

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

* line length

* review

* Update src/borrow_check/type_check.md

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

* Fix typos

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

* Clarify Niko comment

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

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

* Fix lexer crate

* Edit wording

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

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

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

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

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

* Update tests chapters for review comments.

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

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

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

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