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

1137 Commits

Author SHA1 Message Date
pierwill 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
mark 3d657229ad fix file name 2020-06-30 16:04:28 -05:00
Who? Me?! 342c4b7ba9 Move Getting Started to a "prefix chapter" 2020-06-30 16:04:10 -05:00
Who? Me?! 3e6097db7e Move Errors and Lints to Analysis 2020-06-30 16:03:50 -05:00
Yuki Okushi 38d14755b3 Rename resolvers following the latest rustc change (#776) 2020-06-30 16:22:38 +02:00
pierwill 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
Joshua Nelson 089dd18f03 Fix line lengths 2020-06-28 12:15:23 -05:00
Joshua Nelson 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
Joshua Nelson 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
Aaron Hill e362fdc8c7 Add 'recovery' to the gloassary 2020-06-27 11:05:32 -05:00
Who? Me?! 7884fdfdb0 Fix formatting 2020-06-24 21:38:54 -05:00
Who? Me?! 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
Joshua Nelson 541f88e8dd Move x.py commands to overview 2020-06-23 17:40:16 -05:00
Joshua Nelson bf38f1b6f8 Split up rustdoc page 2020-06-23 17:40:16 -05:00
Joshua Nelson 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
Drew Youngwerth cb950b77e8 Small spelling fix. 2020-06-23 12:44:15 -05:00
mark 93c21dd722 address review comments 2020-06-23 12:42:06 -05:00
Florian Gilcher 59e5e68074 Add prerequisite page 2020-06-23 12:42:06 -05:00
Andy Russell 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
Who? Me?! 98a67dc23b Fix links for now. 2020-06-23 00:35:54 -05:00
ThePuzzlemaker 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
Who? Me?! 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
Who? Me?! 92fafef00a new tykind::error convention (#715) 2020-06-19 07:55:58 +02:00
mark 8017824161 fix line length 2020-06-18 12:16:00 -05:00
mark b5864347d0 address a bunch of review comments 2020-06-18 12:16:00 -05:00
Who? Me?! d94394322b LeSeulArtichaut wording/typo fixes 
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-06-18 12:16:00 -05:00
mark d4056d0820 address review comments 2020-06-18 12:16:00 -05:00
Who? Me?! b24d9eb1fa Apply suggestions from code review 
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-06-18 12:16:00 -05:00
Who? Me?! 28ccf26223 Better wording 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-06-18 12:16:00 -05:00
mark 4250a4030a Slightly reorganize to first present the slow command then the fast commands 2020-06-18 12:16:00 -05:00
mark d829ce6f9b add a note about disk space 2020-06-18 12:16:00 -05:00
mark 0acd363057 python 3 also 2020-06-18 12:16:00 -05:00
Who? Me?! 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
mark c6766dfb7c add forge 2020-06-18 12:16:00 -05:00
Who? Me?! e492cf389b Apply suggestions from code review 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-06-18 12:16:00 -05:00
mark 5e2d3c35ed add note on submodules 2020-06-18 12:16:00 -05:00
mark 3bedf5c442 add a bit more 2020-06-18 12:16:00 -05:00
mark a9a82c4420 fix link 2020-06-18 12:16:00 -05:00
mark 1f0f15f380 mention incremental disk space 2020-06-18 12:16:00 -05:00
mark 6e482fb047 a couple more small changes 2020-06-18 12:16:00 -05:00
mark 96a7a9a49c some minor updates 2020-06-18 12:16:00 -05:00
mark 7942336575 write about processes 2020-06-18 12:16:00 -05:00
mark 655b6ba886 address some review comments 2020-06-18 12:16:00 -05:00
Who? Me?! 78e224ca52 Typo fixes 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-06-18 12:16:00 -05:00
mark 4cbb4c384e start a getting started guide 2020-06-18 12:16:00 -05:00
Eric Huss 7c51350dfc Add a link to the forge procedure on adding new options. (#754) 2020-06-18 10:33:15 +02:00
Joshua Nelson 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
Joshua Nelson 7e3da5c2ee Document rustdoc behavior 
- `RUSTDOC_LOG`
- `// aux-build:filename.rs`
- `// build-aux-docs`
 2020-06-17 09:24:41 -05:00
Eric Huss 6d921020b6 Add some more detail on compiletest normalization. 2020-06-16 23:14:05 -05:00
Ralf Jung 4c48d4c0eb tag/niche terminology (#747) 2020-06-11 12:38:42 +02:00
LeSeulArtichaut 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
LeSeulArtichaut 78b302c3a9 Include "Lint" in the title of the diagnostics chapter (#742) 2020-06-10 15:19:59 -03:00
Niko Matsakis a7a83e664d complete the ICE-breaker => notification group rename 2020-06-09 18:03:33 -05:00
Niko Matsakis df8ee5af1f add the ARM notification group (#740) 2020-06-09 23:58:22 +02:00
Niko Matsakis 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
Tomasz Miąsko df23757b09 Document needs-* compiletest directives 2020-06-08 12:33:35 -05:00
Who? Me?! 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
Bastian Kauschke 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
Bastian Kauschke f9c6c1b117 braces 2020-06-05 10:34:56 -05:00
Bastian Kauschke c9f49c6581 words 2020-06-05 10:33:15 -05:00
Who? Me?! 138c73f545 Fix link (#734) 2020-06-05 17:10:01 +02:00
LeSeulArtichaut 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
Yuki Okushi 6b85d54752 Update lint declaration example (#713) 2020-05-30 08:49:25 +09:00
Tom Eccles 01f01823ed Document more //ignore-X test headers 2020-05-29 13:27:03 -05:00
Tom Eccles d56a31f73c Document remote testing 2020-05-29 13:27:03 -05:00
LeSeulArtichaut 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
Chris Simpkins 1036ac82ed Update src/tests/adding.md 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-28 19:57:59 -05:00
Chris Simpkins 154e750ec5 add documentation of UI test error annotation substring support 2020-05-28 19:57:59 -05:00
Chris Simpkins 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
Eric Huss 3bb5fc53b5 Clarify lint vs fixed diagnostic. 2020-05-27 20:33:46 -05:00
Eric Huss 000f04e2f9 Updates from review. 2020-05-27 20:33:46 -05:00
Eric Huss 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
Eric Huss 5ae9e9191e Add some guidelines on diagnostics. 2020-05-27 20:33:46 -05:00
LeSeulArtichaut 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
LeSeulArtichaut bc9d1d0d76 Fix typo 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-27 15:17:33 -05:00
LeSeulArtichaut fc379a898f Add definition of `niche` to the glossary 2020-05-27 15:17:33 -05:00
Eric Huss 865e5542ad Move CLI to part 3. 2020-05-27 12:35:13 -05:00
Eric Huss 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
Eric Huss 8f7abbdf41 Add some guidelines on the CLI. 2020-05-27 12:35:13 -05:00
Michael Bryan e4c502318f It looks like the high-level-overview was renamed (#721) 2020-05-28 00:04:56 +09:00
LeSeulArtichaut a3287df2ad Add section for debugging rustc type layouts (#720) 2020-05-27 14:17:39 +02:00
Yuki Okushi 523e300c04 Rename `upvars` query to `upvars_mentioned` 2020-05-26 11:05:21 -05:00
Yuki Okushi 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
Adam Perry 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
Paul Daniel Faria 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
Chris Simpkins 78cf9b2ba1 typo fix (#706) 2020-05-19 11:30:27 +09:00
Jade McGough 05aee3ef6c Add missing closing paren (#705) 2020-05-16 21:19:52 -04:00
Tshepang Lekhonkhobe 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
Tshepang Lekhonkhobe 37322a7f26 glossary: make soundness definition more readable 2020-05-11 23:52:00 +02:00
Who? Me?! dc7ffdecc3 fix links (#702) 2020-05-11 16:51:33 -03:00
Tshepang Lekhonkhobe c740ef0a26 glossary: intro feels like not adding much (#699) 2020-05-11 07:57:46 +02:00
Who? Me?! dcf75a8e60 Fix typo 2020-05-08 12:02:56 -05:00
Who? Me?! d7f14b5093 Typo 
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-05-08 09:42:27 -05:00
mark 692e2799ce add some section headers 2020-05-08 09:42:27 -05:00
mark 67ab79a722 move discussion of eager expansion to the end 2020-05-08 09:42:27 -05:00
Who? Me?! 09c665aa12 Use full path of span 
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-05-08 09:42:27 -05:00
Who? Me?! f4824c83c3 Typos 
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-05-08 09:42:27 -05:00
mark 09a6c18ccb fix some links 2020-05-08 09:42:27 -05:00
mark 79c7718b63 fix line length 2020-05-08 09:42:27 -05:00
mark 5f5e48f5bd SPRINKLE ALL THE THINGS 2020-05-08 09:42:27 -05:00
mark 5ab21a1318 sprinkle around a bunch of links 2020-05-08 09:42:27 -05:00
mark 6fee71e345 expand notes on expansion heirarchies 2020-05-08 09:42:27 -05:00
mark c53e21fdb9 add a bit more info about eager exp 2020-05-08 09:42:27 -05:00
mark 1471e109c2 expand some notes about expansion :P 2020-05-08 09:42:27 -05:00
mark 07b7e2c65b reorganize the macro expansion chapter 2020-05-08 09:42:27 -05:00
mark 4e3759adb8 add note about macros in parser chapter 2020-05-08 09:42:27 -05:00
mark 0bb8093581 reorder some chapters 2020-05-08 09:42:27 -05:00
mark 1e41004cbf add a bit to syntax intro 2020-05-08 09:42:27 -05:00
mark 325d0a00f4 add a bit to part 3 intro 2020-05-08 09:42:27 -05:00
mark 5ade22c7fc get rid of old todo 2020-05-08 09:42:27 -05:00
mark 1d92a6a465 finish going through discussion 2020-05-08 09:42:27 -05:00
mark 543f5eaa93 more notetaking 2020-05-08 09:42:27 -05:00
mark e5dff9e753 start working through discussion 2020-05-08 09:42:27 -05:00
mark 2b43588de7 some cleanup in the macros chapter 2020-05-08 09:42:27 -05:00
George Fraser 3a5328d4f7 Reference complete examples 2020-05-07 17:30:27 -05:00
George Fraser 1ac14631e8 Line length 2020-05-07 17:30:27 -05:00
George Fraser d0702a0b3b Example of getting diagnostics 2020-05-07 17:30:27 -05:00
Hanif Ariffin 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
Who? Me?! 40bb43d2d1 typo 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-06 17:03:52 -05:00
mark 10c6b7a749 add a bit more on parallel compilation 2020-05-06 17:03:52 -05:00
Bastian Kauschke e5dbc6f534 Fix example for winnowing 2020-05-02 21:23:21 -05:00
Tshepang Lekhonkhobe 5aad3d043d improve info regarding incremental a little 2020-05-01 09:18:42 -05:00
Tshepang Lekhonkhobe c518e9d49d I confirmed this 2020-05-01 09:17:27 -05:00
Who? Me?! c035c846ec tidy 2020-04-30 21:25:29 -05:00
Hanif Ariffin 68aa2de832 Update src/queries/incremental-compilation.md 
Removed `at`.

Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-04-30 21:25:29 -05:00
Hanif Ariffin 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
Hanif Ariffin 2b6a77ea0a Minute formatting fix 2020-04-30 21:25:17 -05:00
Santiago Pastorino a056d24ef6 It's just ICE-breaker (#685) 2020-04-28 21:19:37 +02:00
Santiago Pastorino abd9ddb16b Remove extra the 2020-04-27 15:45:00 -05:00
Santiago Pastorino 1bb6b0937f Fix sub-diagnostic typo 2020-04-27 15:45:00 -05:00
Who? Me?! ed380c3b77 remove info about diag ice breakers; doesn't exist yet (#682) 2020-04-25 16:23:59 -03:00
Charles Lew 024e7f366d Address review comments. 
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-04-25 06:57:48 -05:00
Charles Lew 0895f6eca0 Fix links. 2020-04-25 06:57:48 -05:00
Charles Lew 37ffada957 Address review comments. 2020-04-25 06:57:48 -05:00
Charles Lew 4b1b22464f Fix links and CI error. 2020-04-25 06:57:48 -05:00
Charles Lew 7d843fcd4f Remove details about chalk and point to Chalk Book instead. 2020-04-25 06:57:48 -05:00
Santiago Pastorino 1b0f87c8dc treat-err-as-bug=n means panic on nth error 2020-04-24 13:48:01 -05:00
Bastian Kauschke 07c46e7dcf Replace `rustc` with `rustc_middle` (#680) 2020-04-20 15:16:27 +02:00
Who? Me?! 7f78165cb5 Typo 2020-04-19 13:08:39 -05:00
Esteban Küber 4266d9d902 review comments: move text to more relevant section 2020-04-19 13:08:39 -05:00
Esteban Küber d738fed623 Add diagnostics ICE-breakers page 2020-04-19 13:08:39 -05:00
Santiago Pastorino 9cf06ca801 Fix typo (#678) 2020-04-19 17:54:45 +02:00
Yuki Okushi ede5d97881 Apply suggestions from Zoxc 2020-04-18 20:58:14 -05:00
Michael Woerister d4c57c9269 Apply feedback. 2020-04-18 20:58:14 -05:00
Michael Woerister 2f9724f4a3 Add documentation about incr. comp. query attributes and the projection query pattern. 2020-04-18 20:58:14 -05:00
Who? Me?! 5cf8fea638 Fix some whitespace (#677) 2020-04-19 01:40:16 +09:00
Yuki Okushi 262237683d Apply suggestions from code review 
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
 2020-04-18 11:11:33 -05:00
mark 38927a594e add link to intrinsic 2020-04-18 11:11:33 -05:00
Who? Me?! 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
mark 034cb09659 line length 2020-04-18 11:11:33 -05:00