Commit Graph

1975 Commits

Author SHA1 Message Date
nils 313e8e913c Add param_env and wording 2023-02-02 10:23:24 +02:00
nils ca4b002450 Expand section basedd on review comments 2023-02-02 10:23:24 +02:00
Nilstrieb 083a9a9d09 Add section on comparing types 2023-02-02 10:23:24 +02:00
Zephaniah Ong 118246c17e Update rustfmt path
As per https://github.com/rust-lang/rust/pull/107297#discussion_r1092764740, the change broke the rust-analyzer config. Hence, changing the docs to match the new path
2023-02-01 18:59:30 -06:00
Tshepang Mbambo 343194d258 fix wrong heading level (#1573) 2023-02-01 07:29:15 +09:00
ozkanonur f0dbe6cec7 fix incorrect position of topic
Right now "Clarification of build command's stdout" topic
shows up under the "Environment Variables" which is not correct.
This commit aims to fix this problem.

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

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

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

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

Co-authored by: @lcnr and @spastorino

* Update src/traits/resolution.md

* Wrapping

* Update src/traits/resolution.md

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

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

* Update src/const-eval.md

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

* Update src/const-eval.md

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

* more syntax fixes

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

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

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

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

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

* please clippy

* update date-check docs

* accept review suggestion

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

* address review comment

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

* accept review suggestion

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

* address review comment

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

* address review comment

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

* this breaks markdown

* address review comment

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

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

* address review comment

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

* address review comment

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

* accept review suggestion

This was reverted by mistake

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

* address review comment

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

* use a more simple fn

* address review comment

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

Much more clean

* nit

* accept review suggestion

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

* avoid a failed regex

Also, test new shape

* adjust to new regex (which uses named groups)

New regex was introduced by 456008cc35

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

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

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

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

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

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

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

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

* line length

* review

* Update src/borrow_check/type_check.md

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

* Fix typos

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

* Clarify Niko comment

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

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

* Fix lexer crate

* Edit wording

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