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
8faa1646f5
Remove `--stage 1` argument from `doc` invocations ( #1125 )
2021-05-18 19:10:39 +02:00
c989a4db5b
Update coverage docs ( #1122 )
2021-05-13 19:19:43 -07:00
f58dfe98ad
Document -Zunpretty=thir-tree ( #1128 )
...
* document -Zunpretty=thir-tree
* Update position/wording
2021-05-13 20:51:43 +02:00
1e6c7fbda4
Unified CPU Requirements ( #1126 )
2021-05-10 13:38:24 +09:00
5b63bc2fb7
add 'waiting-for-review' incantation to main contrib page ( #1124 )
2021-05-05 13:53:42 +02:00
e72b43a649
Suggest using `git range-diff` ( #1092 )
...
I have found it to be very helpful when rebasing.
2021-04-27 12:35:37 -07:00
ccc286ba87
Add sample nix shell
...
This also suggests using `x.py setup` instead of copying config.toml.
2021-04-27 08:52:22 -04:00
9b0135d306
more RA config suggestions ( #1114 )
2021-04-26 18:34:50 -04:00
2f5927a77e
Add Polymorphisation paper ( #1093 )
2021-04-24 10:53:30 +09:00
8cf042c6f5
Mention unpretty=mir-cfg for debugging MIR
2021-04-23 16:25:11 -04:00
a9bd2bbf31
Improve formatting and update info in "method lookup" section
2021-04-09 18:12:21 -04:00
31e44f4116
Change wording a bit: `module` => `crate`
...
It seems more correct
2021-04-09 10:34:26 -04:00
2c2f61ae19
fix typo ( #1107 )
2021-04-09 12:30:04 +02:00
83b81fdd69
fix typo
2021-04-08 17:29:13 -04:00
871a54568f
Mention CI build of LLVM in build instruction
2021-04-03 22:28:35 -04:00
d1e2f3bf50
Fix rustdocs test command typo ( #1103 )
2021-04-04 01:41:35 +09:00
8d6459ffff
Update the "LLVM updates" section
2021-04-02 05:57:57 -04:00
dfe398bd5a
Fix a link about Rustdoc internals
2021-04-02 05:25:14 -04:00
32c6d27b4b
Add quickstart for adding a new optimization ( #1094 )
2021-04-01 19:24:44 +02:00
dda441c42e
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
a05852eec0
Document test input normalization
2021-03-31 14:51:19 -04:00
0687daac28
Add notes about nightly rustc version for the rustc-driver examples
2021-03-28 13:33:56 -04:00
9a676ee3a4
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
67ebd4b55d
Remove extra the ( #1088 )
2021-03-11 13:36:25 -08:00
e72bf56a45
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
ff363172f9
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
0526ce3339
Complete unfinished statement
2021-03-11 13:01:44 -05:00
bfe8e98253
Update lins
2021-03-10 12:00:27 -05:00
872ba49f48
Apply suggestions from code review
...
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-10 12:00:27 -05:00
4c8fdcf511
Add stub about the THIR
2021-03-10 12:00:27 -05:00
912aa00c3b
Adjust a bit better P- label text
2021-03-10 11:35:23 -05:00
f83c57bee6
Fix typos ( #1079 )
2021-03-10 23:56:51 +09:00
0b1bdbb183
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
ddadc67423
Fix typo: suceed -> succeed
2021-03-09 12:37:10 -05:00
91f8f334f4
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
8bb61fe105
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
c431f8c29a
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
3cdb245b43
Fix broken links
2021-02-28 11:01:07 -05:00
1f68820307
Document how to enable CI LLVM without using `x.py setup`
2021-02-26 15:38:01 -05:00
761f92f390
Remove some unrelated changes
2021-02-26 15:38:01 -05:00
b932cf20cf
Fix typos
2021-02-26 15:38:01 -05:00
ca851c6b70
Restore instructions for using system LLVM
...
They were removed in #1030 , but are still useful.
2021-02-26 15:38:01 -05:00
07b5693a90
Update some out-of-date information
2021-02-26 15:38:01 -05:00
033a1ea771
Fixes typo in getting started guide
2021-02-24 21:20:36 -05:00
9214d4a8c3
Fix formatting of more date references ( #1067 )
2021-02-22 18:22:23 +09:00
c0e7305d33
Fix broken links in query.md ( #1068 )
2021-02-21 09:51:34 +01:00
c4c0f33a1d
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
5297659bb1
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
f5eea60da7
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
fba44ed2fa
Point to main branch on llvm-project's links
2021-02-19 20:25:36 -05:00
42a531c1eb
Fix typo ( #1063 )
2021-02-18 19:37:43 +01:00
5b2ef08416
Update running.md
2021-02-17 17:13:07 -05:00
3708c8227a
Add Oxide paper to bibliography
2021-02-15 10:14:03 -05:00
f525bc8071
Fix typo
2021-02-07 22:12:28 -05:00
219813a75c
Fix typo in Bug Fix Procedure ( #1050 )
2021-02-07 11:15:54 -05:00
95c3930c67
Add chapter on libs and metadata. ( #1044 )
2021-02-04 11:34:52 -05:00
5e57035110
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
bd008cc786
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
85c995de1b
Update test suite descriptions. ( #1042 )
2021-01-30 20:12:01 +09:00
de386fd48a
put `x.py` in ticks
2021-01-30 10:59:57 +02:00
93a25a9fb7
Update links to `librustc_llvm` and `rustllvm`
2021-01-24 08:18:34 -05:00
697dba3bb7
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
d88726cd19
Add missing period
2021-01-21 14:26:25 -05:00
4e48f42e05
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
bee2fd52ce
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
bd8e94a001
Link to `feature_err` in stability section ( #1022 )
2021-01-19 11:47:45 -08:00
a090b28d8e
Fix typo ( #1027 )
2021-01-17 11:50:04 -03:00
176bbba4bf
Note that `--check` now allows using any stage
2021-01-17 05:51:00 +02:00
93fcae6322
improved the readablity of a line
2021-01-16 12:04:07 -05:00
c87ef62351
Fixed a grammatical error in hardawre requirements section
2021-01-16 10:03:23 -05:00
7ea20079df
Corrected MIR file path and fixed a typo ( #1020 )
2021-01-14 14:10:08 -08:00
3e731b7934
Add a note about UI test entry limitation ( #1019 )
2021-01-12 07:55:13 +09:00
0a5bb7f5e6
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
e7ac2ff724
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
d87e197f26
Point to `HirId` instead of `NodeId`
2021-01-09 21:05:10 -05:00
ba9259eaaf
Fix typo ( #1016 )
...
"currenty"!
2021-01-09 17:18:57 -08:00
ed721052a6
Break up long line
2021-01-05 16:13:58 -05:00
a62429b367
Remove backticks and comment about possible bug
2021-01-05 16:13:58 -05:00
df8df90fe9
Update src/compiler-debugging.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-05 16:13:58 -05:00
468faaea87
Make instructions for configuring compiler for debug more explicit
2021-01-05 16:13:58 -05:00
92e47a0559
Remove old sentence that should have been removed
...
It was mistakenly not removed in #997 .
2021-01-04 22:43:03 -05:00
49f1ed8d77
Fix "Potential incomplete link" error on compiler-debugging.md
2021-01-04 20:12:37 -05:00
11b83ebb5a
Add link to rust-analyzer docs on getting started page
2021-01-04 10:09:49 -05:00
a0819a6d98
Fix some typos
2021-01-04 10:02:33 -05:00
de3bdce4b8
Tweak wording around provider purity
2021-01-03 22:31:09 -05:00
64c4632faf
Fix typo (reflex -> reflect)
2021-01-02 09:25:03 -05:00
541976f658
Clarify that `check` uses a different stage than `build` ( #999 )
2021-01-01 20:59:23 +00:00
148742b6ce
Fix broken link for `BoundRegion` ( #998 )
2020-12-31 01:13:49 +01:00
f2e7d46f28
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
e7da4fd769
Fix broken link in the contributing guide ( #996 )
2020-12-29 21:08:55 +01:00
320df682bd
rustc invocation standarized ( #992 )
...
* rustc invocation standarized
* Addressed comments
* Addressed comments
* Addressed comments
* Updated command output
2020-12-28 23:34:51 +01:00
a436d3aedf
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
a17b865540
[ 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
3eb86119dc
Document `error-pattern` header ( #989 )
...
* Document `error-pattern` header
* Address some reviews
2020-12-12 16:06:30 +01:00
1838d293f7
Fix some link failures and typos
2020-12-11 16:00:15 -05:00
a6a9c67616
All links to rustdoc-internals.md
2020-12-10 14:51:04 -05:00
1135856424
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
9f612dace6
Adds a dev guide section on Rust Coverage
2020-12-07 14:22:45 -05:00
edc94c0c84
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
02068c0612
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
55c7be5d83
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
af2aa997d0
fix a couple links
2020-12-03 00:06:19 -05:00
459e414b3a
Use shorter [][]-style link to not pass 100 chars.
2020-12-02 22:34:16 -06:00
3658303988
Apply suggestions from review.
...
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-12-02 22:34:16 -06:00
f7d7e48874
Document SessionDiagnostic
2020-12-02 22:34:16 -06:00
29c66a3f02
Use shorter 'rustbot label' command
...
'rustbot modify labels: ...' -> 'rustbot label ...'
2020-12-01 13:56:48 -05:00
792ccb1523
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
dc72220925
Address feedback
2020-11-30 18:06:43 -05:00
fb6176d2a2
Add notes about running the UI test suite
2020-11-30 18:06:43 -05:00
59de3a0c58
Document what 'sysroot' means
2020-11-29 20:02:55 -05:00
eb8fefbea0
Don't imply that the name of the fork always needs to be changed
2020-11-29 10:42:20 -05:00
4663f85bd0
Add information about common git issues
2020-11-29 10:42:20 -05:00
ad67023401
Fix a typo
2020-11-28 14:09:03 -05:00
f9b3946411
Link to feature-stabilization docs
2020-11-26 20:43:36 -05:00
23b04794db
Move instructions for adding a feature gate to "Feature Gates"
2020-11-26 20:43:36 -05:00
72eca8fcc5
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
5f7bd57942
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
b5af9f07f2
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
8e87c1cf0a
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
da0701b979
add small explanation of why fuel can be useful for debugging
2020-11-22 08:43:00 -05:00
8f5a1440ae
add mir-opt section for optimization fuel
2020-11-22 08:43:00 -05:00
2777deecfa
add string interning wikipedia link ( #960 )
2020-11-15 12:14:06 -05:00
25016aeb3b
Provide a brief example of a data-flow analysis
2020-11-12 11:53:00 -05:00
79b3788fd7
Explain the purpose of the bottom value
2020-11-12 11:53:00 -05:00
9e346c9d17
Add a section on data-flow convergence
2020-11-12 11:53:00 -05:00
f36f645daf
Links to htmldocck/@has/matches for searchability
2020-11-11 19:02:37 -05:00
10869964a7
Update src/compiler-debugging.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-11 10:39:15 -05:00
c15e119fd5
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
b4acbb95ad
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
4e9e17fba4
Fix install command
2020-11-09 09:07:41 +02:00
d0988bcb5d
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
877f5fbdaf
correct minor grammar mistake ( #944 )
...
correct `a lots to `a lot` on implementing_new_features.md
2020-11-08 19:15:22 +01:00
1b43503411
Use `provide_both` link instead of `provide(_extern)`
2020-11-06 19:18:15 -06:00
cc841a185f
Use new-style mdBook internal links in glossary
2020-10-28 18:33:30 -04:00
384eddb2ef
Put `TyCtxt` at the right position
...
It should now be at its alphabetical position.
Also fixed link to `TyCtxt` anchor.
2020-10-28 18:33:30 -04:00
5d6a0cdf69
Fix broken tags in glossary
2020-10-28 18:33:30 -04:00
5b3fd170fc
Small improvements ( #936 )
...
* Fix typo errros -> errors
* an -> a
* hir -> hir()
2020-10-27 19:34:28 +01:00
de4ca80796
Add "ctxt" and `TyCtxt` to the glossary ( #937 )
2020-10-27 19:30:20 +01:00
30c298dd7c
Clean up `compiletest` chapter ( #935 )
2020-10-26 11:58:00 +09:00
53a7fd3ad3
Improve prerequisites section for Windows ( #934 )
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-26 08:15:21 +09:00
b1af2f0c07
Explain lint renaming/removing
2020-10-22 20:41:09 -04:00
47893bacd8
Add reference PRs for `r?` and `r+` comments ( #928 )
2020-10-21 23:53:32 +02:00
97eebb9adb
Replace links to `buildbot2.r-l.o` with `bors.r-l.o`
2020-10-21 17:34:07 -04:00
bd82b75020
Revert "Remove outdated build rustdoc --stage 1"
...
This reverts commit cd35d2b594
2020-10-19 23:17:17 -04:00
cd35d2b594
Remove outdated build rustdoc --stage 1
...
It builds with stage 1 by default.
2020-10-19 22:23:59 -04:00
783c5849c4
Fix typo errros -> errors
2020-10-19 14:11:19 -04:00
b04860c078
Explain why exhaustiveness is necessary for soundness
2020-10-16 18:26:10 -04:00
ada57a32f2
Explain pattern exhaustiveness checking
2020-10-16 18:26:10 -04:00
7f9c36b6a9
Fix a link on git.md
2020-10-15 23:11:33 -04:00
f34dd04a39
Added description of word Scrutinee to the glossary ( #921 )
2020-10-13 01:57:18 +09:00
50f1e77e4a
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-10 12:12:44 -04:00
3f9812cfaa
Talk about git submodules
2020-10-10 12:12:44 -04:00
d1e314f53e
Recommend debug-logging instead of debug
...
This makes the compiler faster to running without sacrificing too much
performance. It still shows logging so contributors aren't confused by
`debug!` doing nothing.
2020-10-08 16:15:06 -05:00
95b1f2b08e
Update more occurrences of system llvm link
2020-10-08 11:47:32 -04:00
e912d1904b
Fix broken "system LLVM" link
2020-10-08 11:47:32 -04:00
2e8a3e8f6d
Fix typos ( #916 )
...
Fixed two typos.
2020-10-08 16:19:56 +09:00
b8cc0a5355
Add section describing git hook functionality
...
This is a companion to [this PR](https://github.com/rust-lang/rust/pull/76356 ), which deals with including functionality for automatically running `tidy --bless` on each commit.
Undo editor auto-formatting and clarify git hook renaming
a word
Phrasing
Apply suggestions from code review
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-07 22:30:24 -04:00
d4581a56ae
Document `Assemble`
2020-10-04 11:59:58 -04:00
10878783ce
Explain stages in terms of the compiler currently running (take N+1) ( #857 )
...
* Explain stages in terms of the compiler currently running
- Address some confusing points
+ stage N+1 -> stage N artifacts
+ Use more likely examples of an ABI break
+ stage N -> stage N compiler
- Mention why rustc occasionally uses `cfg(bootstrap)`
- Note that stage1 is built using two different versions
- Add lots of examples
+ `test src/test/ui` and `test compiler/rustc` run different compilers 😢
+ Separate examples of what to do from examples of what not to do
- 'ship stage 1 artifacts' -> 'ship stage 2 compiler'
This is hopefully less confusing.
* build -> x.py build
* Add section on build artifacts
* Improve wording
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
* uplifted -> assembled
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 16:25:02 +02:00
5b895d7040
Link to .md files, rather than .html
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 10:14:22 -04:00
3f853d5a30
address lingering reviewer comments
2020-10-04 10:14:22 -04:00
e5bf706189
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-04 10:14:22 -04:00
1753f0f10d
add note
2020-10-04 10:14:22 -04:00
9175746a7e
add suggested workflow to setup nightly rustup for rustc
2020-10-04 10:14:22 -04:00
f7870395f5
Did more measurements on what exactly affects llvm-lines:
...
optimize, codegen-units and mir-opt do, but debug-assertions doesn't.
2020-10-04 10:12:47 -04:00
7adeb090fc
Document the usage of cargo-llvm-lines and -Ztimings.
2020-10-04 10:12:47 -04:00
95650a8cbb
Document new way to not build LLVM
...
Implemented in https://github.com/rust-lang/rust/pull/76349
2020-10-03 20:39:32 -04:00
c583e8b982
hir_map -> hir()
2020-10-03 19:38:38 -05:00
47ce12a4c8
Fix time periods for Triage WG procedure
2020-10-03 19:25:05 -05:00
f833b8bcdf
Update src/getting-started.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
080b0c8aad
Update src/getting-started.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
3d6d0e04ed
Add a paragraph about reviewers and review latency in Getting Started chapter
2020-10-03 19:25:05 -05:00
6a5b29b31e
Use HTTPS whenever possible in bibliography links ( #909 )
...
Also updated a few links that redirected.
2020-10-03 22:56:29 +02:00
156423221c
Fix the report link
2020-10-03 16:12:04 -04:00
6159dde37a
Fix instructions for squashing
...
`git merge-base master` does not work, you need
`git merge-base master HEAD` instead.
2020-10-02 15:08:28 -04:00
fdd5946d58
add the last missing code highlight to t-compiler in the docs
2020-10-02 12:37:27 +02:00
a8b7e92c12
Fix typo
2020-09-30 22:39:25 +02:00
c26ab70782
Incorporated suggestions into git page and edit for more brevity.
...
The Advanced Rebasing section has been mostly rewritten to include
both a major suggestion from jyn and a general rewrite. Additional
thanks to camelid for some suggestions!
2020-09-30 10:13:42 -04:00
be11a5201d
Edit using git page for brevity and clarity.
...
The previous iteration of the page was often wordy and
occasionally unclear. This has been cleaned up in places.
Additionally, the TODO in the no-merge policy section has been
removed and addressed.
2020-09-30 10:13:42 -04:00
328bd35e7d
Add a section on using git.
...
This section addresses the biggest issues that new contributors,
especially those with limited familiarity with git, are likely to
face. This is still a WIP.
Thanks to jyn for the recommended improvements!
2020-09-30 10:13:42 -04:00
5ee9d96c07
--verbose is useful when not compiling and when compiling ( #901 )
2020-09-29 17:18:00 +02:00
6b5c62c6f8
Use implicit reference links for shorter lines
...
(As suggested by jyn514.)
2020-09-27 10:37:22 -04:00
e281cf57a6
Fix line length error.
...
Reduced line length to <100 (as indicated by PR build error).
(Also removed extra space character before link.)
2020-09-27 10:37:22 -04:00
35b702bf36
Add links to documentation sources.
...
Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them.
2020-09-27 10:37:22 -04:00
5f39b8131f
Add docs for x.py setup
2020-09-27 04:24:18 +02:00
ea7ee3a503
Add link from "Writing Documentation" suggestion
...
A link to the relevant section of the contributing documentation makes it easier for contributors to locate the relevant information. (e.g. via an in-page search for "doc".)
This is particularly important currently as 85072e3303/CONTRIBUTING.md
2020-09-26 11:52:14 -04:00
c320337018
correct output path in Writing Documentation
2020-09-26 08:45:48 -04:00
e34496fb61
update link to 'BorrowKind' to be implicit in markdown
2020-09-25 22:55:49 -04:00
80537ec118
add link to 'BorrowKind' in closure.md
2020-09-25 22:55:49 -04:00
4a9c3579f3
update description of 'ByRef' borrows of closures
2020-09-25 22:55:49 -04:00
0adf8a36c8
minor punctuation/grammar error fix
2020-09-25 22:55:49 -04:00
d35a4c4bcb
Remove reference to copyright notices.
...
Immediately below the section on copyright notices being removed,
it is mentioned that a particular thing should be placed below the
notices. This seems confusing.
2020-09-24 11:45:35 -04:00
30d03d013f
Link to the -Zmir-opt-level proposal
...
I was confused about what the different levels mean. This PR adds a paragraph that shortly explains the rationale behind different mir-opt-levels and links to the current proposal where there's some information about them.
Let me know if I wrote something unreasonable or incorrect.
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-23 18:42:23 -04:00
22b096ba2f
Don't recommend building the compiler for running tests on the standard library ( #887 )
...
Thought of this while reading https://internals.rust-lang.org/t/contributing-changes-to-std/12829/ .
2020-09-23 15:46:43 +00:00
2a09b06365
`ConstEvalResult` is now `EvalToConstValueResult` ( #885 )
...
Also fixed typo.
2020-09-22 22:52:05 +02:00
447064120f
Improve instructions for adding a new test ( #881 )
...
* Improve instructions for adding a new test
- Add a section for library tests
- Expand section on rustdoc tests
* Address review comments
- Say what should be considered a library test
- Mention adding error numbers to doc tests
- Link to #ui section
- Line wrapping
* Fix incorrect link
It shouldn't have been a link in the first place.
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-09-19 23:40:17 +00:00
1a547f7568
Fix typo in table of contents
2020-09-17 11:35:14 -04:00
f6ba69175b
Revert "Mention that places are sometimes called "lvalues""
...
This reverts commit bf5e1c451d
2020-09-17 11:35:14 -04:00
c758b595b0
Mention that places are sometimes called "lvalues"
2020-09-17 11:35:14 -04:00
deb6710734
More improvements
2020-09-17 11:35:14 -04:00
7ca5568bae
Improve MIR sections in appendix
...
Add a new graphical representation of one of the examples of MIR and
basic blocks!
And make other minor improvements.
2020-09-17 11:35:14 -04:00
ed59c2d47d
debug-logging=true instead of debug-assertions=yes
2020-09-16 21:56:05 -04:00
be58aab880
Add link for `AnalysisDomain::NAME`
2020-09-16 00:21:55 -04:00
a72fe531ce
Describe how to generate graphviz diagrams for dataflow
2020-09-16 00:21:55 -04:00
c911b40be5
Remove EN1
2020-09-15 18:13:33 -04:00
f19d3e64b4
Complete text about salsa base inputs
2020-09-15 18:13:33 -04:00
c99dc88eb8
Add Salsa In More Depth lecture
2020-09-15 18:13:33 -04:00
d4ae7b08a9
Fix typo
...
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-09-14 17:42:19 -05:00
557f8063d3
Make the HIR chapter point to the new chapter on IDs
2020-09-14 17:42:19 -05:00
a87ac24331
Apply suggestions from code review
...
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-14 17:42:19 -05:00
d91788c71d
Add a chapter on all the identifiers used through `rustc`
2020-09-14 17:42:19 -05:00
0520a58b42
Update `Visitor` and `Cursor` examples
2020-09-13 15:58:02 -04:00
92fdaa6c42
Line edits
2020-09-13 15:58:02 -04:00
e8003db79a
Add missing link to `Engine`
2020-09-13 15:58:02 -04:00
ed3d255153
Initial draft of MIR dataflow framework docs
2020-09-13 15:58:02 -04:00
2c733c97e8
correct attribute used here
2020-09-12 18:41:06 -04:00
434556f9e0
Address nits
2020-09-12 13:12:14 -05:00
d333d1e74f
Note that the default is 2015
2020-09-12 13:12:14 -05:00
e7b11c1d89
Document edition flag for UI tests
2020-09-12 13:12:14 -05:00
716adae5ac
Fix typo
2020-09-12 12:07:04 -04:00
e64ac0997e
Hide `@rustdoc` implementation details
2020-09-12 12:07:04 -04:00
ff958b3d4b
Apply suggestions from code review
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-12 12:07:04 -04:00
5fa00e0074
Update src/rustbot.md
2020-09-12 12:07:04 -04:00
3c749064d3
Update src/rustbot.md
2020-09-12 12:07:04 -04:00
1d9675c905
Update src/contributing.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-12 12:07:04 -04:00
58c2b85aa9
Update src/contributing.md
2020-09-12 12:07:04 -04:00
e616159576
Add a chapter on useful `@rustbot` commands
2020-09-12 12:07:04 -04:00
cccee1a93e
Improve link and description of entry points in parser section ( #876 )
...
This seemed to be out of date!
2020-09-12 08:49:05 +09:00
150b915338
Fix typo
...
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-11 13:42:39 +02:00
6366c1dbaa
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-11 13:42:39 +02:00
ee99dea822
Clean up 'Contributing to Rust - Pull Requests'
2020-09-11 13:42:39 +02:00
a85aed08e4
Fix other library commands
2020-09-10 23:56:41 -04:00
b3b8f0ad6c
Fix incorrect docs about stages
...
`build library/core` builds the compiler, not just the standard library.
2020-09-10 23:56:41 -04:00
0b58331de0
Add back information about Googling
...
Also cleaned up some other things.
2020-09-09 22:58:18 -04:00
3c353e4eec
Add back comma
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 22:58:18 -04:00
9e00fdfc93
Add more info about Rustdoc
2020-09-09 22:58:18 -04:00
d145fcdb4e
Update "Helpful Links" section
2020-09-09 22:58:18 -04:00
ab19c3eef8
Use imprecise times, because the time to build depends on your computer
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-09 20:58:30 -04:00
a7ac2cbad6
Minor cleanup for "How to build and run"
2020-09-09 20:58:30 -04:00
91a4afbcc6
broken intra-page link from spanview to graphviz
...
Just noticed the link was not correct. Fixed here.
2020-09-09 19:01:14 -04:00
683cbdda74
Fix nit
2020-09-09 21:39:55 +02:00
987b5ef008
Update src/building/new-target.md
2020-09-09 21:39:55 +02:00
7d54418137
Document how to promote a target from cross-compiled to hosted
2020-09-09 21:39:55 +02:00
af3a92e843
Update src/queries/profiling.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 12:30:56 -04:00
91bfaa8e20
Update def_id.rs location
2020-09-09 12:30:56 -04:00
e1f750feda
Fix typo, hellow -> hello
2020-09-09 12:30:56 -04:00
35af35dd89
Add ./ to run x.py
2020-09-09 12:30:56 -04:00
ab5809b018
Update prerequisites, with an eye towards windows ( #863 )
...
* Update prerequisites, with an eye towards windows
* Address review comments
- Say version of MSVC needed
- Link to more details windows section
- Fix grammar
2020-09-09 16:24:01 +00:00
b29062cb76
Fix broken hyperlink ( #862 )
...
* Fix broken hyperlink
* Link to previous pages instead of skipping ahead
* Fix line lengths
2020-09-09 16:22:56 +00:00
daa7597067
Add information about default stages for x.py
2020-09-09 11:05:26 -04:00
13c18fccbe
Fix typo
2020-09-09 16:58:05 +02:00
75ad441702
Document speculative crate loading ( #859 )
2020-09-09 10:19:01 +03:00
677a95f264
Update error codes to match the current implementation
...
- All codes are in one crate, `rustc_error_codes`
- Extended descriptions are loaded using `include_str!`
- Give an example of a PR adding an error code
2020-09-08 13:59:34 +02:00
fb88941f06
Consolidate information about bootstrapping into one place ( #851 )
...
Previously, 'How to build and run' had a long section on the different
stages of boostrap. But new contributors aren't interested in bootstrap;
they want to start their build (because they heard it takes forever and
want to start it so they aren't waiting more than necessary).
This moves the section on stages into the bootstrapping page, and links
there instead of discussing it on the main page.
2020-09-07 15:25:11 +00:00
d8db731a4a
Document CGU partioning in case of generic and inline functions
2020-09-07 10:07:40 -04:00
d117002719
Update src/building/how-to-build-and-run.md
2020-09-07 08:55:08 -04:00
e69542d0ea
Link to 'prerequisites' immediately
...
Several of the commands on 'how to build' use python.
But we haven't yet told the user how to install it!
Do that first before going into detail on how x.py works.
2020-09-07 08:55:08 -04:00
bb4695345e
Rename src/rustc to compiler/rustc
2020-09-06 16:21:08 +02:00
039e29f77c
update docs to refer to the move
2020-09-03 19:25:02 -04:00
af533030a2
Fix dep-graph-caller-callee test location
2020-09-03 16:21:30 +02:00
b737f79192
Adds documentation to cover spanview output
...
Documents the feature introduced in #76074 .
2020-09-02 12:39:47 +02:00
2924b6962d
Use fewer stages in bootstrapping docs
...
After https://github.com/rust-lang/rust/pull/73964 , they're redundant.
2020-08-31 05:19:36 +02:00
9ab50113c2
Fix misguided suggestions in config.toml
...
- `verbose-tests` is for debugging the test harness, not the tests
themselves. See also https://github.com/rust-lang/rust/pull/76141
- `codegen-units` defaults to `256` whenever `incremental = true`. So
there's no need to explicitly set it to `0` if we already recommend
incremental. See also https://github.com/rust-lang/rustc-dev-guide/pull/795#discussion_r479762977 .
2020-08-31 05:18:50 +02:00
45a1535007
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-31 05:12:13 +02:00
4cb43d8160
fix typos
2020-08-31 05:12:13 +02:00
b259473dd1
fix line lengths
2020-08-31 05:12:13 +02:00
9bb3872dc7
fix links and names after compiler mv to compiler/
2020-08-31 05:12:13 +02:00
76efc9b91f
nits
2020-08-26 08:07:52 -04:00
7e3fe0a961
Apply review suggestion
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-26 13:13:14 +02:00
92499eadd4
Clarify section on MIR construction
2020-08-26 13:13:14 +02:00
401abb9bdf
Add new section to have a local HTTP server easily ( #833 )
2020-08-23 14:36:45 +02:00
844361cb78
fix type in example ( #832 )
...
Because the below explanation says that function type is `fn(u32) -> u32`
2020-08-21 18:54:59 +09:00
76d7b6ac70
Remove duplicate MIR chapter entry ( #830 )
2020-08-19 11:46:02 +00:00
75aa32f7b4
Document how to use build task for x.py check ( #828 )
2020-08-17 23:10:29 +09:00
6a59d0df34
Link ref to edge concept in graph theory
2020-08-17 09:00:47 -04:00
3dcd4e393f
Remove unneeded hashmarks ( #826 )
...
Co-authored-by: Joshua Nelson <jyn514@gmail.com>
2020-08-17 04:51:37 +09:00
f08527cc4b
Address revuew comments
2020-08-16 14:14:35 -05:00
6ff87f49ba
Document serialization in rustc
2020-08-16 14:14:35 -05:00
4657fbcda7
Some small fixes ( #823 )
...
* Fix some typos
* Update from `typeck_tables_of` to `typeck`
* Fix comment
2020-08-11 19:36:48 -04:00
cb51d0e1f0
Use angle brackets to turn URL into a link
2020-08-04 09:50:19 -04:00
f1cf48835d
Fix typo
2020-08-04 09:50:19 -04:00
eb0522c4ac
Fix a broken link
2020-08-04 09:50:19 -04:00
ec373ae12e
Enable a link
2020-08-04 09:50:19 -04:00
44f1ab3bcf
Some small fixes
2020-08-03 11:07:57 -05:00
04bd4ccd97
Fix typo
2020-08-03 11:07:57 -05:00
2cc652be17
Fix: crates -> a list of crates
2020-08-03 11:07:57 -05:00
4db8160fa3
Avoid "whitelist"
...
Fixed according to 62cf767a4a
2020-08-03 11:07:57 -05:00
4e41d060c1
Prefer `::` than `.`
2020-08-02 23:16:01 -05:00
e54d59ca74
Fix link/wording for `parse_nt`
2020-08-02 23:16:01 -05:00
cec6addcaf
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
f8dfca5001
some updates after std libs move
2020-08-02 19:44:04 -05:00
5756aa3ecf
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
6f98316930
mention the overview chapter
2020-08-02 19:44:04 -05:00
fc7b7a5723
Link to overview ch instead of internals
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
0dab310a1b
missing link
2020-08-02 19:44:04 -05:00
abd77148a4
add a bit more discussion of big picture
2020-08-02 19:44:04 -05:00
041e86cb95
fix typo
2020-08-02 19:44:04 -05:00
146635d7ff
line length
2020-08-02 19:44:04 -05:00
80c2dfd9d6
rewrite/update compiler source code chapter
2020-08-02 19:44:04 -05:00
61824dde4f
Mention `HAIR` to clarify
2020-08-02 08:39:33 -05:00
d89c8c9b12
Rename `HAIR` to `THIR`
2020-08-02 08:39:33 -05:00
c7a3bca829
Adjust mentions about CI to GitHub Actions
2020-08-02 08:38:26 -05:00
f8012dbf42
Rename `src/libstd` to `library/std` etc. ( #815 )
2020-07-30 22:47:22 +09:00
5bde3efd90
Add basic steps for a new target ( #805 )
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-07-29 04:41:28 +09:00
eeca3757b8
Update docs to match the new x.py defaults ( #813 )
2020-07-29 04:20:00 +09:00
e20ac5d64b
Add RISC-V notification group instructions ( #814 )
...
* Clean-up notification groups instructions
* Add RISC-V notification group instructions
* Re-order summary of notification groups
* Add a list of the notification groups
* Apply review suggestion
2020-07-28 19:06:07 +02:00
87a11a3045
Fix MIR to LLVM IR sentence ( #811 )
2020-07-28 05:03:37 +09:00
fd458b988c
Expand on the documentation for polymorphization. ( #803 )
...
This commit elaborates on the existing documentation for
polymorphization now that polymorphization has almost landed
in rustc.
Signed-off-by: David Wood <david@davidtw.co>
2020-07-22 19:42:50 +09:00
aecb593979
Fix links for cranelift ( #809 )
2020-07-22 19:32:21 +09:00
63536944b0
Fixes menu for rustdoc page ( #804 )
2020-07-18 19:18:06 +09:00
26adefdb05
Clean-up minor issues ( #802 )
2020-07-18 00:00:34 +09:00
467d429597
Update chat info to reflect decision to close down Discord `#compiler`. ( #800 )
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-07-17 13:01:31 +09:00
e403d51932
Change `rustc::*` to `rustc_middle::*` ( #798 )
2020-07-16 11:13:49 +09:00
3078d380cf
Resync config.toml and suggest better settings
2020-07-14 15:03:16 -05:00
2c49ec2367
Fix typos
2020-07-14 14:26:41 -05:00
37ab8da24d
Fix distortions of "representation"
2020-07-14 14:26:41 -05:00
f196779cbe
Improve getting-started guide
...
- Clean up wording
- Suggest `build --stage 1 src/libstd`, which doesn't recompile rustc
twice unnecessarily
- Fix rustdoc globs which only work on Linux
- Add suggestion for `build --stage 0 src/libstd`
- Suggest `-j1` for very slow builds
- Suggesting letting CI run tests when using a slow machine
2020-07-14 14:24:40 -05:00
d3e682e590
Fix the difference of title in appendix A ( #793 )
2020-07-14 10:06:22 +09:00
3394e1696a
Earlier clarification of pFCP abbreviation ( #791 )
2020-07-12 10:29:17 +09:00
745c831429
Fix typo: review -> reviewer
2020-07-11 09:30:19 -05:00
b04ff74782
inluding -> including
2020-07-10 16:47:54 -05:00
954802cc68
Canonicalize part 1 name ( #788 )
2020-07-05 08:19:10 +09:00
f3339032d6
Suggest selectively disabling optimizations
2020-07-04 18:06:41 -05:00
eb07beaf8e
Update bug report links.
2020-07-04 13:09:55 -05:00
87b9ecf2bb
Fix link for armhf-gnu Dockerfile
2020-07-04 13:06:27 -05:00
689eca469d
Update docs on using Docker images.
2020-07-04 12:44:57 -05:00
2c51b6f628
Fix jump marker of debruijn index ( #783 )
2020-07-04 00:31:52 +09:00
30518e3df2
Minor updates to stage docs. ( #781 )
2020-07-04 00:28:44 +09:00
7a42bf2c92
add stub inline asm chapter ( #773 )
2020-07-03 07:37:29 +09:00
bd1801c8b9
Fix the names of table of contents and heading are different
...
Not to write the part of Appendix `A` in heading along with other appendix.
2020-07-02 15:44:52 -05:00
b85f30d013
fix links
2020-07-01 22:07:52 -05:00
00b67a55de
Escape other non-link
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
c2c219af6c
Fix non-link
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
e82626f802
fix links
2020-07-01 22:07:52 -05:00
dbaa12ec12
fix links
2020-07-01 22:07:52 -05:00
431df827e2
line length
2020-07-01 22:07:52 -05:00
b1198eff6b
move CONTRIBUTING.md to rustc-dev-guide
2020-07-01 22:07:52 -05:00
0006f19915
Edit Part 2 introduction ( #777 )
...
* Edit Part 2 introduction
* needs a pause
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-07-01 13:26:25 +02:00
fe7856889a
fix file name
2020-06-30 16:04:28 -05:00
99745b9931
Move Getting Started to a "prefix chapter"
2020-06-30 16:04:10 -05:00
fd4c83f4ab
Move Errors and Lints to Analysis
2020-06-30 16:03:50 -05:00
19f7d2e77d
Rename resolvers following the latest rustc change ( #776 )
2020-06-30 16:22:38 +02:00
2c6f17671f
Edit ty.md
...
Makes various edits throughout for formatting, punctuation, and typo fixes.
Also makes some edits and re-wording for clarity.
2020-06-28 18:39:46 -05:00
be8c8bb7bc
Fix line lengths
2020-06-28 12:15:23 -05:00
1c68f636cf
Improve wording and fix typos
...
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-06-28 12:15:23 -05:00
c1c66a82f2
Revamp bootstrapping section
...
- Move most of the overview to building/bootstrapping.md
- Add things besides stages to bootstrapping.md
2020-06-28 12:15:23 -05:00
b7095995aa
Add 'recovery' to the gloassary
2020-06-27 11:05:32 -05:00
e7db51faca
Fix formatting
2020-06-24 21:38:54 -05:00
093b9032de
Upgrade to mdbook 0.4 and switch to book parts ( #764 )
...
* upgrade to mdbook 0.4 and switch to book parts
* update linkcheck
* fix links, update about-this-guide
2020-06-24 14:47:50 -03:00
2e104620d1
Move x.py commands to overview
2020-06-23 17:40:16 -05:00
4329b8e91a
Split up rustdoc page
2020-06-23 17:40:16 -05:00
b8065faa0f
Move rustdoc to 'How to build the compiler'
...
The old layout was less about rustdoc and more about the compiler:
"Here is an example of a project using rustc_interface".
This gives focus to rustdoc on something you might want to work on for
its own sake. It also makes the page much easier to find for newcomers.
2020-06-23 17:40:16 -05:00
917f7efa28
Small spelling fix.
2020-06-23 12:44:15 -05:00
ca5591815c
address review comments
2020-06-23 12:42:06 -05:00
f85ef8ec94
Add prerequisite page
2020-06-23 12:42:06 -05:00
21ee99e5af
add suggestion style guide
...
The guide is based on [existing rustdoc].
[existing rustdoc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_errors/struct.Diagnostic.html#method.span_suggestion
2020-06-23 12:35:07 -05:00
d103f0d897
Fix links for now.
2020-06-23 00:35:54 -05:00
34df55db77
Add information about size for building the Rust Compiler
...
The Rust codebase is large, not to mention the submodules. It would be helpful for some to have a warning or note about storage required before they spend possible hours to build, only to get a message in some form that they are running out/already out of storage. I did a stage1 build incrementally and it produced a build directory of about 14 gigabytes.
2020-06-22 15:48:14 -05:00
a10ba12047
Fix master branch links ( #757 )
...
* fix links
* some debugging
* more debugging
* fix git checkout in ci
* try again
* already tests with a merge
* Typo
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-06-21 20:25:43 +02:00
45e540ca81
new tykind::error convention ( #715 )
2020-06-19 07:55:58 +02:00
6c580ad664
fix line length
2020-06-18 12:16:00 -05:00
f880b1b21a
address a bunch of review comments
2020-06-18 12:16:00 -05:00
d90acc8e37
LeSeulArtichaut wording/typo fixes
...
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
c99d5245be
address review comments
2020-06-18 12:16:00 -05:00
46099c094e
Apply suggestions from code review
...
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
814d27d760
Better wording
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
e1c7b6ce92
Slightly reorganize to first present the slow command then the fast commands
2020-06-18 12:16:00 -05:00
db004ad24f
add a note about disk space
2020-06-18 12:16:00 -05:00
e72e2c5613
python 3 also
2020-06-18 12:16:00 -05:00
aa9b3ecc22
Apply suggestions from code review
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
Co-authored-by: Phil Hansch <dev@phansch.net>
2020-06-18 12:16:00 -05:00
69baf677ef
add forge
2020-06-18 12:16:00 -05:00
5ff627e2d5
Apply suggestions from code review
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
5784b6cb92
add note on submodules
2020-06-18 12:16:00 -05:00
e2620a8199
add a bit more
2020-06-18 12:16:00 -05:00
2abbee9b5c
fix link
2020-06-18 12:16:00 -05:00
b5e41a5e0c
mention incremental disk space
2020-06-18 12:16:00 -05:00
73d88a1385
a couple more small changes
2020-06-18 12:16:00 -05:00
d255b4a0cb
some minor updates
2020-06-18 12:16:00 -05:00
Tshepang Mbambo
jonathanCogan
Jhonny Bill Mena
Santiago Pastorino
Rageking8
Chris Denton
Eric Huss
Michael Goulet
Nilstrieb
Lukas Wirth
Luqman Aden
lcnr
Sergio de Carvalho
Marc Poulhiès
Joshument
David Wood
Pietro Albini
Bruno Kolenbrander
Joshua Nelson
Ralf Jung
Yuki Okushi
Alex Saveau
Waffle Maybe
Felix S Klock II
Oli Scherer
Joshua Nelson
Devin Jeanpierre
Eric Holk
Xiretza
Samyak Sarnayak
est31
Micah Weston
SparrowLii
Nathan Stocks
est31
yukang
Noah Lev
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
Samuel Moelius
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
Ramon de C Valle
Rémy Rakic
Yusuke Abe
Tomasz Miąsko
Oli Scherer
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
Nixon Enraght-Moony
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
Joshua Nitschke
Nadrieril
Joshua Nelson
Ivan Tham
1c3t3a
mautamu
Cass
Julian Wollersberger
Aleksey Kladov
Camelid
Roman
Jakob Degen
follower
Shahar Or (mightyiam)
Youngsuk_Kim
Dániel Buga
Macdonald Umoren
Monadic Cat
Aman Arora
Guillaume Gomez
Gurwinder Singh
Lzu Tao
Matthew Jasper
Takayuki Nakata
Jake Goulding
David Wood
Federico Ponzi
Ivan Veselov
Matt Kraai
Aaron Hill
Drew Youngwerth
Florian Gilcher
Andy Russell
ThePuzzlemaker