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
3f33422aab
correct minor grammar mistake ( #944 )
...
correct `a lots to `a lot` on implementing_new_features.md
2020-11-08 19:15:22 +01:00
3de0132a0d
Use `provide_both` link instead of `provide(_extern)`
2020-11-06 19:18:15 -06:00
17c77b296e
Use new-style mdBook internal links in glossary
2020-10-28 18:33:30 -04:00
5b6f343c87
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
bbcf9282ac
Fix broken tags in glossary
2020-10-28 18:33:30 -04:00
c2606a6d54
Small improvements ( #936 )
...
* Fix typo errros -> errors
* an -> a
* hir -> hir()
2020-10-27 19:34:28 +01:00
bec1897ef7
Add "ctxt" and `TyCtxt` to the glossary ( #937 )
2020-10-27 19:30:20 +01:00
e58307a28e
Clean up `compiletest` chapter ( #935 )
2020-10-26 11:58:00 +09:00
e55ee68ed0
Improve prerequisites section for Windows ( #934 )
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-26 08:15:21 +09:00
f0cd34e615
Explain lint renaming/removing
2020-10-22 20:41:09 -04:00
61feec113f
Add reference PRs for `r?` and `r+` comments ( #928 )
2020-10-21 23:53:32 +02:00
a6279510e2
Replace links to `buildbot2.r-l.o` with `bors.r-l.o`
2020-10-21 17:34:07 -04:00
ee849ff66e
Revert "Remove outdated build rustdoc --stage 1"
...
This reverts commit cd35d2b594
2020-10-19 23:17:17 -04:00
e4a7be5779
Remove outdated build rustdoc --stage 1
...
It builds with stage 1 by default.
2020-10-19 22:23:59 -04:00
269158b77e
Fix typo errros -> errors
2020-10-19 14:11:19 -04:00
d859c9924e
Explain why exhaustiveness is necessary for soundness
2020-10-16 18:26:10 -04:00
5ddfd9bfe9
Explain pattern exhaustiveness checking
2020-10-16 18:26:10 -04:00
2b1e754e83
Fix a link on git.md
2020-10-15 23:11:33 -04:00
5f06872226
Added description of word Scrutinee to the glossary ( #921 )
2020-10-13 01:57:18 +09:00
66649d9c81
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-10 12:12:44 -04:00
eee78ac90f
Talk about git submodules
2020-10-10 12:12:44 -04:00
d056730692
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
1ae9303960
Update more occurrences of system llvm link
2020-10-08 11:47:32 -04:00
ac6fb7efa1
Fix broken "system LLVM" link
2020-10-08 11:47:32 -04:00
db41bec0c9
Fix typos ( #916 )
...
Fixed two typos.
2020-10-08 16:19:56 +09:00
9ccc69f152
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
5fabea540a
Document `Assemble`
2020-10-04 11:59:58 -04:00
fcc93a7043
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
3b4462f582
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
42173ef770
address lingering reviewer comments
2020-10-04 10:14:22 -04:00
08d244e06c
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-04 10:14:22 -04:00
58255429d8
add note
2020-10-04 10:14:22 -04:00
c3a67e32dc
add suggested workflow to setup nightly rustup for rustc
2020-10-04 10:14:22 -04:00
9a46f17fab
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
476dd40f63
Document the usage of cargo-llvm-lines and -Ztimings.
2020-10-04 10:12:47 -04:00
d1651dbd5e
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
773b3c3e95
hir_map -> hir()
2020-10-03 19:38:38 -05:00
efb9029fc8
Fix time periods for Triage WG procedure
2020-10-03 19:25:05 -05:00
c63a20ccbf
Update src/getting-started.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
d3f37158ac
Update src/getting-started.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
ff894213a7
Add a paragraph about reviewers and review latency in Getting Started chapter
2020-10-03 19:25:05 -05:00
b431d8211c
Use HTTPS whenever possible in bibliography links ( #909 )
...
Also updated a few links that redirected.
2020-10-03 22:56:29 +02:00
b61231e905
Fix the report link
2020-10-03 16:12:04 -04:00
d9a98418f7
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
62ae93b3a3
add the last missing code highlight to t-compiler in the docs
2020-10-02 12:37:27 +02:00
1c59aa9409
Fix typo
2020-09-30 22:39:25 +02:00
7f590fa025
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
fb23f10071
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
7fdae85e96
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
915fabf4cc
--verbose is useful when not compiling and when compiling ( #901 )
2020-09-29 17:18:00 +02:00
506f2e77c1
Use implicit reference links for shorter lines
...
(As suggested by jyn514.)
2020-09-27 10:37:22 -04:00
e2a1deb657
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
1e77d7f743
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
edc31ef0bc
Add docs for x.py setup
2020-09-27 04:24:18 +02:00
3ac6fc75ef
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
2ad2cb7c97
correct output path in Writing Documentation
2020-09-26 08:45:48 -04:00
18c7583466
update link to 'BorrowKind' to be implicit in markdown
2020-09-25 22:55:49 -04:00
49611100bf
add link to 'BorrowKind' in closure.md
2020-09-25 22:55:49 -04:00
06fdc4321e
update description of 'ByRef' borrows of closures
2020-09-25 22:55:49 -04:00
a0958b664c
minor punctuation/grammar error fix
2020-09-25 22:55:49 -04:00
b7970e6c5e
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
727a536ba9
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
7609eb11ee
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
ca00e2eefe
`ConstEvalResult` is now `EvalToConstValueResult` ( #885 )
...
Also fixed typo.
2020-09-22 22:52:05 +02:00
9c5e356ed5
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
27ff56d829
Fix typo in table of contents
2020-09-17 11:35:14 -04:00
0a80107e34
Revert "Mention that places are sometimes called "lvalues""
...
This reverts commit bf5e1c451d
2020-09-17 11:35:14 -04:00
e645304ce9
Mention that places are sometimes called "lvalues"
2020-09-17 11:35:14 -04:00
fd525a93d6
More improvements
2020-09-17 11:35:14 -04:00
231e3d9c83
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
7bda848e3c
debug-logging=true instead of debug-assertions=yes
2020-09-16 21:56:05 -04:00
42be58a751
Add link for `AnalysisDomain::NAME`
2020-09-16 00:21:55 -04:00
ca60ec06df
Describe how to generate graphviz diagrams for dataflow
2020-09-16 00:21:55 -04:00
9f4e7038fa
Remove EN1
2020-09-15 18:13:33 -04:00
a7d0f3f2dd
Complete text about salsa base inputs
2020-09-15 18:13:33 -04:00
6cf849f63b
Add Salsa In More Depth lecture
2020-09-15 18:13:33 -04:00
0d2b8eb1c4
Fix typo
...
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-09-14 17:42:19 -05:00
e6a94b2355
Make the HIR chapter point to the new chapter on IDs
2020-09-14 17:42:19 -05:00
c7ec4769ab
Apply suggestions from code review
...
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-14 17:42:19 -05:00
fe19fc65f2
Add a chapter on all the identifiers used through `rustc`
2020-09-14 17:42:19 -05:00
1fffd48313
Update `Visitor` and `Cursor` examples
2020-09-13 15:58:02 -04:00
ddc23efa5f
Line edits
2020-09-13 15:58:02 -04:00
0cc3a9f8f3
Add missing link to `Engine`
2020-09-13 15:58:02 -04:00
3db7809e77
Initial draft of MIR dataflow framework docs
2020-09-13 15:58:02 -04:00
3b5a774a61
correct attribute used here
2020-09-12 18:41:06 -04:00
7e42258f16
Address nits
2020-09-12 13:12:14 -05:00
01c34848a3
Note that the default is 2015
2020-09-12 13:12:14 -05:00
71853f5a5c
Document edition flag for UI tests
2020-09-12 13:12:14 -05:00
eb39e07c58
Fix typo
2020-09-12 12:07:04 -04:00
5ff253c02a
Hide `@rustdoc` implementation details
2020-09-12 12:07:04 -04:00
ab47942c65
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
ade9b19f51
Update src/rustbot.md
2020-09-12 12:07:04 -04:00
9f396a3f1e
Update src/rustbot.md
2020-09-12 12:07:04 -04:00
317a5b33a4
Update src/contributing.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-12 12:07:04 -04:00
28ca77209b
Update src/contributing.md
2020-09-12 12:07:04 -04:00
a9264c50d6
Add a chapter on useful `@rustbot` commands
2020-09-12 12:07:04 -04:00
2ac4ba41ef
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
4a8945792e
Fix typo
...
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-11 13:42:39 +02:00
57794fe4dc
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-11 13:42:39 +02:00
d26f268757
Clean up 'Contributing to Rust - Pull Requests'
2020-09-11 13:42:39 +02:00
81f52ce0db
Fix other library commands
2020-09-10 23:56:41 -04:00
86e02cda81
Fix incorrect docs about stages
...
`build library/core` builds the compiler, not just the standard library.
2020-09-10 23:56:41 -04:00
f0d769ea49
Add back information about Googling
...
Also cleaned up some other things.
2020-09-09 22:58:18 -04:00
53a9cde26c
Add back comma
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 22:58:18 -04:00
38d726f367
Add more info about Rustdoc
2020-09-09 22:58:18 -04:00
dd3b2059b6
Update "Helpful Links" section
2020-09-09 22:58:18 -04:00
185f43c746
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
350ee4b260
Minor cleanup for "How to build and run"
2020-09-09 20:58:30 -04:00
ca3b0a5571
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
f3b5db1057
Fix nit
2020-09-09 21:39:55 +02:00
dc0cff54bb
Update src/building/new-target.md
2020-09-09 21:39:55 +02:00
059ad38ddf
Document how to promote a target from cross-compiled to hosted
2020-09-09 21:39:55 +02:00
3d0543b644
Update src/queries/profiling.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 12:30:56 -04:00
2d1322d62e
Update def_id.rs location
2020-09-09 12:30:56 -04:00
8638351e9d
Fix typo, hellow -> hello
2020-09-09 12:30:56 -04:00
6d3eb2bc75
Add ./ to run x.py
2020-09-09 12:30:56 -04:00
6dd6d868e5
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
808774289f
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
8623da3dab
Add information about default stages for x.py
2020-09-09 11:05:26 -04:00
794b32feac
Fix typo
2020-09-09 16:58:05 +02:00
45f6000c37
Document speculative crate loading ( #859 )
2020-09-09 10:19:01 +03:00
60f15f096e
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
1b40f033d2
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
cc121cd4c5
Document CGU partioning in case of generic and inline functions
2020-09-07 10:07:40 -04:00
68407cbe37
Update src/building/how-to-build-and-run.md
2020-09-07 08:55:08 -04:00
5fac3dca3d
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
33efb2a2ab
Rename src/rustc to compiler/rustc
2020-09-06 16:21:08 +02:00
4ce4873606
update docs to refer to the move
2020-09-03 19:25:02 -04:00
1519df6945
Fix dep-graph-caller-callee test location
2020-09-03 16:21:30 +02:00
7b4ab23cc7
Adds documentation to cover spanview output
...
Documents the feature introduced in #76074 .
2020-09-02 12:39:47 +02:00
4411cf2001
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
f6b1f9d49d
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
b3e17b1b1f
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-31 05:12:13 +02:00
54ffd393c9
fix typos
2020-08-31 05:12:13 +02:00
b361ef92ac
fix line lengths
2020-08-31 05:12:13 +02:00
89f0b60ccc
fix links and names after compiler mv to compiler/
2020-08-31 05:12:13 +02:00
cd2f461d9c
nits
2020-08-26 08:07:52 -04:00
51da18c90d
Apply review suggestion
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-26 13:13:14 +02:00
014d434f46
Clarify section on MIR construction
2020-08-26 13:13:14 +02:00
a49fce9a12
Add new section to have a local HTTP server easily ( #833 )
2020-08-23 14:36:45 +02:00
9b803e1dfe
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
908d4ff483
Remove duplicate MIR chapter entry ( #830 )
2020-08-19 11:46:02 +00:00
776e14a3f0
Document how to use build task for x.py check ( #828 )
2020-08-17 23:10:29 +09:00
8effbe65b6
Link ref to edge concept in graph theory
2020-08-17 09:00:47 -04:00
369ec46a1b
Remove unneeded hashmarks ( #826 )
...
Co-authored-by: Joshua Nelson <jyn514@gmail.com>
2020-08-17 04:51:37 +09:00
0ecf777a50
Address revuew comments
2020-08-16 14:14:35 -05:00
281526c5a2
Document serialization in rustc
2020-08-16 14:14:35 -05:00
463489182d
Some small fixes ( #823 )
...
* Fix some typos
* Update from `typeck_tables_of` to `typeck`
* Fix comment
2020-08-11 19:36:48 -04:00
5462868f4b
Use angle brackets to turn URL into a link
2020-08-04 09:50:19 -04:00
68daabb4bf
Fix typo
2020-08-04 09:50:19 -04:00
1fd664124d
Fix a broken link
2020-08-04 09:50:19 -04:00
f24f0b15e0
Enable a link
2020-08-04 09:50:19 -04:00
574f709928
Some small fixes
2020-08-03 11:07:57 -05:00
cb87579a2f
Fix typo
2020-08-03 11:07:57 -05:00
e7b3cd7f6a
Fix: crates -> a list of crates
2020-08-03 11:07:57 -05:00
ff9814cc3c
Avoid "whitelist"
...
Fixed according to 62cf767a4a
2020-08-03 11:07:57 -05:00
9522f3e934
Prefer `::` than `.`
2020-08-02 23:16:01 -05:00
65770bcd1f
Fix link/wording for `parse_nt`
2020-08-02 23:16:01 -05:00
14c2f80da2
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
a8eab86aa0
some updates after std libs move
2020-08-02 19:44:04 -05:00
c693f66a8e
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
8e76708b6c
mention the overview chapter
2020-08-02 19:44:04 -05:00
12bf5b4747
Link to overview ch instead of internals
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
e10dbb8586
missing link
2020-08-02 19:44:04 -05:00
a9024bd3b2
add a bit more discussion of big picture
2020-08-02 19:44:04 -05:00
a1ef8389eb
fix typo
2020-08-02 19:44:04 -05:00
63a0c1f3da
line length
2020-08-02 19:44:04 -05:00
3852cb1592
rewrite/update compiler source code chapter
2020-08-02 19:44:04 -05:00
f31532d3b2
Mention `HAIR` to clarify
2020-08-02 08:39:33 -05:00
8a3e706aca
Rename `HAIR` to `THIR`
2020-08-02 08:39:33 -05:00
9c351189e9
Adjust mentions about CI to GitHub Actions
2020-08-02 08:38:26 -05:00
68a2b034c5
Rename `src/libstd` to `library/std` etc. ( #815 )
2020-07-30 22:47:22 +09:00
38aef99f68
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
879ca582de
Update docs to match the new x.py defaults ( #813 )
2020-07-29 04:20:00 +09:00
593facff2a
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
a99182921c
Fix MIR to LLVM IR sentence ( #811 )
2020-07-28 05:03:37 +09:00
50706fc2a2
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
bc72178000
Fix links for cranelift ( #809 )
2020-07-22 19:32:21 +09:00
ed2e2b1d3f
Fixes menu for rustdoc page ( #804 )
2020-07-18 19:18:06 +09:00
9085f687dd
Clean-up minor issues ( #802 )
2020-07-18 00:00:34 +09:00
aca4e6b2a4
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
973ced6951
Change `rustc::*` to `rustc_middle::*` ( #798 )
2020-07-16 11:13:49 +09:00
a93d729018
Resync config.toml and suggest better settings
2020-07-14 15:03:16 -05:00
bda916e75d
Fix typos
2020-07-14 14:26:41 -05:00
1e14491218
Fix distortions of "representation"
2020-07-14 14:26:41 -05:00
a03162ec35
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
e2389e57d8
Fix the difference of title in appendix A ( #793 )
2020-07-14 10:06:22 +09:00
87554a233a
Earlier clarification of pFCP abbreviation ( #791 )
2020-07-12 10:29:17 +09:00
a744c0ae04
Fix typo: review -> reviewer
2020-07-11 09:30:19 -05:00
e17cf59c30
inluding -> including
2020-07-10 16:47:54 -05:00
e89e5fecc5
Canonicalize part 1 name ( #788 )
2020-07-05 08:19:10 +09:00
6889dcc7d5
Suggest selectively disabling optimizations
2020-07-04 18:06:41 -05:00
20e080bf38
Update bug report links.
2020-07-04 13:09:55 -05:00
85b8077831
Fix link for armhf-gnu Dockerfile
2020-07-04 13:06:27 -05:00
401d0bf12b
Update docs on using Docker images.
2020-07-04 12:44:57 -05:00
45fb510957
Fix jump marker of debruijn index ( #783 )
2020-07-04 00:31:52 +09:00
434631397b
Minor updates to stage docs. ( #781 )
2020-07-04 00:28:44 +09:00
f86c34e7d7
add stub inline asm chapter ( #773 )
2020-07-03 07:37:29 +09:00
0fd8abe5bf
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
27b9565b71
fix links
2020-07-01 22:07:52 -05:00
92cbc030cd
Escape other non-link
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
d3c6f899cb
Fix non-link
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
6bc1c18282
fix links
2020-07-01 22:07:52 -05:00
638073deb1
fix links
2020-07-01 22:07:52 -05:00
6796449f88
line length
2020-07-01 22:07:52 -05:00
60b8d21d5c
move CONTRIBUTING.md to rustc-dev-guide
2020-07-01 22:07:52 -05:00
431c3a3be2
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
3d657229ad
fix file name
2020-06-30 16:04:28 -05:00
342c4b7ba9
Move Getting Started to a "prefix chapter"
2020-06-30 16:04:10 -05:00
3e6097db7e
Move Errors and Lints to Analysis
2020-06-30 16:03:50 -05:00
38d14755b3
Rename resolvers following the latest rustc change ( #776 )
2020-06-30 16:22:38 +02:00
d18ab7154a
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
089dd18f03
Fix line lengths
2020-06-28 12:15:23 -05:00
e4d6bfe303
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
38e0461def
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
e362fdc8c7
Add 'recovery' to the gloassary
2020-06-27 11:05:32 -05:00
7884fdfdb0
Fix formatting
2020-06-24 21:38:54 -05:00
32c4f1aa61
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
541f88e8dd
Move x.py commands to overview
2020-06-23 17:40:16 -05:00
bf38f1b6f8
Split up rustdoc page
2020-06-23 17:40:16 -05:00
ee73a81989
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
cb950b77e8
Small spelling fix.
2020-06-23 12:44:15 -05:00
93c21dd722
address review comments
2020-06-23 12:42:06 -05:00
59e5e68074
Add prerequisite page
2020-06-23 12:42:06 -05:00
20d3370db9
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
98a67dc23b
Fix links for now.
2020-06-23 00:35:54 -05:00
c398a14f33
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
8011445536
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
92fafef00a
new tykind::error convention ( #715 )
2020-06-19 07:55:58 +02:00
8017824161
fix line length
2020-06-18 12:16:00 -05:00
b5864347d0
address a bunch of review comments
2020-06-18 12:16:00 -05:00
d94394322b
LeSeulArtichaut wording/typo fixes
...
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
d4056d0820
address review comments
2020-06-18 12:16:00 -05:00
b24d9eb1fa
Apply suggestions from code review
...
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
28ccf26223
Better wording
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
4250a4030a
Slightly reorganize to first present the slow command then the fast commands
2020-06-18 12:16:00 -05:00
d829ce6f9b
add a note about disk space
2020-06-18 12:16:00 -05:00
0acd363057
python 3 also
2020-06-18 12:16:00 -05:00
b7e8d5f398
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
c6766dfb7c
add forge
2020-06-18 12:16:00 -05:00
e492cf389b
Apply suggestions from code review
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
5e2d3c35ed
add note on submodules
2020-06-18 12:16:00 -05:00
3bedf5c442
add a bit more
2020-06-18 12:16:00 -05:00
a9a82c4420
fix link
2020-06-18 12:16:00 -05:00
1f0f15f380
mention incremental disk space
2020-06-18 12:16:00 -05:00
6e482fb047
a couple more small changes
2020-06-18 12:16:00 -05:00
96a7a9a49c
some minor updates
2020-06-18 12:16:00 -05:00
7942336575
write about processes
2020-06-18 12:16:00 -05:00
655b6ba886
address some review comments
2020-06-18 12:16:00 -05:00
78e224ca52
Typo fixes
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
4cbb4c384e
start a getting started guide
2020-06-18 12:16:00 -05:00
7c51350dfc
Add a link to the forge procedure on adding new options. ( #754 )
2020-06-18 10:33:15 +02:00
b5be6012f6
Don't give `x.py clean` as the first x.py example
...
This command shouldn't be used very often, and it has its own whole
section below anyway.
2020-06-18 04:41:59 +02:00
7e3da5c2ee
Document rustdoc behavior
...
- `RUSTDOC_LOG`
- `// aux-build:filename.rs`
- `// build-aux-docs`
2020-06-17 09:24:41 -05:00
6d921020b6
Add some more detail on compiletest normalization.
2020-06-16 23:14:05 -05:00
4c48d4c0eb
tag/niche terminology ( #747 )
2020-06-11 12:38:42 +02:00
a50d9c590a
Clean up the paragraph about aliases for pinging the notification groups ( #743 )
...
* Clean up the paragraph about aliases for pinging the notification groups
* Add windows and arm command invocations
Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
2020-06-10 18:04:19 -04:00
78b302c3a9
Include "Lint" in the title of the diagnostics chapter ( #742 )
2020-06-10 15:19:59 -03:00
a7a83e664d
complete the ICE-breaker => notification group rename
2020-06-09 18:03:33 -05:00
df8ee5af1f
add the ARM notification group ( #740 )
2020-06-09 23:58:22 +02:00
d152893e86
Rebrand ICE-breakers, introduce Windows notification group ( #739 )
...
* rename ice-breakers to the more general notification-group
also less confusing
* add windows notification group
* rebrand LLVM ICE-breakers as a "notification group"
* include the link to example windows PR
2020-06-09 16:42:00 -03:00
df23757b09
Document needs-* compiletest directives
2020-06-08 12:33:35 -05:00
98d000fb3c
Add a bit about various type system concepts ( #697 )
...
* add a bit on dataflow analysis
* add a bit on quanitification
* add a bit on debruijn index
* add a bit on early and late bound params
* add missing link
* Typos
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
* clarify dataflow example
* fix formatting
* fix typos
* Typos
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
* fix errors in background
* remove dup material and make early/late intro short
* adjust intro
* Niko's intro
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2020-06-05 13:11:09 -03:00
e74b4ab3a4
update conventions ( #735 )
...
* update conventions
* typo
Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
2020-06-05 13:06:39 -03:00
f9c6c1b117
braces
2020-06-05 10:34:56 -05:00
c9f49c6581
words
2020-06-05 10:33:15 -05:00
138c73f545
Fix link ( #734 )
2020-06-05 17:10:01 +02:00
c4590c0644
Add more info on useful workflows ( #727 )
...
* Add more info on useful workflows
* Apply suggestions from code review
Co-authored-by: mark-i-m <mark-i-m@users.noreply.github.com>
Co-authored-by: spastorino <spastorino@gmail.com>
Co-authored-by: mark-i-m <mark-i-m@users.noreply.github.com>
Co-authored-by: spastorino <spastorino@gmail.com>
2020-06-03 22:46:04 +02:00
6b85d54752
Update lint declaration example ( #713 )
2020-05-30 08:49:25 +09:00
01f01823ed
Document more //ignore-X test headers
2020-05-29 13:27:03 -05:00
d56a31f73c
Document remote testing
2020-05-29 13:27:03 -05:00
2b3522a840
Document `RUSTFLAGS_STAGE_` bootstrap environment variables ( #728 )
...
* Document `RUSTFLAGS_STAGE_`
* Fix typos
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-30 01:20:24 +09:00
1036ac82ed
Update src/tests/adding.md
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-28 19:57:59 -05:00
154e750ec5
add documentation of UI test error annotation substring support
2020-05-28 19:57:59 -05:00
f086b737ef
Expand error annotations section with examples ( #724 )
...
* expand error annotations section with examples
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-29 02:43:22 +09:00
3bb5fc53b5
Clarify lint vs fixed diagnostic.
2020-05-27 20:33:46 -05:00
000f04e2f9
Updates from review.
2020-05-27 20:33:46 -05:00
9befa0d9cc
Apply suggestions from code review
...
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-27 20:33:46 -05:00
5ae9e9191e
Add some guidelines on diagnostics.
2020-05-27 20:33:46 -05:00
cf38ea60b2
Apply suggestions from code review
...
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-05-27 15:17:33 -05:00
bc9d1d0d76
Fix typo
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-27 15:17:33 -05:00
fc379a898f
Add definition of `niche` to the glossary
2020-05-27 15:17:33 -05:00
865e5542ad
Move CLI to part 3.
2020-05-27 12:35:13 -05:00
3d077bb26e
Apply suggestions from code review
...
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-05-27 12:35:13 -05:00
8f7abbdf41
Add some guidelines on the CLI.
2020-05-27 12:35:13 -05:00
e4c502318f
It looks like the high-level-overview was renamed ( #721 )
2020-05-28 00:04:56 +09:00
a3287df2ad
Add section for debugging rustc type layouts ( #720 )
2020-05-27 14:17:39 +02:00
523e300c04
Rename `upvars` query to `upvars_mentioned`
2020-05-26 11:05:21 -05:00
85d815d11d
Update docs related to const-eval/Miri ( #676 )
...
* Update docs related to const-eval
Co-authored-by: Ralf Jung <post@ralfj.de>
2020-05-25 17:23:15 +09:00
c777d434f5
Extern blocks are allowed for #[track_caller] now. ( #710 )
...
since https://github.com/rust-lang/rust/pull/70916
2020-05-23 22:40:23 +02:00
9272d05ea7
Fix BodyId link typo in glossary ( #709 )
...
* Fix BodyId link typo in glossary
* Fix broken link to rustc_middle's Predicate
2020-05-23 16:25:53 -04:00
78cf9b2ba1
typo fix ( #706 )
2020-05-19 11:30:27 +09:00
05aee3ef6c
Add missing closing paren ( #705 )
2020-05-16 21:19:52 -04:00
bd6a1ae84d
Update src/appendix/glossary.md
...
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-05-11 23:52:00 +02:00
37322a7f26
glossary: make soundness definition more readable
2020-05-11 23:52:00 +02:00
dc7ffdecc3
fix links ( #702 )
2020-05-11 16:51:33 -03:00
c740ef0a26
glossary: intro feels like not adding much ( #699 )
2020-05-11 07:57:46 +02:00
dcf75a8e60
Fix typo
2020-05-08 12:02:56 -05:00
d7f14b5093
Typo
...
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
692e2799ce
add some section headers
2020-05-08 09:42:27 -05:00
67ab79a722
move discussion of eager expansion to the end
2020-05-08 09:42:27 -05:00
09c665aa12
Use full path of span
...
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
f4824c83c3
Typos
...
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
09a6c18ccb
fix some links
2020-05-08 09:42:27 -05:00
79c7718b63
fix line length
2020-05-08 09:42:27 -05:00
5f5e48f5bd
SPRINKLE ALL THE THINGS
2020-05-08 09:42:27 -05:00
5ab21a1318
sprinkle around a bunch of links
2020-05-08 09:42:27 -05:00
6fee71e345
expand notes on expansion heirarchies
2020-05-08 09:42:27 -05:00
c53e21fdb9
add a bit more info about eager exp
2020-05-08 09:42:27 -05:00
1471e109c2
expand some notes about expansion :P
2020-05-08 09:42:27 -05:00
07b7e2c65b
reorganize the macro expansion chapter
2020-05-08 09:42:27 -05:00
4e3759adb8
add note about macros in parser chapter
2020-05-08 09:42:27 -05:00
0bb8093581
reorder some chapters
2020-05-08 09:42:27 -05:00
1e41004cbf
add a bit to syntax intro
2020-05-08 09:42:27 -05:00
325d0a00f4
add a bit to part 3 intro
2020-05-08 09:42:27 -05:00
5ade22c7fc
get rid of old todo
2020-05-08 09:42:27 -05:00
1d92a6a465
finish going through discussion
2020-05-08 09:42:27 -05:00
543f5eaa93
more notetaking
2020-05-08 09:42:27 -05:00
e5dff9e753
start working through discussion
2020-05-08 09:42:27 -05:00
2b43588de7
some cleanup in the macros chapter
2020-05-08 09:42:27 -05:00
3a5328d4f7
Reference complete examples
2020-05-07 17:30:27 -05:00
1ac14631e8
Line length
2020-05-07 17:30:27 -05:00
d0702a0b3b
Example of getting diagnostics
2020-05-07 17:30:27 -05:00
ebd97c81b5
Added link to the `ty::Adt` ( #696 )
...
* Added link to the `ty::Adt`
* Formatting fixes
Thanks @JohnTitor
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-07 23:44:39 +09:00
40bb43d2d1
typo
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-06 17:03:52 -05:00
10c6b7a749
add a bit more on parallel compilation
2020-05-06 17:03:52 -05:00
e5dbc6f534
Fix example for winnowing
2020-05-02 21:23:21 -05:00
5aad3d043d
improve info regarding incremental a little
2020-05-01 09:18:42 -05:00
c518e9d49d
I confirmed this
2020-05-01 09:17:27 -05:00
c035c846ec
tidy
2020-04-30 21:25:29 -05:00
68aa2de832
Update src/queries/incremental-compilation.md
...
Removed `at`.
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-30 21:25:29 -05:00
16229dd3af
Hide link behind a clickable text
...
It currently does not appear as a clickable link here https://rustc-dev-guide.rust-lang.org/queries/incremental-compilation.html
Additionally, this is a particularly long and nasty link.
2020-04-30 21:25:29 -05:00
2b6a77ea0a
Minute formatting fix
2020-04-30 21:25:17 -05:00
a056d24ef6
It's just ICE-breaker ( #685 )
2020-04-28 21:19:37 +02:00
abd9ddb16b
Remove extra the
2020-04-27 15:45:00 -05:00
1bb6b0937f
Fix sub-diagnostic typo
2020-04-27 15:45:00 -05:00
ed380c3b77
remove info about diag ice breakers; doesn't exist yet ( #682 )
2020-04-25 16:23:59 -03:00
024e7f366d
Address review comments.
...
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-04-25 06:57:48 -05:00
0895f6eca0
Fix links.
2020-04-25 06:57:48 -05:00
37ffada957
Address review comments.
2020-04-25 06:57:48 -05:00
4b1b22464f
Fix links and CI error.
2020-04-25 06:57:48 -05:00
7d843fcd4f
Remove details about chalk and point to Chalk Book instead.
2020-04-25 06:57:48 -05:00
1b0f87c8dc
treat-err-as-bug=n means panic on nth error
2020-04-24 13:48:01 -05:00
07c46e7dcf
Replace `rustc` with `rustc_middle` ( #680 )
2020-04-20 15:16:27 +02:00
7f78165cb5
Typo
2020-04-19 13:08:39 -05:00
4266d9d902
review comments: move text to more relevant section
2020-04-19 13:08:39 -05:00
d738fed623
Add diagnostics ICE-breakers page
2020-04-19 13:08:39 -05:00
9cf06ca801
Fix typo ( #678 )
2020-04-19 17:54:45 +02:00
ede5d97881
Apply suggestions from Zoxc
2020-04-18 20:58:14 -05:00
d4c57c9269
Apply feedback.
2020-04-18 20:58:14 -05:00
2f9724f4a3
Add documentation about incr. comp. query attributes and the projection query pattern.
2020-04-18 20:58:14 -05:00
5cf8fea638
Fix some whitespace ( #677 )
2020-04-19 01:40:16 +09:00
262237683d
Apply suggestions from code review
...
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
2020-04-18 11:11:33 -05:00
38927a594e
add link to intrinsic
2020-04-18 11:11:33 -05:00
6b521a2504
Remove various todos
...
With some items added to https://github.com/rust-lang/rustc-dev-guide/issues/674
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
2020-04-18 11:11:33 -05:00
034cb09659
line length
2020-04-18 11:11:33 -05:00
25227a8314
[overview.md] add lexer updates, parser updates
...
includes feedback from matklad (lexer) and centril (parser)
2020-04-18 11:11:33 -05:00
276d2b6268
[overview.md] add initial parser documentation
2020-04-18 11:11:33 -05:00
a1f86d6af8
fix links
2020-04-18 11:11:33 -05:00
bf6c05c005
add intrinsics to glossary
2020-04-18 11:11:33 -05:00
cd8801485f
minor wording change on bootstrapping
2020-04-18 11:11:33 -05:00
160e142616
update mono entry points
2020-04-18 11:11:33 -05:00
a12e9e31a3
[overview.md] add documentation of lexer support for Unicode encoding
2020-04-18 11:11:33 -05:00
18d695aa13
correct entry points for codegen
2020-04-18 11:11:33 -05:00
5cc816afd2
some cleanup
2020-04-18 11:11:33 -05:00
8600655969
add entry points for type check and type inference
...
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
3bf10201ac
add a para on interning and arenas
2020-04-18 11:11:33 -05:00
85533c23ff
[overview.md] add parser entry point links
2020-04-18 11:11:33 -05:00
27e440e369
fix lexer entry point
2020-04-18 11:11:33 -05:00
79eec5bc6c
Improve wording
...
Co-Authored-By: Santiago Pastorino <spastorino@gmail.com>
2020-04-18 11:11:33 -05:00
ba961af42f
add an entry point
2020-04-18 11:11:33 -05:00
ff3f073ad3
remove a todo
2020-04-18 11:11:33 -05:00
14eb19f2b9
fix links
2020-04-18 11:11:33 -05:00
256a690b7c
line lengths
2020-04-18 11:11:33 -05:00
b496d8de63
add a few todos
2020-04-18 11:11:33 -05:00
29765d08d8
write a bit about bootstrapping
2020-04-18 11:11:33 -05:00
5c27142364
add a note on tcx name
2020-04-18 11:11:33 -05:00
dd2fa1b863
break long sentence
2020-04-18 11:11:33 -05:00
b7c0121552
Improve description of MIR
...
Co-Authored-By: Centril <twingoow@gmail.com>
2020-04-18 11:11:33 -05:00
edcf8ab931
correct the note about HAIR
2020-04-18 11:11:33 -05:00
1424834cd1
mention token stream as an IR
2020-04-18 11:11:33 -05:00
cc49d816bc
mention the hair
2020-04-18 11:11:33 -05:00
a37e554d42
Add some entry points
...
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
fdb20d6801
fix old rustc-dev-guide links
2020-04-18 11:11:33 -05:00
5f43e74c25
Update src/overview.md
...
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
72a378bcfc
Update src/overview.md
...
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
0ed7c0a7f3
[overview.md] Add command line argument parsing, lexer stages, and parser outline
2020-04-18 11:11:33 -05:00
1775a945aa
Apply Centril suggestions
...
Co-Authored-By: Centril <twingoow@gmail.com>
2020-04-18 11:11:33 -05:00
91ae0ab7e0
correct a few links
2020-04-18 11:11:33 -05:00
4272a80c38
add overview
2020-04-18 11:11:33 -05:00
3b6defe682
Start with the basics ( #675 )
...
* The very first step should be to clone the repository
* Make the command copy-able
By having the plain command users can select and copy the text and paste
it, without needing to fiddle around to remove extra characters.
Now that the previous command switched directories it is not necessary
to be called out here again either.
* Update src/building/how-to-build-and-run.md
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-04-17 21:16:56 +09:00
61f246ef7c
codegen tests: add link to LLVM FileCheck docs ( #673 )
2020-04-12 02:34:25 +09:00
620878ba6b
Add section describing source file checksums in debug info
2020-04-08 15:50:31 -05:00
4c9670a6c2
fix a link ( #672 )
2020-04-08 08:52:05 +02:00
50910ad220
mark-i-m review edits
2020-04-07 12:11:56 -05:00
8021d3e707
consistent section title casing
2020-04-07 12:11:56 -05:00
1ab6693c00
update about-this-guide.md with new Guide sections
2020-04-07 12:11:56 -05:00
10a4d76ecd
Reorganize the guide ( #651 )
...
* start on guide reorg
* backend intro
* part 2, 3, 4 intros
* some missing files
* Fix typos
Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
* add links from intro
* rename compiler source chapter and add placeholder for overview
* rename parts, mv rustc_driver to part 3, make syntax chapter
* update part intros
* add syntax ch intro
* address review comments
* Better overview chapter placeholder
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
* fix link
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-04-06 13:23:34 -03:00
e2ea943091
Remove duplicate trait reference entry from glossary, fix alphabetical sorting
2020-04-06 10:41:28 -05:00
277da2317e
Rework commit message
2020-04-05 12:49:29 -05:00
SparrowLii
Tshepang Mbambo
Xiretza
David Wood
Nathan Stocks
est31
Joshua Nelson
yukang
Noah Lev
Yuki Okushi
Urgau
bstrie
ridwanabdillahi
Amos Wenger
Luqman Aden
Amos Wenger
HackMD
Niko Matsakis
davidrusu
5225225
Joshua Nelson
Martin Nordholts
Santiago Pastorino
Yutaro Ohno
Daniel Xu
Ralf Jung
EdwinRy
Alcaro
Omer Tuchfeld
Edwin Rybarczyk
Eric Huss
lcnr
Jonas Schievink
Andrew Dona-Couch -- GitHub drop ICE
pierwill
Waffle Maybe
Jacob Pratt
Soroush Zare
Ali MJ Al-Nasrawy
Who? Me?!
printfn
Felix S Klock II
scottmcm
Frank Steffahn
Eric Holk
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
二手掉包工程师
Oli Scherer
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
Bastian Kauschke
Tom Eccles
Chris Simpkins
Chris Simpkins
Michael Bryan
Adam Perry
Paul Daniel Faria
Jade McGough
George Fraser
Hanif Ariffin
Charles Lew
Esteban Küber
Michael Woerister
Jan-Erik Rediger
Arlo Siemsen