d1d6ce85e6
Update date reference about infer context variables
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:39:11 +02:00
4597bb4226
Update explnation about `Body.basic_blocks`
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:25:20 +02:00
82e50a669a
Add detail to contributing guide ( #1628 )
2023-03-03 20:14:53 +09:00
62f03c2085
Making the sentence more clear ( #1624 )
2023-03-03 20:13:46 +09:00
b684e3532f
Fixed typing error ( #1623 )
2023-03-03 20:13:18 +09:00
2d0681e13f
update error code docs to reflect recent changes ( #1625 )
2023-03-03 20:12:51 +09:00
b06dab8408
Fixed typing errors ( #1622 )
2023-02-27 07:30:52 +09:00
9d769136ee
this remains true ( #1620 )
2023-02-21 23:12:14 +09:00
a7d960359a
diagnostics: small fixes/improvements ( #1618 )
2023-02-21 22:57:34 +09:00
d01441ded0
typo ( #1616 )
2023-02-21 22:57:16 +09:00
ea01bf508c
typo ( #1617 )
2023-02-21 22:56:16 +09:00
110275f990
keep "grey area" lint summary green ( #1619 )
...
This replaces link to a removed lint with a link to discussion of lints
of its type.
2023-02-20 19:08:35 -06:00
095f27d62a
new solver: write canonicalization chapter ( #1595 )
...
* write canonicalization chapter first half
* w
* review
* very good section
* whatever
* review
* ok
2023-02-20 14:45:25 +00:00
1efd0adb82
bootstrap now creates a usable toolchain when building stage0 std
2023-02-19 13:43:56 +01:00
99b6b92dde
llvm 13 is now not supported ( #1612 )
2023-02-18 22:20:46 +09:00
84b9f4d99a
Vetting deps datecheck ( #1614 )
2023-02-18 22:20:08 +09:00
5173d1fb28
accept review suggestion
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-02-18 14:10:03 +02:00
727941feae
fmt
2023-02-18 14:10:03 +02:00
b328f82882
add Dev Desktops note
2023-02-18 14:10:03 +02:00
8715e8f6e8
fix and clarify llvm bugfix policy ( #1611 )
2023-02-18 20:46:21 +09:00
6f536e44bc
impl review suggestion
...
See https://github.com/rust-lang/rustc-dev-guide/pull/1605#discussion_r1110388310
2023-02-18 05:04:44 +02:00
64f1af18f5
lower-case "Compiler" in headings, for consistency (and looks)
2023-02-18 05:04:44 +02:00
1a721616c9
Explain what the rest of the backend agnostic page is about
2023-02-18 03:54:02 +02:00
1f4d6ac25e
accept review suggestion
...
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2023-02-17 13:38:10 -08:00
4e8110ceb2
address review comment
...
See
- https://github.com/rust-lang/rustc-dev-guide/pull/1606#discussion_r1109298849
- https://github.com/rust-lang/rustc-dev-guide/pull/1606#discussion_r1109298280
2023-02-17 13:38:10 -08:00
ed87804535
rustc_codegen_ssa feels permanent enough not to need date-check
2023-02-17 13:38:10 -08:00
c80a26fc4d
make use of the symlink, to ease things ( #1608 )
2023-02-17 14:37:01 -06:00
fdacc773e0
remove stray text ( #1604 )
2023-02-16 19:33:05 -08:00
df7970bf0d
Typo
2023-02-16 07:26:00 +02:00
4a86a8dd74
Typo
2023-02-16 07:24:32 +02:00
74afdfc2f3
Add link to vscode settings in Rust repo ( #1591 )
2023-02-15 15:46:19 -03:00
d0ee17f100
avoid code duplication by including files in docs ( #1598 )
2023-02-15 11:41:35 -03:00
77aaf99897
Add sample CodeLLDB launch.json ( #1482 )
...
* Add sample CodeLLDB launch.json
There is a section with [instructions for setting up source analyzer in VSCode](https://rustc-dev-guide.rust-lang.org/building/suggested.html#configuring-rust-analyzer-for-rustc ), but
nothing for setting up debugging with CodeLLDB. This adds a sample configuration
that may not be ideal, but appears to work for me.
To source highlight the snippet, uses JavaScript instead of JSON so that comments
do not show up as errors highlighted in red (VSCode allows comments).
* Update src/compiler-debugging.md
Co-authored-by: jyn <github@jyn.dev>
* Update src/compiler-debugging.md
Co-authored-by: jyn <github@jyn.dev>
---------
Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
Co-authored-by: jyn <github@jyn.dev>
2023-02-15 11:31:02 -03:00
c9e4cb704c
typo ( #1600 )
...
Fixes #1599
2023-02-15 11:02:38 -03:00
82257c2705
use actual names ( #1594 )
2023-02-14 15:44:23 +09:00
5eb8171f0b
Fix a typo ( #1597 )
2023-02-14 15:43:48 +09:00
2ab6fbca7c
Add Neovim configuration information ( #1545 )
...
* Add Neovim configuration information
The JSON provided for VSCode works with coc and nlsp-settings.
This is verified by
9d8bdb9290/README.md215b537cfb/schemas/_generated/rust_analyzer.json
2023-02-13 23:16:01 -06:00
df5aee0e60
Improve git submodule help ( #1587 )
2023-02-09 19:08:26 +09:00
33ea559131
update examples for rustc 1.69.0-nightly (e1eaa2d5d 2023-02-06) ( #1590 )
...
Closes https://github.com/rust-lang/rustc-dev-guide/issues/1581
2023-02-09 18:56:06 +09:00
ed5b175ef3
Replace settings.json with x.py setup note ( #1588 )
2023-02-08 14:26:58 -06:00
0591410a01
Fixed small grammar mistake in monomorph.md ( #1585 )
...
Fixes https://github.com/rust-lang/rustc-dev-guide/issues/1584
2023-02-05 17:28:48 +09:00
2d1e71ac8b
update bootstrap guide ( #1583 )
...
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-02-04 16:53:38 -06:00
5c65222d4c
Use host symlink for custom rustup toolchain
2023-02-04 01:01:48 +02:00
d579acb697
Fix broken relative links
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
bf4cdde66b
Address the change in https://github.com/rust-lang/rust/pull/99715
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
860162abfe
Address the change in https://github.com/rust-lang/rust/pull/106718
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
e0074c18f0
Address the change in https://github.com/rust-lang/rust/pull/97287
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
d30be86ea6
Address the change in https://github.com/rust-lang/rust/pull/107256
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
d8c298da43
Update explnation about benchmarks
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
49c93f661f
Add param_env and wording
2023-02-02 10:23:24 +02:00
5db974f386
Expand section basedd on review comments
2023-02-02 10:23:24 +02:00
98cc718964
Add section on comparing types
2023-02-02 10:23:24 +02:00
c97f571561
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
c42c13eba2
fix wrong heading level ( #1573 )
2023-02-01 07:29:15 +09:00
ba809ffab0
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
472188e1b9
extend bootstrap related documentations
...
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-01-31 12:42:30 -06:00
e359ee27fc
New infcx usage ( #1571 )
...
Fixes https://github.com/rust-lang/rustc-dev-guide/issues/1543
2023-01-31 00:08:16 +09:00
4a1d5496d5
Apply suggestions from code review
...
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-01-29 20:58:11 +02:00
54cfdd74e6
Update ast-validation.md
2023-01-29 20:58:11 +02:00
c166632b37
update datecheck
2023-01-27 15:03:01 -08:00
71766d97b0
review
2023-01-27 15:03:01 -08:00
167d22c126
line length
2023-01-27 15:03:01 -08:00
7eaff60278
Update src/solve/canonicalization.md
...
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-01-27 15:03:01 -08:00
9656b8ca34
review
2023-01-27 15:03:01 -08:00
15bd9e49bb
Update src/solve/canonicalization.md
...
Co-authored-by: Boxy <supbscripter@gmail.com>
2023-01-27 15:03:01 -08:00
61771df6d8
fix line lengths
2023-01-27 15:03:01 -08:00
0bcdb56e3a
add section for the new trait solver
2023-01-27 15:03:01 -08:00
f4f78f752c
version 5 is now not supported ( #1568 )
2023-01-27 19:09:37 +09:00
21c77d78d0
there are still no locale bundles ( #1567 )
2023-01-27 07:52:25 +09:00
0e18184ce3
bumpt date-check examples to current month ( #1566 )
2023-01-27 07:51:28 +09:00
b6cc4604d0
Update hir.md
...
Fix method name and the link, as it's outdated.
2023-01-25 17:29:12 +02:00
5ecd75a393
fix review suggestion
2023-01-21 16:12:58 +02:00
757ad6dcb9
accept review suggestion
...
Co-authored-by: lcnr <rust@lcnr.de>
2023-01-21 16:12:58 +02:00
042c49c64e
rustc_typeck exists no more
2023-01-21 16:12:58 +02:00
7d3c1c827e
Correct tests misplacement ( #1564 )
...
Since the tests move, this was not correct anymore.
2023-01-20 11:18:15 -03:00
7313897468
Update resolution.md ( #1561 )
2023-01-18 07:46:14 +09:00
ea33f70d09
Update asm.md ( #1560 )
2023-01-17 21:44:19 +09:00
7352353ae9
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
de053e2975
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
0dc2b03ee3
Link to the youtube recording of my talk, not the summary ( #1554 )
2023-01-13 07:46:15 +09:00
ec0d134e3b
Change `src/test` to `tests` ( #1547 )
2023-01-13 07:31:47 +09:00
e799c10502
add full name for ICE ( #1552 )
...
Co-authored-by: Yuki Okushi <huyuumi.dev+love@gmail.com>
2023-01-11 22:25:53 +09:00
e67f3b8913
Fix incorrect links ( #1549 )
2023-01-10 22:00:49 +09:00
d89d417f2d
fix rebase link
2023-01-10 08:17:59 +02:00
da0a4a0d36
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
b3e2a6e6c8
fix typo
...
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-12-31 23:20:47 -06:00
664346dd7e
Give help for when you update a submodule by accident
2022-12-31 23:20:47 -06:00
ef12db3ecf
Update sentence about LLVM to match the new defaults
2022-12-31 23:20:21 -06:00
51fc2ec1cc
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
f111b885ea
Move "create a config.toml" after the section explaning x.py
2022-12-31 23:20:21 -06:00
fd9a461220
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
8fa9edeccb
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
e6fd600417
Replace `$TARGET` with `host`
...
This avoids having to manually modify the configuration in the docs.
2022-12-31 18:23:52 -06:00
586474f348
Use `origin` consistently and add an example of rebasing over the wrong remote
2022-12-29 11:39:24 -06:00
ba1db24140
Add more rebasing help
2022-12-29 11:39:24 -06:00
54e6f5b535
Fix rustc_borrowck crate name typo ( #1535 )
2022-12-25 21:11:21 +09:00
8b42eb5f57
Apply feedback
2022-12-18 00:41:27 +02:00
a213de4efe
Add -Ztrack-diagnostics information
2022-12-18 00:41:27 +02:00
58077bf772
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
55c2c093dc
typo
2022-12-14 05:34:09 +02:00
4c516b0b3a
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
1cf62ddb2f
Remove todo note
2022-12-14 05:34:09 +02:00
1211eebb71
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
9f3efe646d
share same link
2022-12-08 19:02:08 -08:00
b145e1e1fa
fix: Fix broken links
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-12-09 03:13:38 +02:00
d147c52df4
Remove TyS
2022-12-08 09:06:11 +01:00
d3564ba27b
Fix small inaccuracy in monomorph page
2022-12-06 21:42:57 -08:00
e269950a57
Remove duplicate paragraph ( #1523 )
2022-12-04 08:09:24 +09:00
a7cd86425d
clarify subtree tool policy ( #1518 )
2022-12-03 09:32:00 +09:00
c4e632eb14
Typo ( #1520 )
2022-12-03 09:02:26 +09:00
96462f2d9f
Fix broken link
...
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-11-28 19:00:24 -08:00
fa3ffbfcca
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
af134d2f6f
Link directly to the section on `--keep-stage`
2022-11-28 19:00:24 -08:00
e85c4c460d
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
2889c292cb
Triage some date-check items ( #1513 )
2022-11-26 22:25:58 +09:00
0bd5bd1d68
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
32bc13e408
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
f98f1e5b86
updating-llvm: keep a calm tone ( #1449 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-11-20 15:19:50 +09:00
6f3d5e4b00
date-check: updating-llvm ( #1424 )
2022-11-20 12:55:18 +09:00
36e15ae1dd
Update src/type-inference.md
...
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2022-11-10 23:27:01 +02:00
39c10de06f
extract regions
2022-11-10 23:27:01 +02:00
7354b42b73
Consistent ordered list indexing
2022-11-09 10:39:06 +02:00
01a51b2282
Document multiple alternative suggestions on diagnostic structs ( #1486 )
2022-11-09 06:35:38 +09:00
d0dc6c97a6
trans -> codegen
2022-11-07 16:49:22 +02:00
63b45c3d94
Remove implementation details
2022-11-05 10:44:35 -05:00
090bd5422d
Update some more things and improve wording
2022-11-05 10:44:35 -05:00
087224159e
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
2bdb02c587
replace tabs with spaces ( #1504 )
2022-11-05 12:32:16 +09:00
43e41174c0
align code blocks with their paragraphs
2022-11-04 03:49:25 +02:00
a6c35fc69e
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
03fe2d4163
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
94ecbac3cd
trans -> codegen ( #1500 )
2022-10-31 13:51:42 -03:00
88bd6ca6ab
add note for err annotation formatting
2022-10-27 20:45:40 +02:00
bd8eeff467
Remove `--bless` from pre-push hook suggestion
...
According to 8873e33806
2022-10-27 20:36:34 +02:00
7f426da358
Update for highfive transition.
2022-10-27 06:07:59 +02:00
51a37ad19a
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
6686b1e95e
Update diagnostics to flat fluent message paths
...
As implemented in rust-lang/rust#103345
2022-10-25 14:36:52 +01:00
a26247697e
Update rust-analyzer suggestions ( #1487 )
2022-10-24 19:41:55 +09:00
0a2f713d86
miri is no longer a submodule but a subtree. ( #1488 )
2022-10-23 08:17:08 +09:00
736fcb998c
fix some links ( #1490 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-10-22 19:53:46 +09:00
a8ccc266a0
typo and grammar ( #1484 )
2022-10-19 07:45:49 +09:00
e68dfb8e88
Add missing prerequisite for some Linux distros ( #1481 )
2022-10-12 08:52:48 +09:00
7518c3445d
Update debugging.md
2022-10-08 12:29:47 +02:00
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
0932ad6bc3
fix very minor punctuation typo
2022-10-05 17:39:50 +02:00
57a38adb6e
diagnostic structs: derive on enum ( #1477 )
2022-10-05 20:22:46 +09:00
d3ce60f3d6
Update running tests with the new flags ( #1476 )
2022-10-05 17:04:49 +09:00
b8228e982e
Rename typeck to hir_analysis ( #1475 )
...
Co-authored-by: mejrs <>
2022-10-04 21:22:00 +09:00
882921a257
fix typo and make paragraph consistent ( #1474 )
2022-10-03 19:38:52 +09:00
de718129ec
Update about-this-guide.md
2022-10-02 20:06:43 +02:00
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
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
7743f0fca3
don't refer to the compile-time interpreter as "Miri" ( #1471 )
2022-09-26 18:07:23 +09:00
1c79085f41
UPDATE - Diagnostic docs to reflect renamed traits and macros in rustc PR#101558
2022-09-22 10:29:32 +01:00
f349ee1a66
Fix some typos
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-09-22 10:45:25 +02:00
f587d6e7cd
Update stability guide to use CURRENT_RUSTC_VERSION ( #1468 )
2022-09-20 07:43:59 +09:00
1f8cda6270
Add a note about building `rust-analyzer-proc-macro-srv` ( #1467 )
2022-09-19 15:50:02 +09:00
39612f963a
Link from "implementing to new features" to mcp.md ( #1465 )
2022-09-16 07:06:59 +09:00
b21b0bb5f3
remove stray **
2022-09-14 09:09:28 -07:00
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
290ecb9082
fix typos and formatting
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-09-12 18:48:21 -05:00
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
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
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
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
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
a5363fb536
Fix typo ( #1459 )
2022-09-09 10:50:44 +09:00
5be5475b07
Document multipart_suggestion derive on SessionSubdiagnostic
2022-09-05 10:59:20 +01:00
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
6b0a155162
Update for removal of RLS ( #1450 )
2022-09-02 23:03:15 +09:00
04892c1a6f
Fix the link to `Parser` struct
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-08-29 20:07:51 +02:00
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
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
b5a632f462
Refine the lintstore section ( #1429 )
2022-08-27 14:59:56 +09:00
daca4683bb
typo
2022-08-27 06:25:51 +02:00
2bf1b9a32e
Updates text to refer to LLVM documentation.
2022-08-27 06:25:51 +02:00
20e571f6b2
Updates LLVM prereqs since upgrade to C++17.
2022-08-27 06:25:51 +02:00
94a29d4b46
we got 3 ( #1447 )
2022-08-27 00:34:44 +09:00
8ba0403073
A few corrections
2022-08-26 06:18:21 +02:00
d7832dbb5d
Update some statements
2022-08-26 06:18:21 +02:00
1be023c319
correct typo in parallel-rustc.md
2022-08-26 06:18:21 +02:00
a240e521fe
Correct some statements in parallel-rustc.md
2022-08-26 06:18:21 +02:00
9c9882c3e1
update parallel-rustc.md
2022-08-26 06:18:21 +02:00
1e7fe14eea
update thir output ( #1445 )
2022-08-25 07:45:53 +09:00
18fc34b37d
do not offer option to run code ( #1442 )
2022-08-23 07:46:35 +09:00
c2371dae0c
Document changes introduced by kind-less SessionDiagnostics
2022-08-21 08:49:30 -07:00
0a613525dc
diagnostics: fix outdated use of string slugs ( #1436 )
2022-08-19 10:47:58 +01:00
f3fe248549
Add missing lifetime ( #1439 )
...
* fix incorrect #[note] syntax
* more syntax fixes
* add missing lifetime
2022-08-18 17:53:51 -07:00
0a80e53608
more syntax fixes
2022-08-18 22:41:51 +00:00
9334d59398
fix incorrect #[note] syntax
2022-08-18 22:11:03 +00:00
2512667781
Update slug style to use _ instead of - ( #1426 )
2022-08-17 23:16:44 +01:00
47c8189d5c
remove incorrect info ( #1435 )
2022-08-17 19:33:13 +09:00
8ee1ff5a9e
fix lifetime name ( #1431 )
2022-08-17 19:29:27 +09:00
04e1702ebc
Update the date reference around Git submodule bug ( #1430 )
2022-08-17 17:07:40 +09:00
d3daa1f28e
Improve the "Diagnostic items" chapter ( #1427 )
2022-08-13 10:00:38 +09:00
452b5abdd6
date-check: crates-io
2022-08-11 08:13:27 +02:00
24de0faa96
fix/improve compiler-debugging
2022-08-10 23:27:09 +02:00
4c39d333c4
Update src/compiler-debugging.md
2022-08-10 09:23:51 -05:00
af80d31f49
add gdb tips for symbol-mangling-version
2022-08-10 09:23:51 -05:00
f979af65e0
move references down to avoid clutter ( #1420 )
...
Also, make link to upstream llvm repo clickable
2022-08-09 14:52:46 -07:00
df1743281f
Fix legend colors in dark mode
2022-08-09 16:47:22 -05:00
81a4d04bcd
Add color for downloaded nodes
2022-08-09 16:44:20 -05:00
c1c84d67f8
Add colors to diagram
2022-08-09 16:44:20 -05:00
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
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
e305a42eb6
note is now too old to be relevant
2022-08-08 15:15:15 +02:00
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
2022-08-02 13:50:32 -07:00
04f3cf0bb2
address review comment
...
https://github.com/rust-lang/rustc-dev-guide/pull/1402#discussion_r933905339
2022-07-31 07:46:57 +02:00
3678b505cb
accept review suggestion
...
Co-authored-by: Joshua Nelson <github@jyn.dev>
2022-07-31 07:46:57 +02:00
338907471d
try address review comments
2022-07-31 07:46:57 +02:00
d9596c6b3a
summary of chapter
2022-07-31 07:46:57 +02:00
6f97f451b8
Update src/building/compiler-documenting.md
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-31 07:46:57 +02:00
67af5ca978
revamp doc-build chapter
2022-07-31 07:46:57 +02:00
ea7e58a0e6
minor fixes
2022-07-30 19:54:34 -04:00
7955bb399f
Prefer relative links
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
637ebaa545
Fix the link to clippy docs
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
bbbd60d245
Fix the link to `ResolverAstLowering`
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
18fa8fb103
Fix the link to `ProcMacro` trait
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
c0b491ee43
Fix the link to `Lazy<T>`
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
30a4d2b134
Add instructions to fix build errors in std after adding a new target
2022-07-29 17:13:46 -04:00
e5e5a9b861
Document how to build a cross-compiler
2022-07-26 11:07:55 -04:00
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
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
d5201cddac
Debuginfo tests now also support revisions.
2022-07-21 04:48:49 +02:00
bac43d0fdb
Link to rendered book directly
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-19 15:58:55 +02:00
5c8febd8cb
Fix link to clippy sync docs
2022-07-19 15:58:55 +02:00
2b87b31676
remove stray markup
2022-07-19 09:56:55 +02:00
6e1ac9dd04
renamed
2022-07-19 09:56:55 +02:00
0c2f5c9b77
sync with hackmd version
...
See https://hackmd.io/5t8pLdJcRDmqbfN9ZXje3g
2022-07-19 09:56:55 +02:00
2802da7b37
replace misleading name ( #1401 )
2022-07-19 15:56:24 +09:00
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
168442374d
obey line length limit (part 3)
2022-07-17 23:34:12 +02:00
1b62c12bbe
obey line length limit (part 2)
2022-07-17 23:34:12 +02:00
5cc90f3ab1
obey line length limit
2022-07-17 23:34:12 +02:00
857ee492fc
sync with hackmd
2022-07-17 23:34:12 +02:00
53395b0e3d
add draft chapter
2022-07-17 23:34:12 +02:00
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
56eb8b69b5
fix some typos ( #1398 )
2022-07-17 06:45:36 +09:00
8bbee4f5a3
typo: monomorph docs
2022-07-16 16:44:10 +02:00
2e754ba3d7
Rename debugging_opts to unstable_opts, use link
2022-07-16 12:56:25 +02:00
0eb86d9bfe
address review comment
...
https://github.com/rust-lang/rustc-dev-guide/pull/1392#discussion_r921560851
2022-07-15 13:24:50 +02:00
7a99011947
update date reference on MIR inliner
...
cc #1379
2022-07-15 13:24:50 +02:00
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
4a96ed5165
small fixes to ty chapter ( #1390 )
2022-07-15 15:47:42 +09:00
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
8accea6a9d
overview.md: Link to existing Macro Expansion and Name Resolution docs ( #1388 )
2022-07-08 12:55:38 -05:00
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
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
eb83839e90
Suggest a separate build directory for rust-analyzer ( #1378 )
2022-07-03 15:17:39 +09:00
ef73d033d6
Change the old filename, "src/stage0.txt" to "src/stage0.json" ( #1383 )
2022-07-03 15:10:25 +09:00
d955bab63c
Add the config needed to get rust-analyzer working on src/bootstrap ( #1381 )
2022-07-03 15:06:54 +09:00
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
f423a3ad95
leave formatOnSave to the user ( #1380 )
2022-07-02 00:35:13 +09:00
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
03fafb5d85
Few readability fixes
2022-06-27 02:41:09 +02:00
4505f706b1
humorust: Forbid pineapple on pizza ( #1374 )
2022-06-26 21:02:21 +09:00
048d925f0a
not obvious what Ex is, so rather get rid ( #1372 )
2022-06-21 22:25:34 +09:00
a3d2f90481
small improves ( #1371 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-06-21 18:45:30 +09:00
12a613eddb
make clear that other versions can work ( #1373 )
2022-06-21 13:26:19 +09:00
bda3e0b23c
Fix small `src/diagnostics.md` typo ( #1370 )
2022-06-18 19:42:08 +09:00
cddd59fff8
Add an "is" and rearange "We next" to "Next, we" ( #1369 )
2022-06-18 12:31:49 +09:00
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
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
ee64179f12
later -> latter
2022-06-13 00:17:41 +02:00
375a9f06e3
Remove mention of -Zborrowck=mir with Polonius. ( #1367 )
2022-06-08 19:30:43 -03:00
e83cd73692
Remove nll compare mode. ( #1366 )
2022-06-08 14:21:15 -03:00
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
6e4d6435db
Make build scripts and proc macros work with the suggested rust-analyzer config ( #1365 )
2022-06-08 08:06:32 +09:00
438364838a
improve rustc_interface examples a little ( #1362 )
2022-06-07 08:42:07 +09:00
4d43651c90
Clarify cargo fallback behavior for rustup link ( #1273 )
2022-06-07 08:37:50 +09:00
a206009f26
Update rustc-driver related examples
2022-05-30 13:57:16 +02:00
669262932a
Triage some date references related to traits
2022-05-27 21:40:59 -07:00
554c00e480
Cleanup rustdoc-internals
2022-05-24 17:15:35 -07:00
5e268730e0
Fix some wording on the "Incremental Compilation In Detail" page
2022-05-24 16:03:20 -07:00
0cd9842821
Add note about patching dependencies and warnings. ( #1354 )
2022-05-21 12:53:51 +09:00
12a2e08f72
make sentence more simple ( #1353 )
2022-05-20 21:37:01 +09:00
0b2c9db969
Update some links and docs ( #1340 )
2022-05-17 07:54:45 +09:00
b389adccc1
Replace a broken YouTube link ( #1295 )
2022-05-16 11:36:40 -03:00
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
b24d550239
Add docs for logging of queries. ( #1350 )
2022-05-12 13:56:26 +09:00
77f7fa259f
Fix configuration names for vscode/r-a ( #1352 )
2022-05-12 13:56:14 +09:00
687f6036ca
Update docs for deprecated attribute ( #1338 )
2022-05-12 13:53:26 +09:00
0c02acdb6f
Update overview.md ( #1351 )
...
Fix minor typo
2022-05-10 09:45:31 -03:00
425fa202c8
Update date references on parallel-rustc ( #1348 )
2022-05-09 08:47:50 -05:00
e4ce969bea
mention `WithOptConstParam` ( #1346 )
2022-05-09 09:19:43 +09:00
a9d0e35c84
Fix format ( #1349 )
2022-05-09 09:17:51 +09:00
2de8cb5dab
correct type of SubstsRef ( #1347 )
2022-05-07 09:58:20 +09:00
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
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
e827b0aaa1
Update some date refs
2022-04-20 13:09:19 -07:00
043e60f4f1
Fix a small typo ( #1343 )
2022-04-20 18:57:49 +09:00
a8add664d4
Extend debugging llvm section ( #1290 )
2022-04-14 20:17:36 +09:00
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
aa31b10161
Fix typo serious->series ( #1336 )
2022-04-14 19:46:54 +09:00
e58b4c04cb
Minor type fix ( #1337 )
2022-04-14 19:44:36 +09:00
d9bfa3788c
sessiondiagnostic: translation ( #1333 )
2022-04-14 14:57:32 +09:00
eeb5a83c15
method-lookup.md improvements ( #1296 )
2022-04-11 23:29:48 +09:00
885d329928
Consolidate crates.io convention section ( #1326 )
2022-04-11 22:51:22 +09:00
664d3c70c0
r-a: Use `python3 x.py` instead of `./x.py` ( #1335 )
2022-04-09 17:31:23 +09:00
f5f6b4f2be
Update miri.md: correct a minor typo ( #1334 )
2022-04-06 07:47:46 +09:00
127abaa937
Add example how lints can be feature gated
2022-04-04 13:16:08 -07:00
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
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
4b8d939889
Add missing rustdoc tests explanations
2022-03-09 12:45:59 -08:00
eb90c9c25a
Fix incorrectly escaped backtick
2022-03-02 12:18:48 -08:00
32f2a5b4e7
Add architecture suggestion for Apple silicon ( #1320 )
2022-03-01 10:45:24 -06:00
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
24e474c276
Add known-bug header. ( #1311 )
2022-02-24 22:40:58 -06:00
9e2cdee5b3
Fix typo ( #1315 )
2022-02-24 11:27:21 -08:00
e798dc49d7
Typo ( #1313 )
2022-02-22 18:22:28 -06:00
d335c9c2bb
instrument-coverage has been stabilized.
2022-02-20 13:59:23 -08:00
eefbde504f
symbol-mangling-version has been stabilized
2022-02-20 13:59:23 -08:00
5483b27923
Fix `Ty` link ( #1308 )
2022-02-20 12:14:58 -08:00
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
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
2c9be18076
Fix link
2022-02-17 13:30:24 -08:00
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
5e38eb64bf
Link to The Rust Performance Book ( #1300 )
2022-02-17 17:46:20 -03:00
62f58394ba
Correction, building stage3 compiler ( #1298 )
2022-02-11 08:42:50 -05:00
d1822b9998
Triage some date references ( #1293 )
2022-02-10 17:34:23 -03:00
dc47b51114
mention test folders for cfg(bootstrap) ( #1294 )
2022-02-05 15:03:17 +09:00
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
341abec62a
Clarify that r? works in comments.
2022-01-20 18:01:07 -08:00
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
4d46bd0c95
Add inline assembly internals ( #1266 )
2022-01-18 11:12:06 -03:00
60bc9abf72
Spelling: Rename `rust` to `Rust` ( #1288 )
2022-01-18 11:09:37 -03:00
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
18b93ae2ee
Address more review comments in #1286 .
2022-01-05 23:26:43 -06:00
acc6718c51
Address review comments in #1286 .
2022-01-05 23:26:43 -06:00
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
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
f6a190e709
Fix link in contributing.md ( #1280 )
2021-12-27 10:28:15 -06:00
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
9bf0028b55
remove rustfix item in test intro ( #1277 )
2021-12-20 21:53:57 +09:00
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
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
5dd756bceb
Fix some broken links ( #1274 )
2021-12-13 15:16:30 +09:00
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
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
6c1f5c780b
Fix some broken links
2021-12-09 09:11:48 -06:00
0c0e4f2e44
Update src/getting-started.md
...
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-12-09 09:09:36 -06:00
3df5cc9fe5
Improve documentation on r?
2021-12-09 09:09:36 -06:00
a374e7d8bb
Update LLVM coverage mapping format version supported by rustc ( #1267 )
...
rust-lang/rust#91207 updates the coverage mapping format to Version 5 or
6, depending on the built-in version of LLVM (12 or 13, respectively).
This change updates the dev guide to match the recent changes.
2021-12-03 09:26:47 -08:00
2cee5a9be8
Improve 'Running tests manually' section
2021-11-27 03:45:39 -05:00
c4776cb94a
Fix some links
2021-11-24 10:23:07 -05:00
8a817bc6ca
Update for review comments.
2021-11-24 10:22:37 -05:00
aaf6ccc951
Document rustfix-only-machine-applicable
2021-11-24 10:22:37 -05:00
9660c153fe
Apply suggestions from pierwill
...
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-11-24 10:22:37 -05:00
285b3e4410
Document more compiletest headers.
2021-11-24 10:22:37 -05:00
a2fc963502
Describe drop elaboration ( #1240 )
2021-11-18 13:31:13 -05:00
5fbfe9363d
Fix an invalid link on Diagnostic Items ( #1261 )
2021-11-16 10:45:40 -03:00
766f9d7b10
Fix broken links related to `rustc_borrowck` ( #1259 )
...
* Fix broken links in region_inference.md
* Fix broken links in lifetime_parameters.md
2021-11-16 10:43:17 -03:00
24132faa13
Unify `x.py` usage ( #1258 )
2021-11-16 07:44:50 +09:00
0fc1fa9f1e
Spelling fixes
2021-11-15 08:23:01 -06:00
f1297f5560
Fix compare-mode documentation
2021-11-14 17:01:35 -06:00
6b9c8ae1a8
Fix broken link in "Bootstrapping"
...
The italics added in #1239 broke the implicitly-resolved link.
2021-11-09 21:46:27 -06:00
196ef69aa6
Fix typo: [upv.rs_mentioned] -> [upvars_mentioned]
2021-11-07 07:48:47 -06:00
ffcc6297c6
Add note to emphasize replacing TARGET_TRIPLE ( #1250 )
2021-11-06 18:32:55 +09:00
8a8452cfcc
Remove some legacy test suites.
2021-11-04 14:18:39 -05:00
a034fad804
tiny capitalization fix
2021-11-04 14:15:06 -05:00
2ad51b6d75
Fix date
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-11-04 09:33:03 -07:00
f146da3734
Update some date-check comments
...
I removed one of them because it doesn't seem necessary.
2021-11-04 09:33:03 -07:00
292072d8e2
enhance subtree docs, link to clippy docs
2021-11-02 20:09:23 -05:00
0f69d33e16
Edit introduction to bootstrapping
...
Use paragraphs instead of bullet-points.
Edits throughout for clarity.
Use semantic line breaks in edited sections.
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-11-02 15:06:56 -05:00
70966e597f
Some minor adjustments to the diagnostic documentation
2021-10-29 21:51:05 -05:00
f3fb373be9
Edit "About this guide" for semantic line feeds
...
This is work toward #1241 .
2021-10-28 15:30:08 -05:00
ddaebd85aa
Fix `rustc_mir` related links ( #1228 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: nhamovitz <18648574+nhamovitz@users.noreply.github.com>
2021-10-29 00:58:26 +09:00
68dbb4501d
Add documentation for LLVM CFI support
...
This commit adds initial documentation for LLVM Control Flow Integrity
(CFI) support to the Rust compiler (see rust-lang/rust#89652 and
rust-lang/rust#89653 ).
2021-10-27 08:55:16 -05:00
87968b466f
Describe how to trigger perf runs ( #1237 )
2021-10-22 01:00:27 +09:00
4ff071741a
Remove docs on Assemble step ( #1233 )
2021-10-18 02:17:19 +09:00
fba15a46ca
Update some docs from 2021-10 date triage ( #1230 )
2021-10-12 08:52:21 +09:00
ceec906a31
Recommend `rustfmt --edition=2021`
2021-10-10 08:28:12 -05:00
afbcc3efa9
Update sanitizer documentation
2021-10-08 15:49:53 -05:00
cec5879a86
Mention needs-sanitizer-hwaddress directive
2021-10-08 15:49:53 -05:00
72906c9bed
Address review comments
2021-10-08 15:41:06 -05:00
dc16b5293b
Document tracing awesomeness
2021-10-08 15:41:06 -05:00
013c8892dd
Move log/tracing instructions to its own file
2021-10-08 15:41:06 -05:00
0cff8fbeec
Update src/closure.md
...
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-10-07 17:48:12 -05:00
67faab2aa2
Fix accidental HTML tag
...
The markdown parser was interpreting the `<something>` in `adjust_upvar_borrow_kind_for_<something>` as an HTML tag that was hidden in the rendered text. This minor edit fixes that.
2021-10-07 17:48:12 -05:00
b71e9792c7
Update links to `rustc_mir` in Two Phase Borrows ( #1226 )
...
https://github.com/rust-lang/rust/pull/80522 split the `rustc_mir` crates into 5 crates, effectively invalidating all the direct links to `rustc_mir` in the docs.
I found this while looking at the Two Phase Borrows doc, which is why I am giving out this PR to fix this.
2021-10-06 09:07:51 -03:00
b5b3c0aa04
Update some docs from 2021-10 date triage ( #1224 )
2021-10-05 17:24:24 -03:00
d1f03cbaa3
Fix a typo on closure.md ( #1218 )
2021-09-24 12:00:29 +09:00
82d4c5604d
const generics update
2021-09-20 12:35:16 -05:00
17957567f7
s/--blessed/--bless/
2021-09-19 10:36:26 -05:00
56f6bdbb70
Make indentation consistent in example vscode config file
2021-09-17 16:52:56 -05:00
60ef9da723
Suggests `--edition=2018` argument when using stage0/bin/rustfmt directly
2021-09-17 14:53:44 -05:00
09bf2bd2df
`ty::Unevaluated`: dealing with unused substs ( #1190 )
...
* unused ct substs
* q
* q
* Update src/constants.md
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2021-09-17 15:50:26 -04:00
8c39edb660
Parallel codegen ( #1206 )
...
* Described underlying data structures in parallel code generation and crates they are used in
* Added links
* replace crate information with description of types
2021-09-16 20:58:07 -05:00
9198465b6c
Clarify difference of a help vs note diagnostic.
2021-09-12 11:50:44 -05:00
295922ec93
remove ctag section
2021-09-08 15:13:44 -05:00
8f98dac74d
Update suggested.md
2021-09-08 15:13:44 -05:00
d1f77858e7
Update SUMMARY.md
2021-09-08 15:13:44 -05:00
fb62bc398f
Move ctag section to "Suggested Workflow"
2021-09-08 15:13:44 -05:00
5b607d9862
Delete ctags.md
2021-09-08 15:13:44 -05:00
9a42b37519
Clarify paragraph in "Keeping things up to date"
2021-09-08 12:36:10 -05:00
0cc70fcaf1
Docs: added section on rustdoc
2021-09-07 11:08:38 -05:00
0eb2c70cf5
Docs: made suggested fix
2021-09-07 11:08:38 -05:00
1df026246a
Docs: deleted copy
2021-09-07 11:08:38 -05:00
c31ec83e91
Docs: added section discussing core ideas
2021-09-07 11:08:38 -05:00
78afd53e8a
Docs: delete redundant use of correctness
2021-09-07 11:08:38 -05:00
0fe44f730b
Docs: consolidated parallelism information
2021-09-07 11:08:38 -05:00
71d88b345f
Add links to overview.md ( #1202 )
2021-09-06 18:34:16 -03:00
a5dea10a46
Spelling change intermidiate to intermediate
...
Very importent change.
2021-09-05 12:11:19 -05:00
30826ca7d8
Fix a typo ( #1200 )
2021-09-05 09:40:35 -03:00
139b8fb11b
Documenting diagnostic items with their usage and naming conventions ( #1192 )
...
* Documenting diagnostic items with their usage and naming conventions
* Fixed typos in diagnostic items documentation
Co-authored-by: Camelid <camelidcamel@gmail.com>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-09-01 11:26:58 -07:00
95f1acf9a3
Add link to `Span`
2021-08-31 12:38:30 -05:00
9be3fafda6
Add rustc-source to suggested rust-analyzer config ( #1189 )
...
This allows loading the sources for crates loaded from the sysroot.
2021-08-31 10:13:18 -07:00
fa6a787cfd
Fix typo, clarify backtick wording, and use inline code
2021-08-31 12:08:01 -05:00
2f447292ff
Trailing date comments in a line inside of a paragraph caused beginning of a new paragraph. ( #1196 )
...
This PR fixes the 2 occurrences of that.
(I'm not sure if there's an underlying issue with mdbook or if this is working as intended.)
2021-08-28 08:26:16 -03:00
0e5be8a943
Fix a code block containing ```rust
...
This wasn't displayed correctly.
Changing `` ```rust `` to `` ```rust`` made it a code block again,
but the leading space was rendered as-well.
(This may be an issue in mdbook, but I'm not sure.)
This commit changes it to use HTML-syntax in order to get the desired result.
2021-08-27 15:13:38 -05:00
cf0e151b79
Fix typo “a Rc” → “an Rc” ( #1191 )
2021-08-22 11:47:02 -03:00
77a9813ae0
Expand THIR section with more details ( #1183 )
...
* Expand THIR section with more details
* Remove incorrect reference to `HirId`s
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-08-21 19:55:56 -04:00
9a6bd9fc98
Remove docs for old -Z profile-queries flag
2021-08-16 08:20:03 -05:00
c4644b427c
Remove a dead link in `new-target.md` + other nits ( #1186 )
2021-08-10 20:41:44 +09:00
e218184b68
Add description of -opt-bisect-limit LLVM option ( #1182 )
2021-08-07 10:12:22 +02:00
809f4d1d33
Fixed team responsible for stabilization ( #1181 )
2021-08-05 13:41:16 +02:00
d111b3ea7e
Add S-Inactive PRs as another source of things contributors could work on ( #1177 )
2021-07-29 06:05:19 +02:00
f094672828
git.md: Fix No-Merge Policy link
2021-07-28 09:45:23 -04:00
09343d6f92
Fix typo in building/bootstrapping.md ( #1175 )
2021-07-26 00:37:28 +02:00
f2c4bba539
Link directly to stabilization report comments ( #1173 )
...
Previously, readers had to scroll through tons of comments to find the
report.
2021-07-20 17:39:41 -07:00
93422c21ba
Update for merge of CrateDisambiguator into StableCrateId
2021-07-13 12:45:58 -04:00
1b56b09472
Minor capitalization fix ( #1170 )
2021-07-08 01:27:47 +02:00
60e2825591
Fixed typos in inline code
2021-07-05 11:21:03 -04:00
33c1eff45e
Document lang items ( #1119 )
...
* Document lang items
* Apply suggestions from code review
Co-authored-by: Camelid <camelidcamel@gmail.com>
* Add an example of retrieving lang items
* Add two missing words
* Fix line lengths
Co-authored-by: Mikail Bagishov <bagishov.mikail@yandex.ru>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-07-05 08:34:33 +02:00
1a51a21243
More specifics on what future-incompatible lints are used for
2021-07-04 23:21:24 -04:00
c3c110f107
Fix line lens
2021-07-04 23:21:24 -04:00
9636fa92ab
Update information on lints particularly on future-incompatible
2021-07-04 23:21:24 -04:00
a4e29c5cb5
Update section of lint store
2021-07-04 23:21:24 -04:00
442ba10f1e
Update around half of the January 2021 date references ( #1155 )
2021-07-02 10:43:34 +02:00
ea66b238e4
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
84779866ff
Links from rustc-dev-guide to std-dev-guide ( #1152 )
2021-07-01 13:19:06 +02:00
c319110e8d
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
48d01f867d
Remove requests or suggestions about rebase and fixup contradictory to rust-highfive bot comment ( #1111 )
2021-06-25 01:50:50 +09:00
a1ed0ddbc4
Generate glossary table correctly ( #1146 )
...
Co-authored-by: Yuki Okushi <yuki.okushi@huawei.com>
2021-06-24 13:57:37 +09:00
8fcb613cac
Correct the wrong serial number ( #1147 )
2021-06-23 15:14:09 +09:00
fe34beddb4
Update "Inference variables" section ( #1145 )
2021-06-21 21:50:12 +02:00
a58da1ba0d
Document how to run unit tests ( #1141 )
2021-06-17 17:25:28 -03:00
be1d3c4dd4
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
3a63b1296e
Change the feature used as an example of stabilizing lib features ( #1143 )
2021-06-15 05:57:10 +09:00
c3ac40dc23
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
6e4f0cbe1b
Add suggested settings note for coc ( #1144 )
2021-06-13 01:17:06 +09:00
8608047fb2
move 7/8 to prose
2021-06-09 14:43:20 -04:00
072657e0a5
Add a section on keeping things up to date in the git section
2021-06-09 14:43:20 -04:00
c8da5bfd1c
Fix some links ( #1137 )
...
* Fix some links
* Address review comment
2021-06-04 09:08:56 +02:00
78204563e2
explain Miri engine vs Miri-the-tool
2021-05-30 02:18:51 +02:00
70e979a519
Add more information about no_hash query modifier. ( #1133 )
2021-05-28 17:23:27 +02:00
f6f83e2fae
improve section introduction
2021-05-26 06:24:44 -04:00
99e60b3302
not all tools require waiting for a nightly release before they can be fixed
2021-05-26 06:24:44 -04:00
12f9ede977
Describe the difference of rustc_lint vs rustc_lint_defs.
2021-05-25 21:37:21 -04:00
50de7f0682
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
Yuki Okushi
apiraino
Mika
Ezra Shaw
Tshepang Mbambo
lcnr
The 8472
Noah Lev
Michele
clubby789
AE1020
Christopher Smyth
jyn
Hiroki Fujino
Ciel
Onur
Nixon Enraght-Moony
nils
Zephaniah Ong
Denis Belik
Yang Pan
Albert Larsan
gftea
Albert Larsan
Mu00
oskgo
Joshua Nelson
Dan Mezhiborsky
mejrs
Ramon de C Valle
Mohammad Omidvar
Oli Scherer
Jared Harp
Anirudh S
Ralf Jung
Samuel Moelius
Ghassan Gedeon Achi
RCoder01
Xiretza
jonathanCogan
Jhonny Bill Mena
Santiago Pastorino
Rageking8
Chris Denton
Eric Huss
Michael Goulet
Lukas Wirth
Luqman Aden
Sergio de Carvalho
Marc Poulhiès
Joshument
David Wood
Pietro Albini
Bruno Kolenbrander
Alex Saveau
Waffle Maybe
Felix S Klock II
Oli Scherer
Devin Jeanpierre
Eric Holk
Samyak Sarnayak
est31
Micah Weston
SparrowLii
Nathan Stocks
est31
yukang
Urgau
bstrie
ridwanabdillahi
Amos Wenger
Amos Wenger
HackMD
Niko Matsakis
davidrusu
5225225
Martin Nordholts
Yutaro Ohno
Daniel Xu
EdwinRy
Alcaro
Omer Tuchfeld
Edwin Rybarczyk
Jonas Schievink
Andrew Dona-Couch -- GitHub drop ICE
pierwill
Jacob Pratt
Soroush Zare
Ali MJ Al-Nasrawy
Who? Me?!
printfn
scottmcm
Frank Steffahn
David Wood
Matthew Woodcraft
Ivor Wanders
Hongbo
xFrednet
skippy10110
Guillaume Gomez
Chayim Refael Friedman
James Cole
Téo Bouvard
Raoul Strackx
Yuki Okushi
Manish Goregaokar
Ivor Wanders
Amanieu d'Antras
Georgiy Komarov
Nicholas Nethercote
Ben Reeves
Wang Qilin
Maxwell Elliot Heiber
Badel2
Jacob Hoffman-Andrews
Lucas Kent
Rich Kadel
Dylan MacKenzie
Ken Matsui
chubei
asquared31415
Dmitry Savintsev
Caleb Cartwright
pierwill
Janggun Lee
Rémy Rakic
Yusuke Abe
Tomasz Miąsko
Dave Farnham
Sl1mb0
Andrey Cherkashin
Dezhi Wu
sjud
Frank Steffahn
Smittyvb
Rahul Butani
Bryan Cantrill
Yoh Deadfall
the8472
Dave
bjorn3
Eric Holk
Joshua Nelson
Ryan Levick
Ryan Levick
Josh Triplett
Jesús Hernández
二手掉包工程师
Jade
Gus Wynn
Michael Woerister
Caleb Cartwright