2848aadbff
Mention debug assertions
2023-03-16 18:40:40 -07:00
f49ec954c5
Address review comments
2023-03-16 18:40:40 -07:00
d09a940816
mir-opt*-level*, not mir-opt
2023-03-16 18:40:40 -07:00
5de7dd6e4f
Address review comments
2023-03-16 18:40:40 -07:00
5531ed7c5e
Add chapter on fuzzing
2023-03-16 18:40:40 -07:00
f946bd407f
Fix "Crate disambiguator" in libs-and-metadata.md
2023-03-16 11:11:46 +02:00
82a5c6d47b
alert when date gets stale (by using date-check annotation)
2023-03-14 05:50:20 +02:00
1ffcb23bbc
fix date-check annotation some more
2023-03-14 05:50:20 +02:00
fa092136c0
fix date-check annotation
2023-03-14 05:50:20 +02:00
ea585370c8
typo
2023-03-14 05:50:20 +02:00
ba285c2370
Update rustdoc-internals.md
2023-03-14 05:50:20 +02:00
31991ba0cb
Rename `config.toml.example` to `config.example.toml`
2023-03-13 04:42:00 +02:00
c5ec776f41
fix typo `SubstRef` to `SubstsRef`
2023-03-12 11:40:45 +02:00
060b7a17dc
improve accuracy
2023-03-10 09:04:21 +02:00
1b7cd1e2bf
tracing log along diff crates
2023-03-10 09:04:21 +02:00
88a1bdd470
Fix Rust Analyzer settings location
...
This file was moved in https://github.com/rust-lang/rust/pull/108618
2023-03-08 00:21:21 +02:00
70e8b3e396
Reflect the changes in rust-lang/rust#67000 ( #1632 )
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-06 14:22:07 -03:00
cee03b4dc3
improve capacity note ( #1634 )
2023-03-06 22:08:37 +09:00
b46fe5900b
Remove mention to lexer/parser refactoring
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:41:21 +02:00
77e9a17a1d
Update date reference about infer context variables
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:39:11 +02:00
d8c874e31b
Update explnation about `Body.basic_blocks`
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:25:20 +02:00
6b2d30b2e5
Add detail to contributing guide ( #1628 )
2023-03-03 20:14:53 +09:00
a5d3282c90
Making the sentence more clear ( #1624 )
2023-03-03 20:13:46 +09:00
30ea647281
Fixed typing error ( #1623 )
2023-03-03 20:13:18 +09:00
25b0c633d5
update error code docs to reflect recent changes ( #1625 )
2023-03-03 20:12:51 +09:00
53e87016e1
Fixed typing errors ( #1622 )
2023-02-27 07:30:52 +09:00
052fe68fb2
this remains true ( #1620 )
2023-02-21 23:12:14 +09:00
1d826b01ef
diagnostics: small fixes/improvements ( #1618 )
2023-02-21 22:57:34 +09:00
ec33573db8
typo ( #1616 )
2023-02-21 22:57:16 +09:00
c7256e75c0
typo ( #1617 )
2023-02-21 22:56:16 +09:00
74a6d8d10a
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
d3bee3c76d
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
54fe64b775
bootstrap now creates a usable toolchain when building stage0 std
2023-02-19 13:43:56 +01:00
45eb9121e0
llvm 13 is now not supported ( #1612 )
2023-02-18 22:20:46 +09:00
c1de1a3127
Vetting deps datecheck ( #1614 )
2023-02-18 22:20:08 +09:00
6db1c189d7
accept review suggestion
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-02-18 14:10:03 +02:00
0086a2d437
fmt
2023-02-18 14:10:03 +02:00
092afc35aa
add Dev Desktops note
2023-02-18 14:10:03 +02:00
bd0f0b77b8
fix and clarify llvm bugfix policy ( #1611 )
2023-02-18 20:46:21 +09:00
a326b2525f
impl review suggestion
...
See https://github.com/rust-lang/rustc-dev-guide/pull/1605#discussion_r1110388310
2023-02-18 05:04:44 +02:00
fcd74f99a3
lower-case "Compiler" in headings, for consistency (and looks)
2023-02-18 05:04:44 +02:00
279f92f50a
Explain what the rest of the backend agnostic page is about
2023-02-18 03:54:02 +02:00
a5046f57db
accept review suggestion
...
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2023-02-17 13:38:10 -08:00
8d9c533ac3
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
fc16473321
rustc_codegen_ssa feels permanent enough not to need date-check
2023-02-17 13:38:10 -08:00
4ccbe9182c
make use of the symlink, to ease things ( #1608 )
2023-02-17 14:37:01 -06:00
19f6cc82a5
remove stray text ( #1604 )
2023-02-16 19:33:05 -08:00
4308463e70
Typo
2023-02-16 07:26:00 +02:00
51aaeee90d
Typo
2023-02-16 07:24:32 +02:00
41680031f8
Add link to vscode settings in Rust repo ( #1591 )
2023-02-15 15:46:19 -03:00
03dd097bb0
avoid code duplication by including files in docs ( #1598 )
2023-02-15 11:41:35 -03:00
1827e0c1b3
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
aba825cf33
typo ( #1600 )
...
Fixes #1599
2023-02-15 11:02:38 -03:00
55c5b384b6
use actual names ( #1594 )
2023-02-14 15:44:23 +09:00
9f02d33a1c
Fix a typo ( #1597 )
2023-02-14 15:43:48 +09:00
b4689c9511
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
2b94321e3d
Improve git submodule help ( #1587 )
2023-02-09 19:08:26 +09:00
342f72310d
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
b4c465275c
Replace settings.json with x.py setup note ( #1588 )
2023-02-08 14:26:58 -06:00
5471f42f11
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
347b3633f1
update bootstrap guide ( #1583 )
...
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-02-04 16:53:38 -06:00
69ef8a3924
Use host symlink for custom rustup toolchain
2023-02-04 01:01:48 +02:00
0e4e3ab221
Fix broken relative links
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
56c7d9f97c
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
6ea7b0db51
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
6213fc1cf5
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
f13eeec25a
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
f663d1aa06
Update explnation about benchmarks
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
313e8e913c
Add param_env and wording
2023-02-02 10:23:24 +02:00
ca4b002450
Expand section basedd on review comments
2023-02-02 10:23:24 +02:00
083a9a9d09
Add section on comparing types
2023-02-02 10:23:24 +02:00
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
343194d258
fix wrong heading level ( #1573 )
2023-02-01 07:29:15 +09:00
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
375adf22dc
extend bootstrap related documentations
...
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-01-31 12:42:30 -06:00
5edc03f6ad
New infcx usage ( #1571 )
...
Fixes https://github.com/rust-lang/rustc-dev-guide/issues/1543
2023-01-31 00:08:16 +09:00
7353fd14ee
Apply suggestions from code review
...
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-01-29 20:58:11 +02:00
914b409125
Update ast-validation.md
2023-01-29 20:58:11 +02:00
ccce1437bc
update datecheck
2023-01-27 15:03:01 -08:00
7a5772a172
review
2023-01-27 15:03:01 -08:00
ba035fb554
line length
2023-01-27 15:03:01 -08:00
020898a81c
Update src/solve/canonicalization.md
...
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-01-27 15:03:01 -08:00
17d68d8412
review
2023-01-27 15:03:01 -08:00
1e2f272560
Update src/solve/canonicalization.md
...
Co-authored-by: Boxy <supbscripter@gmail.com>
2023-01-27 15:03:01 -08:00
f7caa2f553
fix line lengths
2023-01-27 15:03:01 -08:00
9899cf3c43
add section for the new trait solver
2023-01-27 15:03:01 -08:00
ac46c61184
version 5 is now not supported ( #1568 )
2023-01-27 19:09:37 +09:00
c0342ec589
there are still no locale bundles ( #1567 )
2023-01-27 07:52:25 +09:00
710cc3eb66
bumpt date-check examples to current month ( #1566 )
2023-01-27 07:51:28 +09:00
e8b989eb3b
Update hir.md
...
Fix method name and the link, as it's outdated.
2023-01-25 17:29:12 +02:00
e38fa37202
fix review suggestion
2023-01-21 16:12:58 +02:00
8b24a1e9bd
accept review suggestion
...
Co-authored-by: lcnr <rust@lcnr.de>
2023-01-21 16:12:58 +02:00
05d22ebd50
rustc_typeck exists no more
2023-01-21 16:12:58 +02:00
c7064daba1
Correct tests misplacement ( #1564 )
...
Since the tests move, this was not correct anymore.
2023-01-20 11:18:15 -03:00
4583b43b6b
Update resolution.md ( #1561 )
2023-01-18 07:46:14 +09:00
d003669ae5
Update asm.md ( #1560 )
2023-01-17 21:44:19 +09:00
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
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
c154a90ec5
Link to the youtube recording of my talk, not the summary ( #1554 )
2023-01-13 07:46:15 +09:00
d4ec98736e
Change `src/test` to `tests` ( #1547 )
2023-01-13 07:31:47 +09:00
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
2d23cff5fc
Fix incorrect links ( #1549 )
2023-01-10 22:00:49 +09:00
e574dadba0
fix rebase link
2023-01-10 08:17:59 +02:00
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
3b35c4e040
fix typo
...
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-12-31 23:20:47 -06:00
3093967547
Give help for when you update a submodule by accident
2022-12-31 23:20:47 -06:00
a1418a804c
Update sentence about LLVM to match the new defaults
2022-12-31 23:20:21 -06:00
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
966d6e97a7
Move "create a config.toml" after the section explaning x.py
2022-12-31 23:20:21 -06:00
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
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
bd26e3aae5
Replace `$TARGET` with `host`
...
This avoids having to manually modify the configuration in the docs.
2022-12-31 18:23:52 -06:00
7f9af30e5f
Use `origin` consistently and add an example of rebasing over the wrong remote
2022-12-29 11:39:24 -06:00
d318386762
Add more rebasing help
2022-12-29 11:39:24 -06:00
9a67713d99
Fix rustc_borrowck crate name typo ( #1535 )
2022-12-25 21:11:21 +09:00
faf9268f07
Apply feedback
2022-12-18 00:41:27 +02:00
43cd55066d
Add -Ztrack-diagnostics information
2022-12-18 00:41:27 +02:00
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
11c34c7a47
typo
2022-12-14 05:34:09 +02:00
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
cfb4531dde
Remove todo note
2022-12-14 05:34:09 +02:00
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
57f1ba022b
share same link
2022-12-08 19:02:08 -08:00
48d78e345c
fix: Fix broken links
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-12-09 03:13:38 +02:00
3ea1f2de88
Remove TyS
2022-12-08 09:06:11 +01:00
983e101473
Fix small inaccuracy in monomorph page
2022-12-06 21:42:57 -08:00
ab9ea18b59
Remove duplicate paragraph ( #1523 )
2022-12-04 08:09:24 +09:00
ce5a4c75c0
clarify subtree tool policy ( #1518 )
2022-12-03 09:32:00 +09:00
17a43dc86c
Typo ( #1520 )
2022-12-03 09:02:26 +09:00
5d2d898534
Fix broken link
...
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-11-28 19:00:24 -08:00
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
19df867789
Link directly to the section on `--keep-stage`
2022-11-28 19:00:24 -08:00
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
010ab13460
Triage some date-check items ( #1513 )
2022-11-26 22:25:58 +09:00
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
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
29345dcf0c
updating-llvm: keep a calm tone ( #1449 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-11-20 15:19:50 +09:00
e764338832
date-check: updating-llvm ( #1424 )
2022-11-20 12:55:18 +09:00
d1132b7494
Update src/type-inference.md
...
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2022-11-10 23:27:01 +02:00
e53f21a45b
extract regions
2022-11-10 23:27:01 +02:00
623c6246e9
Consistent ordered list indexing
2022-11-09 10:39:06 +02:00
f541555701
Document multiple alternative suggestions on diagnostic structs ( #1486 )
2022-11-09 06:35:38 +09:00
d537ba94b8
trans -> codegen
2022-11-07 16:49:22 +02:00
062dd31e33
Remove implementation details
2022-11-05 10:44:35 -05:00
4c1505600c
Update some more things and improve wording
2022-11-05 10:44:35 -05:00
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
2e59ac0e71
replace tabs with spaces ( #1504 )
2022-11-05 12:32:16 +09:00
f51a573c19
align code blocks with their paragraphs
2022-11-04 03:49:25 +02:00
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
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
431fcf5e20
trans -> codegen ( #1500 )
2022-10-31 13:51:42 -03:00
1d067b8308
add note for err annotation formatting
2022-10-27 20:45:40 +02:00
ffec7d7474
Remove `--bless` from pre-push hook suggestion
...
According to 8873e33806
2022-10-27 20:36:34 +02:00
96c69528ad
Update for highfive transition.
2022-10-27 06:07:59 +02:00
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
015da9686e
Update diagnostics to flat fluent message paths
...
As implemented in rust-lang/rust#103345
2022-10-25 14:36:52 +01:00
2cfe23241b
Update rust-analyzer suggestions ( #1487 )
2022-10-24 19:41:55 +09:00
3a21e559be
miri is no longer a submodule but a subtree. ( #1488 )
2022-10-23 08:17:08 +09:00
bba248984f
fix some links ( #1490 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-10-22 19:53:46 +09:00
83163df624
typo and grammar ( #1484 )
2022-10-19 07:45:49 +09:00
94dec079f7
Add missing prerequisite for some Linux distros ( #1481 )
2022-10-12 08:52:48 +09:00
f2c4c741b0
Update debugging.md
2022-10-08 12:29:47 +02:00
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
e864cdb9b7
fix very minor punctuation typo
2022-10-05 17:39:50 +02:00
a613d5b9e1
diagnostic structs: derive on enum ( #1477 )
2022-10-05 20:22:46 +09:00
397a8f2cf7
Update running tests with the new flags ( #1476 )
2022-10-05 17:04:49 +09:00
c86cf1dd7c
Rename typeck to hir_analysis ( #1475 )
...
Co-authored-by: mejrs <>
2022-10-04 21:22:00 +09:00
14d6444fe5
fix typo and make paragraph consistent ( #1474 )
2022-10-03 19:38:52 +09:00
3ea1b4022b
Update about-this-guide.md
2022-10-02 20:06:43 +02:00
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
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
6b01ad5a98
don't refer to the compile-time interpreter as "Miri" ( #1471 )
2022-09-26 18:07:23 +09:00
d8eb01ae15
UPDATE - Diagnostic docs to reflect renamed traits and macros in rustc PR#101558
2022-09-22 10:29:32 +01:00
811ac7b30b
Fix some typos
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-09-22 10:45:25 +02:00
890a32b6e7
Update stability guide to use CURRENT_RUSTC_VERSION ( #1468 )
2022-09-20 07:43:59 +09:00
b18b3edd4d
Add a note about building `rust-analyzer-proc-macro-srv` ( #1467 )
2022-09-19 15:50:02 +09:00
00db68b612
Link from "implementing to new features" to mcp.md ( #1465 )
2022-09-16 07:06:59 +09:00
cf7c209ce2
remove stray **
2022-09-14 09:09:28 -07:00
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
5fe399e27f
fix typos and formatting
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-09-12 18:48:21 -05:00
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
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
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
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
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
48776510af
Fix typo ( #1459 )
2022-09-09 10:50:44 +09:00
5f7f3e491b
Document multipart_suggestion derive on SessionSubdiagnostic
2022-09-05 10:59:20 +01:00
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
4123cb2cd9
Update for removal of RLS ( #1450 )
2022-09-02 23:03:15 +09:00
ae90271297
Fix the link to `Parser` struct
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-08-29 20:07:51 +02:00
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
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
22863fbc4b
Refine the lintstore section ( #1429 )
2022-08-27 14:59:56 +09:00
ea43d6b258
typo
2022-08-27 06:25:51 +02:00
39fa4dbe24
Updates text to refer to LLVM documentation.
2022-08-27 06:25:51 +02:00
55b49dbc3b
Updates LLVM prereqs since upgrade to C++17.
2022-08-27 06:25:51 +02:00
f54dffb9e1
we got 3 ( #1447 )
2022-08-27 00:34:44 +09:00
4128e99571
A few corrections
2022-08-26 06:18:21 +02:00
bbdb0ca29c
Update some statements
2022-08-26 06:18:21 +02:00
09dd4d4f49
correct typo in parallel-rustc.md
2022-08-26 06:18:21 +02:00
169f5d3764
Correct some statements in parallel-rustc.md
2022-08-26 06:18:21 +02:00
7d4856ba23
update parallel-rustc.md
2022-08-26 06:18:21 +02:00
c9a2c851c9
update thir output ( #1445 )
2022-08-25 07:45:53 +09:00
db535c7aff
do not offer option to run code ( #1442 )
2022-08-23 07:46:35 +09:00
391f3bdd9e
Document changes introduced by kind-less SessionDiagnostics
2022-08-21 08:49:30 -07:00
6eaa13346d
diagnostics: fix outdated use of string slugs ( #1436 )
2022-08-19 10:47:58 +01:00
8b298d3cdc
Add missing lifetime ( #1439 )
...
* fix incorrect #[note] syntax
* more syntax fixes
* add missing lifetime
2022-08-18 17:53:51 -07:00
7536ff8e9a
more syntax fixes
2022-08-18 22:41:51 +00:00
499cc7afe2
fix incorrect #[note] syntax
2022-08-18 22:11:03 +00:00
7c8bf03e3d
Update slug style to use _ instead of - ( #1426 )
2022-08-17 23:16:44 +01:00
a5d21b8533
remove incorrect info ( #1435 )
2022-08-17 19:33:13 +09:00
8156e7f9ab
fix lifetime name ( #1431 )
2022-08-17 19:29:27 +09:00
51be0fd27d
Update the date reference around Git submodule bug ( #1430 )
2022-08-17 17:07:40 +09:00
6116278158
Improve the "Diagnostic items" chapter ( #1427 )
2022-08-13 10:00:38 +09:00
b9ea2a3998
date-check: crates-io
2022-08-11 08:13:27 +02:00
e6f6103222
fix/improve compiler-debugging
2022-08-10 23:27:09 +02:00
05084c67ff
Update src/compiler-debugging.md
2022-08-10 09:23:51 -05:00
c328379974
add gdb tips for symbol-mangling-version
2022-08-10 09:23:51 -05:00
7345ceec48
move references down to avoid clutter ( #1420 )
...
Also, make link to upstream llvm repo clickable
2022-08-09 14:52:46 -07:00
04b006fd12
Fix legend colors in dark mode
2022-08-09 16:47:22 -05:00
31e4869545
Add color for downloaded nodes
2022-08-09 16:44:20 -05:00
27512fd7ff
Add colors to diagram
2022-08-09 16:44:20 -05:00
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
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
5ae1208533
note is now too old to be relevant
2022-08-08 15:15:15 +02:00
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
2022-08-02 13:50:32 -07:00
c3aca0df58
address review comment
...
https://github.com/rust-lang/rustc-dev-guide/pull/1402#discussion_r933905339
2022-07-31 07:46:57 +02:00
57401f4f39
accept review suggestion
...
Co-authored-by: Joshua Nelson <github@jyn.dev>
2022-07-31 07:46:57 +02:00
1046f3e6e8
try address review comments
2022-07-31 07:46:57 +02:00
6469d7444e
summary of chapter
2022-07-31 07:46:57 +02:00
0c77aa9c9e
Update src/building/compiler-documenting.md
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-31 07:46:57 +02:00
13a6ec809d
revamp doc-build chapter
2022-07-31 07:46:57 +02:00
f354a7433b
minor fixes
2022-07-30 19:54:34 -04:00
769f69ca59
Prefer relative links
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
77d9ec9476
Fix the link to clippy docs
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
f64e68eafb
Fix the link to `ResolverAstLowering`
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
75fe5e4782
Fix the link to `ProcMacro` trait
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
f83caba6d0
Fix the link to `Lazy<T>`
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-29 20:12:26 -04:00
5b3ecceecc
Add instructions to fix build errors in std after adding a new target
2022-07-29 17:13:46 -04:00
3cf8dd467e
Document how to build a cross-compiler
2022-07-26 11:07:55 -04:00
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
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
afb2eb604d
Debuginfo tests now also support revisions.
2022-07-21 04:48:49 +02:00
0e30f7c0bf
Link to rendered book directly
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-19 15:58:55 +02:00
386fc96942
Fix link to clippy sync docs
2022-07-19 15:58:55 +02:00
9ca52b51d7
remove stray markup
2022-07-19 09:56:55 +02:00
b2f0e9c3e6
renamed
2022-07-19 09:56:55 +02:00
839725a35d
sync with hackmd version
...
See https://hackmd.io/5t8pLdJcRDmqbfN9ZXje3g
2022-07-19 09:56:55 +02:00
f55e5dfaa5
replace misleading name ( #1401 )
2022-07-19 15:56:24 +09:00
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
9dae3a8245
obey line length limit (part 3)
2022-07-17 23:34:12 +02:00
ddb3d38965
obey line length limit (part 2)
2022-07-17 23:34:12 +02:00
fbcc81b53a
obey line length limit
2022-07-17 23:34:12 +02:00
441ab7ef90
sync with hackmd
2022-07-17 23:34:12 +02:00
a6ed1bcb45
add draft chapter
2022-07-17 23:34:12 +02:00
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
767d2b1135
fix some typos ( #1398 )
2022-07-17 06:45:36 +09:00
9cdee34a55
typo: monomorph docs
2022-07-16 16:44:10 +02:00
1fedc2ea70
Rename debugging_opts to unstable_opts, use link
2022-07-16 12:56:25 +02:00
8bb80e219a
address review comment
...
https://github.com/rust-lang/rustc-dev-guide/pull/1392#discussion_r921560851
2022-07-15 13:24:50 +02:00
f70a8345b9
update date reference on MIR inliner
...
cc #1379
2022-07-15 13:24:50 +02:00
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
67a564f15b
small fixes to ty chapter ( #1390 )
2022-07-15 15:47:42 +09:00
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
71bfd5e641
overview.md: Link to existing Macro Expansion and Name Resolution docs ( #1388 )
2022-07-08 12:55:38 -05:00
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
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
96c3ff376a
Suggest a separate build directory for rust-analyzer ( #1378 )
2022-07-03 15:17:39 +09:00
32d3192152
Change the old filename, "src/stage0.txt" to "src/stage0.json" ( #1383 )
2022-07-03 15:10:25 +09:00
2f2967866f
Add the config needed to get rust-analyzer working on src/bootstrap ( #1381 )
2022-07-03 15:06:54 +09:00
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
3fea5da33d
leave formatOnSave to the user ( #1380 )
2022-07-02 00:35:13 +09:00
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
82fe7a2b9b
Few readability fixes
2022-06-27 02:41:09 +02:00
87ac19a87a
humorust: Forbid pineapple on pizza ( #1374 )
2022-06-26 21:02:21 +09:00
1451fecad2
not obvious what Ex is, so rather get rid ( #1372 )
2022-06-21 22:25:34 +09:00
4f9f93c22a
small improves ( #1371 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-06-21 18:45:30 +09:00
27b12c37e5
make clear that other versions can work ( #1373 )
2022-06-21 13:26:19 +09:00
53101e0024
Fix small `src/diagnostics.md` typo ( #1370 )
2022-06-18 19:42:08 +09:00
3152bcbf2b
Add an "is" and rearange "We next" to "Next, we" ( #1369 )
2022-06-18 12:31:49 +09:00
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
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
de46205199
later -> latter
2022-06-13 00:17:41 +02:00
b005279610
Remove mention of -Zborrowck=mir with Polonius. ( #1367 )
2022-06-08 19:30:43 -03:00
95d5ac8462
Remove nll compare mode. ( #1366 )
2022-06-08 14:21:15 -03:00
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
d292267144
Make build scripts and proc macros work with the suggested rust-analyzer config ( #1365 )
2022-06-08 08:06:32 +09:00
6445e007fe
improve rustc_interface examples a little ( #1362 )
2022-06-07 08:42:07 +09:00
3552ec5286
Clarify cargo fallback behavior for rustup link ( #1273 )
2022-06-07 08:37:50 +09:00
388142f167
Update rustc-driver related examples
2022-05-30 13:57:16 +02:00
f2a18eae27
Triage some date references related to traits
2022-05-27 21:40:59 -07:00
de938b00e2
Cleanup rustdoc-internals
2022-05-24 17:15:35 -07:00
d8eea06af3
Fix some wording on the "Incremental Compilation In Detail" page
2022-05-24 16:03:20 -07:00
7d8e3fd2cd
Add note about patching dependencies and warnings. ( #1354 )
2022-05-21 12:53:51 +09:00
8b5f9d119a
make sentence more simple ( #1353 )
2022-05-20 21:37:01 +09:00
6ec2a84d4d
Update some links and docs ( #1340 )
2022-05-17 07:54:45 +09:00
0312fa6b20
Replace a broken YouTube link ( #1295 )
2022-05-16 11:36:40 -03:00
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
cb69a95ade
Add docs for logging of queries. ( #1350 )
2022-05-12 13:56:26 +09:00
0c88f29374
Fix configuration names for vscode/r-a ( #1352 )
2022-05-12 13:56:14 +09:00
824696ffe2
Update docs for deprecated attribute ( #1338 )
2022-05-12 13:53:26 +09:00
6199edef0f
Update overview.md ( #1351 )
...
Fix minor typo
2022-05-10 09:45:31 -03:00
10a9ba8019
Update date references on parallel-rustc ( #1348 )
2022-05-09 08:47:50 -05:00
b7b14a983a
mention `WithOptConstParam` ( #1346 )
2022-05-09 09:19:43 +09:00
f76f69f603
Fix format ( #1349 )
2022-05-09 09:17:51 +09:00
d331d7ef96
correct type of SubstsRef ( #1347 )
2022-05-07 09:58:20 +09:00
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
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
a1340e010c
Update some date refs
2022-04-20 13:09:19 -07:00
5fac76ad20
Fix a small typo ( #1343 )
2022-04-20 18:57:49 +09:00
ab3dadc854
Extend debugging llvm section ( #1290 )
2022-04-14 20:17:36 +09:00
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
c7e77e92c1
Fix typo serious->series ( #1336 )
2022-04-14 19:46:54 +09:00
8c4e15a49a
Minor type fix ( #1337 )
2022-04-14 19:44:36 +09:00
8b363fba6d
sessiondiagnostic: translation ( #1333 )
2022-04-14 14:57:32 +09:00
de2dd7ce06
method-lookup.md improvements ( #1296 )
2022-04-11 23:29:48 +09:00
cd09c7d4b7
Consolidate crates.io convention section ( #1326 )
2022-04-11 22:51:22 +09:00
a6a8701a86
r-a: Use `python3 x.py` instead of `./x.py` ( #1335 )
2022-04-09 17:31:23 +09:00
66a7e73203
Update miri.md: correct a minor typo ( #1334 )
2022-04-06 07:47:46 +09:00
64ccc62f03
Add example how lints can be feature gated
2022-04-04 13:16:08 -07:00
a1d6f341d5
update section for type system constants ( #1329 )
...
* update section for type system constants
* Update src/constants.md
2022-03-22 14:34:21 +01:00
16d33733da
update winget install instructions to ensure proper packages are installed (-e for --exact, and full package names to ensure arbitrary packages from the msstore source aren't installed)
...
fixes #1324
2022-03-14 08:40:37 -07:00
3782d52fab
Add missing rustdoc tests explanations
2022-03-09 12:45:59 -08:00
133100ead7
Fix incorrectly escaped backtick
2022-03-02 12:18:48 -08:00
1d9f534e4e
Add architecture suggestion for Apple silicon ( #1320 )
2022-03-01 10:45:24 -06:00
cc3f7c4417
cargo timings has been stabilized ( #1319 )
...
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2022-02-27 22:26:00 -06:00
07d132e805
Add known-bug header. ( #1311 )
2022-02-24 22:40:58 -06:00
700361ae97
Fix typo ( #1315 )
2022-02-24 11:27:21 -08:00
34f726b933
Typo ( #1313 )
2022-02-22 18:22:28 -06:00
55ee2bb081
instrument-coverage has been stabilized.
2022-02-20 13:59:23 -08:00
d3cc250a1c
symbol-mangling-version has been stabilized
2022-02-20 13:59:23 -08:00
8484282c52
Fix `Ty` link ( #1308 )
2022-02-20 12:14:58 -08:00
2098ad6059
Edit glossary ( #1302 )
...
Add back-ticks to a few terms that appear in code.
Clarify that `tcx` is a standard.
2022-02-17 14:09:04 -08:00
6d4d4c47d7
Fix heading levels in the query chapter ( #1305 )
...
This should fix the incorrect TOC rendering in #1303 .
2022-02-17 13:48:36 -08:00
8c29f8a37c
Fix link
2022-02-17 13:30:24 -08:00
ef226df435
Edit "Queries" chapter ( #1301 )
...
Makes various edits for clarity, style, readability, and formatting.
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-02-17 15:12:43 -06:00
3bbd78f532
Link to The Rust Performance Book ( #1300 )
2022-02-17 17:46:20 -03:00
9a346dc04d
Correction, building stage3 compiler ( #1298 )
2022-02-11 08:42:50 -05:00
3e67d8ee9a
Triage some date references ( #1293 )
2022-02-10 17:34:23 -03:00
62e5c2a719
mention test folders for cfg(bootstrap) ( #1294 )
2022-02-05 15:03:17 +09:00
0f68c8e315
git.md: Expanded a note to try to stress what you need to do if you're playing
...
games with submodules.
(I overlooked this when cherry-picking an LLVM commit today, and wasted some
time wondering why I wasn't seeing any effect in my resulting `rustc` build...)
2022-01-26 14:01:40 -08:00
638d7fb6ab
Clarify that r? works in comments.
2022-01-20 18:01:07 -08:00
121b57d498
Reorganize and expand the testing chapters. ( #1281 )
...
* Reorganize and expand the testing chapters.
* Update tests chapters for review comments.
* Fix typo.
2022-01-18 14:44:26 -03:00
99beaada7c
Add inline assembly internals ( #1266 )
2022-01-18 11:12:06 -03:00
e3da6331dd
Spelling: Rename `rust` to `Rust` ( #1288 )
2022-01-18 11:09:37 -03:00
ce956908d0
Clean up section about FCPs ( #1287 )
...
* I've never heard the term "pFCP" used before, so spell it out as
"proposed final comment period"
* Fix some unclear things (like implying that you need `r+` rights to
start an FCP)
* Improve the chapter's title, and make it consistent with its TOC entry
* Make some other assorted minor cleanups and improvements
2022-01-18 11:09:16 -03:00
08019e25d1
Address more review comments in #1286 .
2022-01-05 23:26:43 -06:00
940fbb5f7a
Address review comments in #1286 .
2022-01-05 23:26:43 -06:00
e3512c8cd8
Streamline "Getting Started" some more.
...
This is a follow-up to #1279 .
The "Getting Started" chapter is, TBH, pretty bad when it comes to the
stuff about building and testing. It has far too much detail and lots of
repetition, which would be overwhelming to a newcomer.
This commit removes most of it, leaving behind just quick mentions of
the most common `x.py` commands: `check`, `build`, `test`, `fmt`, with
links to the appropriate chapters for details. There were a few
interesting details that weren't covered elsewhere, so I moved those
into other chapters.
2022-01-05 23:26:43 -06:00
ce4ae4004c
Update link to moved section ( #1282 )
...
The section was removed in #1030 and re-added in a different place in
2d42cf7
2021-12-28 22:17:49 -06:00
440503e38d
Fix link in contributing.md ( #1280 )
2021-12-27 10:28:15 -06:00
2c2ebc2fae
Streamline "Getting Started" ( #1279 )
...
* Move `x.py` intro section before first use, and shorten it.
* Improve `x.py setup` docs.
In "Getting Started", strip it back to the bare minimum. Some of this is
moved into the later section.
In the later section, add notable details like config.toml.example how
and `profile` works. Also make the config.toml example more concise.
* Move details about the repository.
Less detail in "Getting Started", more in the later sections.
* Move details about the prereqs.
Less detail in "Getting Started", more in the later sections.
2021-12-24 12:52:31 -03:00
1349a379b8
remove rustfix item in test intro ( #1277 )
2021-12-20 21:53:57 +09:00
924c1fa136
Move date-check comment to fix Markdown syntax
...
The inline code wasn't being rendered correctly.
2021-12-15 11:59:46 -08:00
46d0c2c3a8
Update humor docs for special-casing ferris emoji
...
update for: https://github.com/rust-lang/rust/pull/91476/files
2021-12-15 09:49:37 -06:00
f639a94b4d
Fix some broken links ( #1274 )
2021-12-13 15:16:30 +09:00
ddccb87b0d
Update rustdoc internals
...
Use current paths when discussing source files.
Update cheat sheet section with download-rustc.
Add "use cases" section.
2021-12-09 16:05:48 -06:00
51146cd309
Update HIR chapter to use `HirId` instead of `NodeId`
...
`NodeId`s are no longer used in the HIR. See #50928 for more information.
2021-12-09 09:11:48 -06:00
7c8d7c57a4
Fix some broken links
2021-12-09 09:11:48 -06:00
99ced2e883
Update src/getting-started.md
...
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-12-09 09:09:36 -06:00
08bc5de96a
Improve documentation on r?
2021-12-09 09:09:36 -06:00
2531a18d3b
Update LLVM coverage mapping format version supported by rustc ( #1267 )
...
rust-lang/rust#91207 updates the coverage mapping format to Version 5 or
6, depending on the built-in version of LLVM (12 or 13, respectively).
This change updates the dev guide to match the recent changes.
2021-12-03 09:26:47 -08:00
9074afb8da
Improve 'Running tests manually' section
2021-11-27 03:45:39 -05:00
a7abb26bfe
Fix some links
2021-11-24 10:23:07 -05:00
499f9b9fc9
Update for review comments.
2021-11-24 10:22:37 -05:00
4aff2ba309
Document rustfix-only-machine-applicable
2021-11-24 10:22:37 -05:00
9bde256126
Apply suggestions from pierwill
...
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-11-24 10:22:37 -05:00
c042df7cae
Document more compiletest headers.
2021-11-24 10:22:37 -05:00
6643adf704
Describe drop elaboration ( #1240 )
2021-11-18 13:31:13 -05:00
d4f300263e
Fix an invalid link on Diagnostic Items ( #1261 )
2021-11-16 10:45:40 -03:00
8047e19802
Fix broken links related to `rustc_borrowck` ( #1259 )
...
* Fix broken links in region_inference.md
* Fix broken links in lifetime_parameters.md
2021-11-16 10:43:17 -03:00
e1babf580d
Unify `x.py` usage ( #1258 )
2021-11-16 07:44:50 +09:00
363f6ce09c
Spelling fixes
2021-11-15 08:23:01 -06:00
7b93c858f0
Fix compare-mode documentation
2021-11-14 17:01:35 -06:00
e0ddc301da
Fix broken link in "Bootstrapping"
...
The italics added in #1239 broke the implicitly-resolved link.
2021-11-09 21:46:27 -06:00
7335f28334
Fix typo: [upv.rs_mentioned] -> [upvars_mentioned]
2021-11-07 07:48:47 -06:00
42e31a049e
Add note to emphasize replacing TARGET_TRIPLE ( #1250 )
2021-11-06 18:32:55 +09:00
b4570015e5
Remove some legacy test suites.
2021-11-04 14:18:39 -05:00
07dcb9e148
tiny capitalization fix
2021-11-04 14:15:06 -05:00
98fe056d6c
Fix date
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-11-04 09:33:03 -07:00
b1f655d972
Update some date-check comments
...
I removed one of them because it doesn't seem necessary.
2021-11-04 09:33:03 -07:00
b26499d1ff
enhance subtree docs, link to clippy docs
2021-11-02 20:09:23 -05:00
b547c04d8e
Edit introduction to bootstrapping
...
Use paragraphs instead of bullet-points.
Edits throughout for clarity.
Use semantic line breaks in edited sections.
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-11-02 15:06:56 -05:00
c0c8c133c7
Some minor adjustments to the diagnostic documentation
2021-10-29 21:51:05 -05:00
f85c21465f
Edit "About this guide" for semantic line feeds
...
This is work toward #1241 .
2021-10-28 15:30:08 -05:00
d03c7b8626
Fix `rustc_mir` related links ( #1228 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: nhamovitz <18648574+nhamovitz@users.noreply.github.com>
2021-10-29 00:58:26 +09:00
0d3af84fc0
Add documentation for LLVM CFI support
...
This commit adds initial documentation for LLVM Control Flow Integrity
(CFI) support to the Rust compiler (see rust-lang/rust#89652 and
rust-lang/rust#89653 ).
2021-10-27 08:55:16 -05:00
2cd36a4f65
Describe how to trigger perf runs ( #1237 )
2021-10-22 01:00:27 +09:00
4dcc29161b
Remove docs on Assemble step ( #1233 )
2021-10-18 02:17:19 +09:00
48e6d474cc
Update some docs from 2021-10 date triage ( #1230 )
2021-10-12 08:52:21 +09:00
632f2b7484
Recommend `rustfmt --edition=2021`
2021-10-10 08:28:12 -05:00
62955f53ac
Update sanitizer documentation
2021-10-08 15:49:53 -05:00
84e40d7cbb
Mention needs-sanitizer-hwaddress directive
2021-10-08 15:49:53 -05:00
af8c2d2c7d
Address review comments
2021-10-08 15:41:06 -05:00
3657acea97
Document tracing awesomeness
2021-10-08 15:41:06 -05:00
1620515e37
Move log/tracing instructions to its own file
2021-10-08 15:41:06 -05:00
e0cfc8c17a
Update src/closure.md
...
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-10-07 17:48:12 -05:00
ebbb329734
Fix accidental HTML tag
...
The markdown parser was interpreting the `<something>` in `adjust_upvar_borrow_kind_for_<something>` as an HTML tag that was hidden in the rendered text. This minor edit fixes that.
2021-10-07 17:48:12 -05:00
3e63f3615c
Update links to `rustc_mir` in Two Phase Borrows ( #1226 )
...
https://github.com/rust-lang/rust/pull/80522 split the `rustc_mir` crates into 5 crates, effectively invalidating all the direct links to `rustc_mir` in the docs.
I found this while looking at the Two Phase Borrows doc, which is why I am giving out this PR to fix this.
2021-10-06 09:07:51 -03:00
81201b80eb
Update some docs from 2021-10 date triage ( #1224 )
2021-10-05 17:24:24 -03:00
5926c7e6f4
Fix a typo on closure.md ( #1218 )
2021-09-24 12:00:29 +09:00
7a476c07e1
const generics update
2021-09-20 12:35:16 -05:00
ee746de3af
s/--blessed/--bless/
2021-09-19 10:36:26 -05:00
99e53983ad
Make indentation consistent in example vscode config file
2021-09-17 16:52:56 -05:00
ee4b32b958
Suggests `--edition=2018` argument when using stage0/bin/rustfmt directly
2021-09-17 14:53:44 -05:00
212a89205b
`ty::Unevaluated`: dealing with unused substs ( #1190 )
...
* unused ct substs
* q
* q
* Update src/constants.md
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2021-09-17 15:50:26 -04:00
d82208c6f4
Parallel codegen ( #1206 )
...
* Described underlying data structures in parallel code generation and crates they are used in
* Added links
* replace crate information with description of types
2021-09-16 20:58:07 -05:00
428670ca01
Clarify difference of a help vs note diagnostic.
2021-09-12 11:50:44 -05:00
6b747c6cf2
remove ctag section
2021-09-08 15:13:44 -05:00
ce27f4801d
Update suggested.md
2021-09-08 15:13:44 -05:00
af8961775a
Update SUMMARY.md
2021-09-08 15:13:44 -05:00
4105934b90
Move ctag section to "Suggested Workflow"
2021-09-08 15:13:44 -05:00
7c4410ed50
Delete ctags.md
2021-09-08 15:13:44 -05:00
ef35a84098
Clarify paragraph in "Keeping things up to date"
2021-09-08 12:36:10 -05:00
f1b5e50437
Docs: added section on rustdoc
2021-09-07 11:08:38 -05:00
3d4f0d91e3
Docs: made suggested fix
2021-09-07 11:08:38 -05:00
0f657e23aa
Docs: deleted copy
2021-09-07 11:08:38 -05:00
720084903e
Docs: added section discussing core ideas
2021-09-07 11:08:38 -05:00
a22f7be4e7
Docs: delete redundant use of correctness
2021-09-07 11:08:38 -05:00
4ebe82a278
Docs: consolidated parallelism information
2021-09-07 11:08:38 -05:00
8887cd3d50
Add links to overview.md ( #1202 )
2021-09-06 18:34:16 -03:00
1ffee15da9
Spelling change intermidiate to intermediate
...
Very importent change.
2021-09-05 12:11:19 -05:00
03420385e1
Fix a typo ( #1200 )
2021-09-05 09:40:35 -03:00
46fa9e7283
Documenting diagnostic items with their usage and naming conventions ( #1192 )
...
* Documenting diagnostic items with their usage and naming conventions
* Fixed typos in diagnostic items documentation
Co-authored-by: Camelid <camelidcamel@gmail.com>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-09-01 11:26:58 -07:00
dd1feeb7a2
Add link to `Span`
2021-08-31 12:38:30 -05:00
8b64a80ccc
Add rustc-source to suggested rust-analyzer config ( #1189 )
...
This allows loading the sources for crates loaded from the sysroot.
2021-08-31 10:13:18 -07:00
5c36f8e2ad
Fix typo, clarify backtick wording, and use inline code
2021-08-31 12:08:01 -05:00
d789b1c701
Trailing date comments in a line inside of a paragraph caused beginning of a new paragraph. ( #1196 )
...
This PR fixes the 2 occurrences of that.
(I'm not sure if there's an underlying issue with mdbook or if this is working as intended.)
2021-08-28 08:26:16 -03:00
c98c707872
Fix a code block containing ```rust
...
This wasn't displayed correctly.
Changing `` ```rust `` to `` ```rust`` made it a code block again,
but the leading space was rendered as-well.
(This may be an issue in mdbook, but I'm not sure.)
This commit changes it to use HTML-syntax in order to get the desired result.
2021-08-27 15:13:38 -05:00
5bfa8c9a9c
Fix typo “a Rc” → “an Rc” ( #1191 )
2021-08-22 11:47:02 -03:00
cfffdd92ea
Expand THIR section with more details ( #1183 )
...
* Expand THIR section with more details
* Remove incorrect reference to `HirId`s
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-08-21 19:55:56 -04:00
b5814b34da
Remove docs for old -Z profile-queries flag
2021-08-16 08:20:03 -05:00
6893645e60
Remove a dead link in `new-target.md` + other nits ( #1186 )
2021-08-10 20:41:44 +09:00
cb2c542217
Add description of -opt-bisect-limit LLVM option ( #1182 )
2021-08-07 10:12:22 +02:00
98d9084c4f
Fixed team responsible for stabilization ( #1181 )
2021-08-05 13:41:16 +02:00
a6e37389d8
Add S-Inactive PRs as another source of things contributors could work on ( #1177 )
2021-07-29 06:05:19 +02:00
f0900b2e0f
git.md: Fix No-Merge Policy link
2021-07-28 09:45:23 -04:00
a7f22be835
Fix typo in building/bootstrapping.md ( #1175 )
2021-07-26 00:37:28 +02:00
f03ae32895
Link directly to stabilization report comments ( #1173 )
...
Previously, readers had to scroll through tons of comments to find the
report.
2021-07-20 17:39:41 -07:00
a9dd88ec4c
Update for merge of CrateDisambiguator into StableCrateId
2021-07-13 12:45:58 -04:00
03faa9b900
Minor capitalization fix ( #1170 )
2021-07-08 01:27:47 +02:00
0ead7b154f
Fixed typos in inline code
2021-07-05 11:21:03 -04:00
9304642bde
Document lang items ( #1119 )
...
* Document lang items
* Apply suggestions from code review
Co-authored-by: Camelid <camelidcamel@gmail.com>
* Add an example of retrieving lang items
* Add two missing words
* Fix line lengths
Co-authored-by: Mikail Bagishov <bagishov.mikail@yandex.ru>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-07-05 08:34:33 +02:00
b756d157e8
More specifics on what future-incompatible lints are used for
2021-07-04 23:21:24 -04:00
7cfaceec67
Fix line lens
2021-07-04 23:21:24 -04:00
e0f39fce3a
Update information on lints particularly on future-incompatible
2021-07-04 23:21:24 -04:00
7a6cf5ce55
Update section of lint store
2021-07-04 23:21:24 -04:00
1d25c44b9a
Update around half of the January 2021 date references ( #1155 )
2021-07-02 10:43:34 +02:00
6f1c331e94
Create issues for many TODOs ( #1163 )
...
* Create issues for many TODOs
* Update src/crates-io.md
Co-authored-by: Joshua Nelson <github@jyn.dev>
* Update src/backend/inline-asm.md
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Joshua Nelson <github@jyn.dev>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-07-02 10:43:12 +02:00
76c1d45ae5
Links from rustc-dev-guide to std-dev-guide ( #1152 )
2021-07-01 13:19:06 +02:00
6641226ba8
Document how to mark features as incomplete ( #1151 )
...
* Document how to mark features as incomplete
This was changed in https://github.com/rust-lang/rust/pull/86446 so that
incompleteness is included in the delcaration.
* Footerify link
2021-06-29 18:41:13 +02:00
c62c96ee6f
Remove requests or suggestions about rebase and fixup contradictory to rust-highfive bot comment ( #1111 )
2021-06-25 01:50:50 +09:00
3db8af26f9
Generate glossary table correctly ( #1146 )
...
Co-authored-by: Yuki Okushi <yuki.okushi@huawei.com>
2021-06-24 13:57:37 +09:00
5a5098a2a5
Correct the wrong serial number ( #1147 )
2021-06-23 15:14:09 +09:00
a4bbc6547f
Update "Inference variables" section ( #1145 )
2021-06-21 21:50:12 +02:00
1373d5beed
Document how to run unit tests ( #1141 )
2021-06-17 17:25:28 -03:00
ae62be50bd
We stopped using allow_internal_unstable a while ago ( #1142 )
...
Co-authored-by: Ralf Jung <post@ralfj.de>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2021-06-15 17:04:54 +09:00
3559fa7fef
Change the feature used as an example of stabilizing lib features ( #1143 )
2021-06-15 05:57:10 +09:00
29aeb0b2ae
We use HIR to do type inference, trait solving and type checking ( #1139 )
...
* We use HIR to do type inference, trait solving and type checking
* Update src/overview.md
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
* Update src/overview.md
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
* Update src/overview.md
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
* Fix type checking brief explanation
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2021-06-14 20:35:38 +02:00
18493f62b0
Add suggested settings note for coc ( #1144 )
2021-06-13 01:17:06 +09:00
5e61e50c17
move 7/8 to prose
2021-06-09 14:43:20 -04:00
7bfcf8763b
Add a section on keeping things up to date in the git section
2021-06-09 14:43:20 -04:00
5154ef98ec
Fix some links ( #1137 )
...
* Fix some links
* Address review comment
2021-06-04 09:08:56 +02:00
f4e82623b2
explain Miri engine vs Miri-the-tool
2021-05-30 02:18:51 +02:00
faaaaf955c
Add more information about no_hash query modifier. ( #1133 )
2021-05-28 17:23:27 +02:00
3d9d15d1f5
improve section introduction
2021-05-26 06:24:44 -04:00
1353f7fe08
not all tools require waiting for a nightly release before they can be fixed
2021-05-26 06:24:44 -04:00
fe4887b0e2
Describe the difference of rustc_lint vs rustc_lint_defs.
2021-05-25 21:37:21 -04:00
2d3cc2a192
update rustfmt references to reflect change from submod to subtree ( #1129 )
...
* update rustfmt references to reflect change to subtree
* clarify broken toolstate hypothetical scenario
2021-05-20 15:02:20 +02:00
da1c7b423c
Remove `--stage 1` argument from `doc` invocations ( #1125 )
2021-05-18 19:10:39 +02:00
412d1a75ab
Update coverage docs ( #1122 )
2021-05-13 19:19:43 -07:00
1e1ffdba44
Document -Zunpretty=thir-tree ( #1128 )
...
* document -Zunpretty=thir-tree
* Update position/wording
2021-05-13 20:51:43 +02:00
3f01b29957
Unified CPU Requirements ( #1126 )
2021-05-10 13:38:24 +09:00
c1e84b6c94
add 'waiting-for-review' incantation to main contrib page ( #1124 )
2021-05-05 13:53:42 +02:00
9ba3b4b62c
Suggest using `git range-diff` ( #1092 )
...
I have found it to be very helpful when rebasing.
2021-04-27 12:35:37 -07:00
90e1d1fa43
Add sample nix shell
...
This also suggests using `x.py setup` instead of copying config.toml.
2021-04-27 08:52:22 -04:00
6bace78929
more RA config suggestions ( #1114 )
2021-04-26 18:34:50 -04:00
8c522aa732
Add Polymorphisation paper ( #1093 )
2021-04-24 10:53:30 +09:00
e0055323fd
Mention unpretty=mir-cfg for debugging MIR
2021-04-23 16:25:11 -04:00
0822830537
Improve formatting and update info in "method lookup" section
2021-04-09 18:12:21 -04:00
ee9bb8e48d
Change wording a bit: `module` => `crate`
...
It seems more correct
2021-04-09 10:34:26 -04:00
727f212e9a
fix typo ( #1107 )
2021-04-09 12:30:04 +02:00
88a4aa5308
fix typo
2021-04-08 17:29:13 -04:00
fd8f1fee4e
Mention CI build of LLVM in build instruction
2021-04-03 22:28:35 -04:00
98c50aacd2
Fix rustdocs test command typo ( #1103 )
2021-04-04 01:41:35 +09:00
3b9c325e72
Update the "LLVM updates" section
2021-04-02 05:57:57 -04:00
3a25c80892
Fix a link about Rustdoc internals
2021-04-02 05:25:14 -04:00
892e9091cb
Add quickstart for adding a new optimization ( #1094 )
2021-04-01 19:24:44 +02:00
fd97123fbc
Add back example of {{cwd}} ( #1099 )
...
I force-pushed this in the last commit and accidentally deleted the
github suggestion.
2021-04-01 04:04:46 +09:00
ec260c8f5c
Document test input normalization
2021-03-31 14:51:19 -04:00
ae4208314d
Add notes about nightly rustc version for the rustc-driver examples
2021-03-28 13:33:56 -04:00
081624ceaa
Fix rust compiler meeting info ( #1087 )
...
* Remove dead link
* Make general text a bit better
* Fix Zulip link
* Improve description of what the compiler meeting is about
2021-03-19 19:11:43 -04:00
1b0372be77
Remove extra the ( #1088 )
2021-03-11 13:36:25 -08:00
d6bd146507
Fix double-word typos ( #1084 )
...
Inspired by #1079 . I used this command to find these typos:
rg --multiline --pcre2 '\b([a-zA-Z]+) \1\b' src -tmd
There were a couple false positives of the form "that that" meaning
"that it" or "that this".
2021-03-12 03:29:19 +09:00
b8fb35151f
I-nominated are nominated for discussion ( #1080 )
...
* I-nominated are nominated for discussion
* Generalize meeting expression
Co-authored-by: Camelid <camelidcamel@gmail.com>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-11 19:05:02 +01:00
126ea58714
Complete unfinished statement
2021-03-11 13:01:44 -05:00
6753e20cbe
Update lins
2021-03-10 12:00:27 -05:00
9692e9e9a1
Apply suggestions from code review
...
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-10 12:00:27 -05:00
d29b1c39cb
Add stub about the THIR
2021-03-10 12:00:27 -05:00
4163ac0d6a
Adjust a bit better P- label text
2021-03-10 11:35:23 -05:00
b70deb1f65
Fix typos ( #1079 )
2021-03-10 23:56:51 +09:00
0c6cccc215
Update cmake version in prerequisites.md ( #1077 )
...
LLVM requires at least cmake 3.13.4.
https://www.llvm.org/docs/CMake.html
2021-03-09 20:00:12 +01:00
2f006eabe1
Fix typo: suceed -> succeed
2021-03-09 12:37:10 -05:00
4ddb696206
Add article on using WPA to profile rustc memory usage on Windows ( #1074 )
...
Document how to use WPA to profile rustc and what the normal workflow
should be for investigating bootstrap memory usage issues.
Co-authored-by: Ryan Levick <ryan.levick@gmail.com>
2021-03-09 04:42:56 +09:00
0319b90a25
Use more accurate estimate of generated LLVM IR with llvm-lines
...
The `--emit=llvm-ir` emits an optimized LLVM IR. For optimized builds it will be
highly inaccurate estimate of the amount IR generated initially. While the
inaccuracy can be somewhat reduce after disabling the optimization, that in turn
has other unintended consequences, since opt-level controls the emission of
lifetime markers, sharing of generics between crates, instantiation of inline
functions, etc.
Use `-Csave-temps` and `no-opt` bitcode as a basis for more accurate estimate of
initial work handed of to the LLVM.
2021-03-07 10:57:13 -05:00
a959fee323
Cleanup rustdoc chapters a bit
...
* Rename "The walking tour of rustdoc" to "Rustdoc overview",
which I think is a more accurate name
* Use same name in sidebar TOC as in chapter text
* Make links between the two chapters prominent
* Convert a few `.html` links to `.md`
Probably we should just merge the chapters, but leaving that for later.
2021-02-28 16:35:20 -05:00
295234161c
Fix broken links
2021-02-28 11:01:07 -05:00
47722b22e9
Document how to enable CI LLVM without using `x.py setup`
2021-02-26 15:38:01 -05:00
15c1f01c2f
Remove some unrelated changes
2021-02-26 15:38:01 -05:00
44f4197fa5
Fix typos
2021-02-26 15:38:01 -05:00
d6f81b211f
Restore instructions for using system LLVM
...
They were removed in #1030 , but are still useful.
2021-02-26 15:38:01 -05:00
4895d26d5e
Update some out-of-date information
2021-02-26 15:38:01 -05:00
7fde8950cf
Fixes typo in getting started guide
2021-02-24 21:20:36 -05:00
9539f6c271
Fix formatting of more date references ( #1067 )
2021-02-22 18:22:23 +09:00
b4b1fb0058
Fix broken links in query.md ( #1068 )
2021-02-21 09:51:34 +01:00
7f5a39d318
Update docs from date triage for 2021-02 ( #1048 )
...
The biggest change was updating the list of rustdoc passes. Several new
ones have been added since that documentation was written, so I added
those, and I also sorted the list so it is roughly alphabetical (except
for the part for the `strip-*` passes, which I left in the same order
since one of the list items has two passes so there's no "correct"
order).
2021-02-20 19:27:24 -08:00
f7049a868c
Fix date-check comment formatting ( #1066 )
...
I realized that the format I had been previously using for date-checks
(as of January 2021 <!-- date: 2021-01 -->)
left a space before the closing parenthesis in the rendered output,
which looks weird.
I could fix this by removing the space between `2021` and `<!-- ...`,
but that looks weird in the source. So I ended up deciding on changing
it to
(as of <!-- date: 2021-01 --> January 2021)
2021-02-20 19:24:01 -08:00
4f0142ce11
Make "URL" show up ( #1065 )
...
* Make "URL" show up
* Use `<URL>`
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-02-20 13:58:22 +01:00
50e53ccffa
Point to main branch on llvm-project's links
2021-02-19 20:25:36 -05:00
c6cf4c04da
Fix typo ( #1063 )
2021-02-18 19:37:43 +01:00
87b317f966
Update running.md
2021-02-17 17:13:07 -05:00
1ab6279cea
Add Oxide paper to bibliography
2021-02-15 10:14:03 -05:00
4f16f7cc1d
Fix typo
2021-02-07 22:12:28 -05:00
b0ff83f007
Fix typo in Bug Fix Procedure ( #1050 )
2021-02-07 11:15:54 -05:00
768f07b196
Add chapter on libs and metadata. ( #1044 )
2021-02-04 11:34:52 -05:00
6e02970f7f
Add lots of date-check annotations
...
Also added dates for things that previously said "as of now" or "as of
this writing" and cleaned up a couple of things along the way.
2021-02-03 19:29:07 -05:00
2e19c8ecc0
Document how to stabilize a library feature ( #1036 )
...
* Move 'force-unstable-if-unmarked' to the bootstrapping chapter
* Document how to stabilize a library feature
Note that features can't be stabilized until they go through FCP and
that FCP happens on the tracking issue, not the PR.
* Fix wrong glob
By default `**` behaves the same as two `*` side by side, i.e. it only
globs file paths, not directories. `shopt -s globstar` needs to be set
for it to mean a directory. I didn't notice this before now because
`globstar` is set by default in interactive mode, but not otherwise.
2021-02-01 19:31:00 +01:00
f6e4a5f851
Update test suite descriptions. ( #1042 )
2021-01-30 20:12:01 +09:00
21745b2014
put `x.py` in ticks
2021-01-30 10:59:57 +02:00
470d5afe98
Update links to `librustc_llvm` and `rustllvm`
2021-01-24 08:18:34 -05:00
584ccc7608
Add link to promotion.md ( #1033 )
...
* Add link to promotion.md
* Improve link text
Co-authored-by: Camelid <camelidcamel@gmail.com>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-01-22 11:49:52 +01:00
7547e6af9a
Add missing period
2021-01-21 14:26:25 -05:00
53a45a9a19
Remove "Skipping LLVM build" section
...
`download-ci-llvm` is available and enabled by default for all tier 1
platforms, so there is no need to change it. Using system LLVM over CI
llvm is still supported, but is not recommended. Building LLVM from
source is still supported.
This also notes that you need to explicitly disable downloading LLVM
when updating the submodule.
2021-01-20 13:45:05 -05:00
7a80b01e01
Add mdbook-toc, markers, and documentation ( #1028 )
...
* Add mdbook-toc to travis, book.toml and documentation
* Add toc markers
* Whitespace cleanup and some punctuation
* Addressed comments
2021-01-20 14:33:11 -03:00
d8d5bbcfe3
Link to `feature_err` in stability section ( #1022 )
2021-01-19 11:47:45 -08:00
b2d6a16e58
Fix typo ( #1027 )
2021-01-17 11:50:04 -03:00
403521f1b9
Note that `--check` now allows using any stage
2021-01-17 05:51:00 +02:00
4bb7ee493f
improved the readablity of a line
2021-01-16 12:04:07 -05:00
f7e62ecccb
Fixed a grammatical error in hardawre requirements section
2021-01-16 10:03:23 -05:00
eeb696d8a4
Corrected MIR file path and fixed a typo ( #1020 )
2021-01-14 14:10:08 -08:00
261ec50fa9
Add a note about UI test entry limitation ( #1019 )
2021-01-12 07:55:13 +09:00
cd437dc04f
Add context to dated information ( #1013 )
...
* Fixes #924 Add context to dated information
* Fixes #924 Addressed comments and some uses of 'currently'
* Update src/contributing.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
* Update src/salsa.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
* Fixes #924 Addressed comments
* Fixes #924 Fixed line lengths.
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-10 19:23:22 -03:00
296a37bf7b
Update 'Workspace structure' section ( #1017 )
...
* Update description of `src/`
* Note that `library/` also contains the Rust runtime
2021-01-10 16:19:39 -05:00
afaa42043c
Point to `HirId` instead of `NodeId`
2021-01-09 21:05:10 -05:00
c16ce78347
Fix typo ( #1016 )
...
"currenty"!
2021-01-09 17:18:57 -08:00
1db26c008c
Break up long line
2021-01-05 16:13:58 -05:00
d01012ada8
Remove backticks and comment about possible bug
2021-01-05 16:13:58 -05:00
8a8bb49afa
Update src/compiler-debugging.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-05 16:13:58 -05:00
27174ca131
Make instructions for configuring compiler for debug more explicit
2021-01-05 16:13:58 -05:00
8bb02718e9
Remove old sentence that should have been removed
...
It was mistakenly not removed in #997 .
2021-01-04 22:43:03 -05:00
37a1ca9416
Fix "Potential incomplete link" error on compiler-debugging.md
2021-01-04 20:12:37 -05:00
5ca0f2dc26
Add link to rust-analyzer docs on getting started page
2021-01-04 10:09:49 -05:00
1b4d37b32b
Fix some typos
2021-01-04 10:02:33 -05:00
a0cdbb5675
Tweak wording around provider purity
2021-01-03 22:31:09 -05:00
d225a12cab
Fix typo (reflex -> reflect)
2021-01-02 09:25:03 -05:00
c74f970ae3
Clarify that `check` uses a different stage than `build` ( #999 )
2021-01-01 20:59:23 +00:00
8a8749228b
Fix broken link for `BoundRegion` ( #998 )
2020-12-31 01:13:49 +01:00
4142cf8b8d
Update logging section and explain `RUSTC_LOG_COLOR` ( #997 )
...
* Update logging section and explain `RUSTC_LOG_COLOR`
* Small fixes
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
* Mention that prefixes of paths work as log filters
* `=debug` matches `debug!` *and higher*
* Note that `MIRI_LOG_COLOR` only applies to logs from Miri
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-31 01:08:00 +01:00
659281e739
Fix broken link in the contributing guide ( #996 )
2020-12-29 21:08:55 +01:00
7268945c0f
rustc invocation standarized ( #992 )
...
* rustc invocation standarized
* Addressed comments
* Addressed comments
* Addressed comments
* Updated command output
2020-12-28 23:34:51 +01:00
e0425a9563
Update glossary.md ( #994 )
...
* Update glossary.md
- Added additional information to some of the definitions.
- Made term capitalization consistent so that only terms which refer to acronyms or concrete types are capitalized. Please let me know if that isn't desirable for some reason.
* Update src/appendix/glossary.md
Co-authored-by: Joshua Nelson <jyn514@gmail.com>
* Update src/appendix/glossary.md
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
* Update src/appendix/glossary.md
Co-authored-by: Joshua Nelson <jyn514@gmail.com>
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-28 20:05:06 +01:00
2f9696bdeb
[ Fixes #778 ] Added and reorganized lecture links ( #993 )
...
* Added and reorganized lecture links
* Addressed comments
* Addressed comments
2020-12-27 20:50:53 +01:00
cb0b7b64ee
Document `error-pattern` header ( #989 )
...
* Document `error-pattern` header
* Address some reviews
2020-12-12 16:06:30 +01:00
4e871ea1db
Fix some link failures and typos
2020-12-11 16:00:15 -05:00
a801509b43
All links to rustdoc-internals.md
2020-12-10 14:51:04 -05:00
0265b964a7
Add a section on identifiers in the MIR ( #951 )
...
* Add a section on identifiers in the MIR
* Better wording
* Use loose lists; fix typo; fix link
* Update info
* Note how you can retrieve the associated data
Suggested by @LeSeulArtichaut.
* Update src/identifiers.md
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
* Add TODO for `Promoted` re `GlobalId`
Co-authored-by: Oli Scherer <github35764891676564198441@oli-obk.de>
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-07 20:56:25 +01:00
a7c82e3ba9
Adds a dev guide section on Rust Coverage
2020-12-07 14:22:45 -05:00
2adddd99f2
Edit the Mir page to fix infelicities. ( #984 )
...
* Edit the Mir page to fix infelicities.
- Remove dead reference to Mir. reflow sentence to talk about
`Body::local_decls`
- Fix broken links to render properly.
- Add links for `Terminator`, `RETURN_PLACE`, `ProjectionElem`.
* Update src/mir/index.md
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
* Edit the Mir page to fix infelicities.
- Remove dead reference to Mir. reflow sentence to talk about
`Body::local_decls`
- Fix broken links to render properly.
- Add links for `Terminator`, `RETURN_PLACE`, `ProjectionElem`.
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-06 15:36:52 +01:00
a4871f5013
Add links to the rust documentation for all MIR structs ( #982 )
...
* Add links to the rust documentation for all MIR structs
* Update src/mir/index.md
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
* Update src/mir/index.md
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-06 14:40:45 +01:00
903f6277f4
Link to the Rustdoc book in the rustdoc chapter ( #981 )
...
This makes a) makes it easier to find info about rustdoc's features and
b) redirects people in the wrong place to where they should be looking.
2020-12-04 18:23:46 +01:00
b3fc04e298
fix a couple links
2020-12-03 00:06:19 -05:00
e98d87a670
Use shorter [][]-style link to not pass 100 chars.
2020-12-02 22:34:16 -06:00
dc31ca1ca8
Apply suggestions from review.
...
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-12-02 22:34:16 -06:00
0e7f5c08b1
Document SessionDiagnostic
2020-12-02 22:34:16 -06:00
d89703684b
Use shorter 'rustbot label' command
...
'rustbot modify labels: ...' -> 'rustbot label ...'
2020-12-01 13:56:48 -05:00
f6f9e0957c
Move the bootstrapping section later in the guide ( #975 )
...
Now that `x.py build` works in most cases, I don't think we need to
teach people all the intricacies of bootstrap right away. This moves it
to the 'overview of the compiler' section instead.
2020-11-30 20:08:17 -03:00
5661848ab9
Address feedback
2020-11-30 18:06:43 -05:00
680e35a172
Add notes about running the UI test suite
2020-11-30 18:06:43 -05:00
43fa1342f0
Document what 'sysroot' means
2020-11-29 20:02:55 -05:00
844ca6f14d
Don't imply that the name of the fork always needs to be changed
2020-11-29 10:42:20 -05:00
1f25130a83
Add information about common git issues
2020-11-29 10:42:20 -05:00
98fdbf9406
Fix a typo
2020-11-28 14:09:03 -05:00
5dce3301d4
Link to feature-stabilization docs
2020-11-26 20:43:36 -05:00
ff24e31a36
Move instructions for adding a feature gate to "Feature Gates"
2020-11-26 20:43:36 -05:00
ea6df8f903
Document how to modify feature gates
...
How to remove them and how to rename them.
cc <https://github.com/rust-lang/rust/pull/79336#discussion_r528627318 >
cc @varkor
2020-11-26 20:43:36 -05:00
c63305c6e8
Document when errors should have an associated error code ( #967 )
...
Document when errors should have an associated error code
2020-11-24 17:09:59 -08:00
ced315b860
Update bootstrap documentation with the new envvars for RUSTFLAGS
...
This follows <https://github.com/rust-lang/rust/pull/63722 >.
2020-11-24 09:06:33 -05:00
2fa114e07d
Update `param_env` link
...
`rustc_ty` was recently [renamed] to `rustc_ty_utils`, so this link has
to be updated.
[renamed]: f59d03038c
2020-11-23 18:40:46 -05:00
49069a0233
add small explanation of why fuel can be useful for debugging
2020-11-22 08:43:00 -05:00
ed89d6f643
add mir-opt section for optimization fuel
2020-11-22 08:43:00 -05:00
b2a34704a6
add string interning wikipedia link ( #960 )
2020-11-15 12:14:06 -05:00
661ba74612
Provide a brief example of a data-flow analysis
2020-11-12 11:53:00 -05:00
3e4c0c70f2
Explain the purpose of the bottom value
2020-11-12 11:53:00 -05:00
6a4c0ee05f
Add a section on data-flow convergence
2020-11-12 11:53:00 -05:00
4b00bfb892
Links to htmldocck/@has/matches for searchability
2020-11-11 19:02:37 -05:00
7497da24ca
Update src/compiler-debugging.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-11 10:39:15 -05:00
4da49360a6
Update link in compiler-debugging.md
...
Link didn't point to latest version of `env_logger` crate.
Add an explanation to disambiguate the RUSTC_LOG syntax.
2020-11-11 10:39:15 -05:00
d7bb0ad45d
Update src/building/how-to-build-and-run.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-09 09:07:41 +02:00
79d3ceb2fa
Fix install command
2020-11-09 09:07:41 +02:00
ac0b94deff
Document `src/tools/x`, an `x.py` wrapper
...
Document the newly added `x` binary that wraps `x.py`, which can be
installed system-wide, and can be run from any subdirectory of a rust
repo checkout.
2020-11-09 09:07:41 +02:00
Langston Barrett
Hoblovski
Tshepang Mbambo
Michael Howell
Thom Chiovoloni
Yutaro Ohno
bohan
clubby789
Yuki Okushi
apiraino
Mika
Ezra Shaw
lcnr
The 8472
Noah Lev
Michele
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
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
Justus K
AngelicosPhosphoros
JohnTitor
Léo Lanteri Thauvin
Wesley Wiser
Daniel Santos
Hirochika Matsumoto
r00ster
dmezh
Yusuke Tanaka
Henry Boisdequin
Iñaki Garay
Martin Geisler
ashosive
saki-osive
saki-osive
Ryan Levick
Sebastian Widua
Laurențiu Nicola
Wesley Wiser
Siddharth
mark
jumbatm
Ben Striegel
Gabriel de Perthuis
cjkenn
hosseind88
Alexis Bourget
Olivier FAURE
Casey Rodarmor