mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
1,982 Commits 3 Branches 0 Tags 114 MiB
Commit Graph

1787 Commits

Author SHA1 Message Date
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