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,205 Commits 3 Branches 0 Tags 114 MiB
Commit Graph

1073 Commits

Author SHA1 Message Date
Joshua Nelson b8065faa0f Move rustdoc to 'How to build the compiler' 
The old layout was less about rustdoc and more about the compiler:
"Here is an example of a project using rustc_interface".
This gives focus to rustdoc on something you might want to work on for
its own sake. It also makes the page much easier to find for newcomers.
 2020-06-23 17:40:16 -05:00
Drew Youngwerth 917f7efa28 Small spelling fix. 2020-06-23 12:44:15 -05:00
mark ca5591815c address review comments 2020-06-23 12:42:06 -05:00
Florian Gilcher f85ef8ec94 Add prerequisite page 2020-06-23 12:42:06 -05:00
Andy Russell 21ee99e5af add suggestion style guide 
The guide is based on [existing rustdoc].

[existing rustdoc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_errors/struct.Diagnostic.html#method.span_suggestion
 2020-06-23 12:35:07 -05:00
Who? Me?! d103f0d897 Fix links for now. 2020-06-23 00:35:54 -05:00
ThePuzzlemaker 34df55db77 Add information about size for building the Rust Compiler 
The Rust codebase is large, not to mention the submodules. It would be helpful for some to have a warning or note about storage required before they spend possible hours to build, only to get a message in some form that they are running out/already out of storage. I did a stage1 build incrementally and it produced a build directory of about 14 gigabytes.
 2020-06-22 15:48:14 -05:00
Who? Me?! a10ba12047
Fix master branch links (#757) 
* fix links

* some debugging

* more debugging

* fix git checkout in ci

* try again

* already tests with a merge

* Typo

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
 2020-06-21 20:25:43 +02:00
Who? Me?! 45e540ca81
new tykind::error convention (#715) 2020-06-19 07:55:58 +02:00
mark 6c580ad664 fix line length 2020-06-18 12:16:00 -05:00
mark f880b1b21a address a bunch of review comments 2020-06-18 12:16:00 -05:00
Who? Me?! d90acc8e37 LeSeulArtichaut wording/typo fixes 
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-06-18 12:16:00 -05:00
mark c99d5245be address review comments 2020-06-18 12:16:00 -05:00
Who? Me?! 46099c094e Apply suggestions from code review 
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-06-18 12:16:00 -05:00
Who? Me?! 814d27d760 Better wording 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-06-18 12:16:00 -05:00
mark e1c7b6ce92 Slightly reorganize to first present the slow command then the fast commands 2020-06-18 12:16:00 -05:00
mark db004ad24f add a note about disk space 2020-06-18 12:16:00 -05:00
mark e72e2c5613 python 3 also 2020-06-18 12:16:00 -05:00
Who? Me?! aa9b3ecc22 Apply suggestions from code review 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
Co-authored-by: Phil Hansch <dev@phansch.net>
 2020-06-18 12:16:00 -05:00
mark 69baf677ef add forge 2020-06-18 12:16:00 -05:00
Who? Me?! 5ff627e2d5 Apply suggestions from code review 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-06-18 12:16:00 -05:00
mark 5784b6cb92 add note on submodules 2020-06-18 12:16:00 -05:00
mark e2620a8199 add a bit more 2020-06-18 12:16:00 -05:00
mark 2abbee9b5c fix link 2020-06-18 12:16:00 -05:00
mark b5e41a5e0c mention incremental disk space 2020-06-18 12:16:00 -05:00
mark 73d88a1385 a couple more small changes 2020-06-18 12:16:00 -05:00
mark d255b4a0cb some minor updates 2020-06-18 12:16:00 -05:00
mark ba2d73db5f write about processes 2020-06-18 12:16:00 -05:00
mark c5c498ca19 address some review comments 2020-06-18 12:16:00 -05:00
Who? Me?! 324eb69950 Typo fixes 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-06-18 12:16:00 -05:00
mark 8fbc9f5241 start a getting started guide 2020-06-18 12:16:00 -05:00
Eric Huss 708acbc72b
Add a link to the forge procedure on adding new options. (#754) 2020-06-18 10:33:15 +02:00
Joshua Nelson 163efc6fcd 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 178e3052b2 Document rustdoc behavior 
- `RUSTDOC_LOG`
- `// aux-build:filename.rs`
- `// build-aux-docs`
 2020-06-17 09:24:41 -05:00
Eric Huss 4228f46777 Add some more detail on compiletest normalization. 2020-06-16 23:14:05 -05:00
Ralf Jung 5371f13236
tag/niche terminology (#747) 2020-06-11 12:38:42 +02:00
LeSeulArtichaut 3b1866b1ea
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 e647444811
Include "Lint" in the title of the diagnostics chapter (#742) 2020-06-10 15:19:59 -03:00
Niko Matsakis 1a229d6d60 complete the ICE-breaker => notification group rename 2020-06-09 18:03:33 -05:00
Niko Matsakis 089b82651d
add the ARM notification group (#740) 2020-06-09 23:58:22 +02:00
Niko Matsakis e349f81b22
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 42520d3ca8 Document needs-* compiletest directives 2020-06-08 12:33:35 -05:00
Who? Me?! caac584a9e
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 8a9a1f935f
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 8c8130ed2d braces 2020-06-05 10:34:56 -05:00
Bastian Kauschke 8f2e466f3c words 2020-06-05 10:33:15 -05:00
Who? Me?! 7119767f69
Fix link (#734) 2020-06-05 17:10:01 +02:00
LeSeulArtichaut 2c2fb3f05f
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 b381598b3f
Update lint declaration example (#713) 2020-05-30 08:49:25 +09:00
Tom Eccles 8a5438b4b1 Document more //ignore-X test headers 2020-05-29 13:27:03 -05:00
Tom Eccles a6bace14e4 Document remote testing 2020-05-29 13:27:03 -05:00
LeSeulArtichaut 55c92daeb6
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 c9850bb7d2 Update src/tests/adding.md 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-28 19:57:59 -05:00
Chris Simpkins 8ca0464e65 add documentation of UI test error annotation substring support 2020-05-28 19:57:59 -05:00
Chris Simpkins 6a54bc6dab
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 d7067f19d2 Clarify lint vs fixed diagnostic. 2020-05-27 20:33:46 -05:00
Eric Huss 4d94eb902e Updates from review. 2020-05-27 20:33:46 -05:00
Eric Huss 1e8a467bc2 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 39edbe59ed Add some guidelines on diagnostics. 2020-05-27 20:33:46 -05:00
LeSeulArtichaut aca2a716ea 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 54d64bd8ac Fix typo 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-27 15:17:33 -05:00
LeSeulArtichaut 8bb723c673 Add definition of `niche` to the glossary 2020-05-27 15:17:33 -05:00
Eric Huss 6e2b70c9df Move CLI to part 3. 2020-05-27 12:35:13 -05:00
Eric Huss ba1a8dfd35 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 fe96650d1a Add some guidelines on the CLI. 2020-05-27 12:35:13 -05:00
Michael Bryan 6d5e0740f5
It looks like the high-level-overview was renamed (#721) 2020-05-28 00:04:56 +09:00
LeSeulArtichaut 4295e7b578
Add section for debugging rustc type layouts (#720) 2020-05-27 14:17:39 +02:00
Yuki Okushi f53fc666ea Rename `upvars` query to `upvars_mentioned` 2020-05-26 11:05:21 -05:00
Yuki Okushi c2561c4351
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 d10f70b005
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 59c9fa7b3e
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 266ab6e3a9
typo fix (#706) 2020-05-19 11:30:27 +09:00
Jade McGough 7fb45e52e9
Add missing closing paren (#705) 2020-05-16 21:19:52 -04:00
Tshepang Lekhonkhobe 8e126df6fe 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 d7649f4b44 glossary: make soundness definition more readable 2020-05-11 23:52:00 +02:00
Who? Me?! 95420468b9
fix links (#702) 2020-05-11 16:51:33 -03:00
Tshepang Lekhonkhobe 1caba74063
glossary: intro feels like not adding much (#699) 2020-05-11 07:57:46 +02:00
Who? Me?! c386ec3d1a Fix typo 2020-05-08 12:02:56 -05:00
Who? Me?! b6d140f789 Typo 
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-05-08 09:42:27 -05:00
mark d1bb132780 add some section headers 2020-05-08 09:42:27 -05:00
mark 1f6d127a70 move discussion of eager expansion to the end 2020-05-08 09:42:27 -05:00
Who? Me?! 9c7befcdd8 Use full path of span 
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-05-08 09:42:27 -05:00
Who? Me?! 2d639a3696 Typos 
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-05-08 09:42:27 -05:00
mark 7e916519ed fix some links 2020-05-08 09:42:27 -05:00
mark 5dedd70447 fix line length 2020-05-08 09:42:27 -05:00
mark bc9c0e6c35 SPRINKLE ALL THE THINGS 2020-05-08 09:42:27 -05:00
mark a1cf766577 sprinkle around a bunch of links 2020-05-08 09:42:27 -05:00
mark f05ff9c30d expand notes on expansion heirarchies 2020-05-08 09:42:27 -05:00
mark ba8620f34a add a bit more info about eager exp 2020-05-08 09:42:27 -05:00
mark e8f918c0ba expand some notes about expansion :P 2020-05-08 09:42:27 -05:00
mark 0980ebf2c6 reorganize the macro expansion chapter 2020-05-08 09:42:27 -05:00
mark 3f23b32c63 add note about macros in parser chapter 2020-05-08 09:42:27 -05:00
mark d62ed17895 reorder some chapters 2020-05-08 09:42:27 -05:00
mark 6ee323dce3 add a bit to syntax intro 2020-05-08 09:42:27 -05:00
mark 5d0cdc814a add a bit to part 3 intro 2020-05-08 09:42:27 -05:00
mark b8935a916b get rid of old todo 2020-05-08 09:42:27 -05:00
mark 984d5a8b4d finish going through discussion 2020-05-08 09:42:27 -05:00
mark ff2f232772 more notetaking 2020-05-08 09:42:27 -05:00
mark 8bbe1ff044 start working through discussion 2020-05-08 09:42:27 -05:00
mark ee0059a6e2 some cleanup in the macros chapter 2020-05-08 09:42:27 -05:00