Commit Graph

2393 Commits

Author SHA1 Message Date
Niko Matsakis 2ed78846ca tweak long line 2018-08-31 12:05:36 -05:00
Niko Matsakis 570f4404b1 sprinkle links to rustdoc through the HIR explanation 2018-08-31 12:05:36 -05:00
Sébastien Duquette dbb8d1b14f address review comment 2018-08-23 21:56:35 -05:00
Sébastien Duquette 399e53b8c6 Fix lines over 80 columns. 2018-08-23 21:56:35 -05:00
Sébastien Duquette f06248e4ef Rename CodeMap and FileMap to SourceMap and SourceFile.
Those types were renamed in https://github.com/rust-lang/rust/pull/52953
2018-08-23 21:56:35 -05:00
Niko Matsakis e0df7b587b add rust,ignore to code snippets 2018-08-20 11:46:41 -05:00
Oliver Schneider 135b38859f Update existential-types.md 2018-08-20 11:46:41 -05:00
Oliver Schneider 4ef163470d Explain existential types 2018-08-20 11:46:41 -05:00
Josh Triplett 45482cb170 Update copyright guidance to omit notices for new files.
Previously approved in https://github.com/rust-lang/rust/pull/43498 ;
update the guide to match.
2018-08-20 11:08:22 -05:00
John Renner 5c042aedab More descriptive name for #[test] implementation 2018-08-11 10:37:44 -05:00
John Renner 882e93a35a Shorten line length 2018-08-11 10:37:44 -05:00
John Renner a4a767e0bb Add testing chapter 2018-08-11 10:37:44 -05:00
Tom Tromey a2d8adadb1 Update compiler test documentation
Update the compiler test documentation to document ignore-gdb-version
and min-system-llvm-version; and expand the min-gdb-version,
min-lldb-version, and min-llvm-version documentation a little.
2018-08-09 09:15:01 -06:00
mark d89965857f minor improvements 2018-07-16 20:52:29 -05:00
mark efdb3e4c95 add notes about generating llvm ir 2018-07-16 20:52:29 -05:00
mark 96f8893e57 line length 2018-07-16 20:52:29 -05:00
mark d7cd4780eb add a bit on llvm 2018-07-16 20:52:29 -05:00
mark 72b1ddf17e add a bit about buffered lints 2018-07-14 16:47:17 -05:00
mark e7f02b15fd update definitions 2018-07-10 21:35:45 -05:00
mark d20172b7fa Attempt to address review comments 2018-07-10 21:35:45 -05:00
mark f2ad47f0e1 define FileMap; fix #35 2018-07-10 21:35:45 -05:00
mark a9001481e9 fix lacking spaces 2018-07-09 21:45:49 -05:00
mark 8a49eb7686 fix all the not-en-dashes 2018-07-09 21:45:49 -05:00
Who? Me?! a27baed413 Add the small amount i know about hygiene (#167)
* add the small amount i know about hygiene

* use en-dash
2018-07-09 21:28:29 +03:00
Who? Me?! f4106dae20 Quick fix: copy/paste error 2018-07-08 18:34:25 -05:00
Oliver Schneider f94133dcd6 md -> html 2018-07-08 17:41:12 -05:00
Oliver Schneider 1a5993b9ca Satisfy tidy checks 2018-07-08 17:41:12 -05:00
Oliver Schneider 3166fb9d3e Add some details about `DefId` creation 2018-07-08 17:41:12 -05:00
Oliver Schneider e54c0c413f Address review 2018-07-08 17:41:12 -05:00
Oliver Schneider edae077f8f Add some explanation of lowering ids 2018-07-08 17:41:12 -05:00
Zack M. Davis c4f4159f1d "and has" → "because it has" 2018-07-04 17:14:02 -05:00
Zack M. Davis a66550e48e rewrite suggestions intro to be less bizarrely edition/rustfix centric
The suggestions API was introduced in April 2015
(rust-lang/rust@906a9728ff), long predating rustfix (initial commit July
2016) or editions (RFC 2052 approved September 2017).
2018-07-04 17:14:02 -05:00
Zack M. Davis abccbe7139 mention lint-level command line flags as well as attributes 2018-07-04 17:14:02 -05:00
Zack M. Davis b2e7a7ef74 cautionary parenthetical about failing to emit a `DiagnosticBuilder` 2018-07-04 17:14:02 -05:00
Zack M. Davis 80cadf84c3 "easier" → "more informative"; omit needless clause
We don't want to leave the impression that spans are about making it
easier for compiler developers to perform the arduous task of emitting
an error; spans are about pointing to particular segments of code in the
emitted error messages. Also, we don't need to say "whenever an error
comes up"; that's implied by the phrase "error reporting."
2018-07-04 17:14:02 -05:00
Zack M. Davis badbb2daec `span_to_snippet` return value is a `Result`, not an `Option` 2018-07-04 17:14:02 -05:00
Zack M. Davis 5774db6f3a add links for `Span`, `CodeMap`, and `rustfix`
It's unfortunate that `code-monospaced` links don't render with link
colors (such that the reader needs to hover over them just to tell that
it is a link), but that's presumably a bug in MdBook, and not something
we need concern ourselves with here.
2018-07-04 17:14:02 -05:00
Alex Kitchens fedeb6a9a0 Keep glossary definition of codegen 2018-06-26 19:04:30 -05:00
Alex Kitchens f5f669e97d Rename trans to codegen
This commit is a followup of changes from [b63d7e2b1c4019e40051036bcb1fd5f254a8f6e2](b63d7e2b1c (diff-b433c87466d984aa7eeded378ea6c392)) in the Rust source to rename trans to codegen.
2018-06-26 19:04:30 -05:00
Eduard-Mihai Burtescu ffc7fdf490 Update query.md 2018-06-25 21:20:30 -05:00
Eduard-Mihai Burtescu 2d95ba915a Update high-level-overview.md 2018-06-25 21:20:30 -05:00
Eduard-Mihai Burtescu b961a49efe rustc: rename ty::maps to ty::query. 2018-06-25 21:20:30 -05:00
Zack M. Davis 2a82c7666d don't mention new rustdoc
Steve says it's not ready
(https://github.com/rust-lang-nursery/rustc-guide/pull/150#issuecomment-395783504).
2018-06-25 21:18:50 -05:00
Zack M. Davis e39c13d458 include `./` in example x.py commands for smoother copy-paste experience
The current directory is typically not on the user's $PATH.
2018-06-25 21:18:50 -05:00
scalexm 247ff14a43 Capitalize a word 2018-06-12 18:20:35 -05:00
scalexm 99e4f99e9e Add chalk rules for type defs 2018-06-12 18:20:35 -05:00
Niko Matsakis d3939fa152 Merge pull request #149 from rust-lang-nursery/mark-i-m-patch-1
clarify run-rustfix compiletest header
2018-06-10 16:10:37 -04:00
Niko Matsakis 031bdd42bb Merge pull request #153 from mark-i-m/code_index_01
A few more data structures to the code index
2018-06-10 16:10:11 -04:00
Mark Mansi 12d8d7668d update trait ref 2018-06-08 20:38:38 -05:00
Mark Mansi 269dabd291 mention bless 2018-06-08 20:32:04 -05:00
Niko Matsakis 2e26dcb6bc Merge pull request #152 from mark-i-m/glossary_more
add a bunch of type-related terms to glossary (and few others)
2018-06-08 10:44:20 -04:00
Mark Mansi 56d353991d fix build 2018-06-05 22:06:13 -05:00
Mark Mansi 428c7d6b4c Add bit about ctags; close #80 2018-06-05 22:06:13 -05:00
Mark Mansi 35838c9f66 fix typo 2018-06-04 22:18:14 -05:00
Mark Mansi d7e1878094 tests dont need to pass 2018-06-04 22:18:14 -05:00
Mark cebc5d8598 long line 2018-06-04 22:18:14 -05:00
Mark 785006ad62 Address review feedback 2018-06-04 22:18:14 -05:00
Mark b931fde9f5 add more on crater + perf runs 2018-06-04 22:18:14 -05:00
Mark Mansi 262e0add0c add a bit about crater 2018-06-04 22:18:14 -05:00
Mark Mansi 0ae47f45f5 A few more data structures to the code index 2018-06-04 20:26:40 -05:00
Mark Mansi d08cca96e5 add a bunch of type-related terms to glossary 2018-06-04 19:42:16 -05:00
Mark Mansi eec934f762 fix remaining links 2018-06-02 17:20:47 -04:00
Mark Mansi 30b6be0f7d first round of link fixes 2018-06-02 17:20:47 -04:00
Mark Mansi 1ad9dc34e5 mv traits 2018-06-02 17:20:47 -04:00
Mark Mansi 6017a9cf91 move mir 2018-06-02 17:20:47 -04:00
Mark Mansi 6246dbd9ed move appendix 2018-06-02 17:20:47 -04:00
Who? Me?! 659bde0203 clarify run-rustfix compiletest header 2018-06-02 16:06:00 -05:00
Tyler Mandry 5726ecbef2 Update lowering rules for GATs 2018-06-01 10:31:49 -05:00
Oliver Schneider b308d94e0a Merge pull request #142 from rust-lang-nursery/oli-obk-patch-1
Fixes #141
2018-05-29 22:56:45 +02:00
Oliver Schneider 053060c442 Satisfy travis 2018-05-29 16:31:32 +02:00
Oliver Schneider 86f694c1d4 Explain .fixed files 2018-05-29 15:37:24 +02:00
Oliver Schneider e25515fa7c Mention "run-rustfix" 2018-05-28 13:08:15 +02:00
Mark Mansi 2e7900d735 fix typo 2018-05-27 19:44:55 -05:00
Mark Mansi 8e744cddf5 line length 2018-05-27 19:44:55 -05:00
Mark Mansi b4fe77109c add more on applicabilities 2018-05-27 19:44:55 -05:00
Mark Mansi 9fe44f3f5a Address reviewers' comments 2018-05-27 19:44:55 -05:00
Mark Mansi 750267798f 80 chars 2018-05-27 19:44:55 -05:00
Mark Mansi f06a63bcf2 Add info about emitting lints and errors 2018-05-27 19:44:55 -05:00
Tyler Mandry 01f9d655ee Trait logic: Explain what each domain goal means 2018-05-27 16:11:27 -05:00
Tyler Mandry 3ea4a0b683 Clarify language in Trait Resolution 2018-05-27 16:11:27 -05:00
Takanori Ishibashi d491bce01d Fix typo 2018-05-27 13:11:59 -05:00
Oliver Schneider 4412b726d2 Fixes #141 2018-05-23 11:55:16 +02:00
Alex Kitchens a819c74358 Define a Cycle
I wasn't clear on what a Cycle was when reading through the document.
Defining it will be helpful for other readers not familiar with it as
well.
2018-05-22 17:06:58 -05:00
Philipp Hansch 812c9416fc The type is inferenced, not things itself. 2018-05-21 13:57:59 -05:00
Philipp Hansch 4025970742 Add type inference example
This should make the chapter a bit more approachable, as it doesn't
start with a reference to the HM type inference algorithm.
2018-05-21 13:57:59 -05:00
Alex Kitchens 75db8b32d4 Define HIR more specifically
IR is a foreign acronym to me, so having it fully expressed in the beginning as Intermediate Representation helps me comprehend the subject.
2018-05-20 19:08:25 -05:00
Takanori Ishibashi 379ce9ae66 invokations -> invocations 2018-05-15 10:15:16 -05:00
Niko Matsakis f5a7ed409d Merge pull request #131 from sunjay/overview-of-chalk
Added An Overview of Chalk
2018-05-14 17:57:43 -04:00
Sunjay Varma e1cf1f67b2 Missed a few things because of GitHub's UI 2018-05-14 11:26:15 -07:00
Sunjay Varma 71a66d2d7c Even more review changes 2018-05-14 11:21:20 -07:00
Sunjay Varma d9a22957a9 More review changes 2018-05-14 11:18:14 -07:00
Sunjay Varma 3f5ba4ee63 Changes from review 2018-05-14 10:52:21 -07:00
Mark Mansi bf7373c759 remove have completed 2018-05-12 15:04:25 -05:00
Mark Mansi ae516b0cc7 reword HIR intro. Fix #116 2018-05-12 15:04:25 -05:00
Sunjay Varma a6b9870c6c Updating links to match latest code 2018-05-11 17:14:26 -07:00
C Jones 5544506249 Make chapter links in compiletest not be code
mdBook doesn't display links inside code, so these links look very confusing.
Additionally, these types of links don't seem to be code on other pages of the book.
2018-05-11 17:58:17 -05:00
Sunjay Varma 9c8e72a689 Ignoring code examples that aren't actually compile-able 2018-05-10 15:48:24 -07:00
Sunjay Varma e34946fd9a Lines must be <= 80 characters UNLESS there is a link 2018-05-10 15:43:18 -07:00
Sunjay Varma 0130cf3441 Added an overview of chalk 2018-05-10 15:24:02 -07:00
Sunjay Varma 5f01a3b60b Closing all <a> tags 2018-05-10 14:46:44 -05:00
Sunjay Varma 6132ed7c5f Deleted <a> tag which was messing up the associated types page 2018-05-10 14:46:44 -05:00
Tomáš Gavenčiak b0ac5ffedc Update adding.md
Rename `must-compile-successfully` to `compile-pass` in ui test doc as per https://github.com/rust-lang/rust/issues/49568.
2018-05-10 13:18:30 -05:00
Rajkumar Natarajan 9ab5653936 Issue84 Add note about ./x.py build 2018-05-10 08:14:43 -04:00
gnzlbg eb7955313d Add how to run tidy script in isolation to text
This is already mentioned elsewhere, but important things are repeated twice.

Closes #124
2018-05-08 09:57:21 -05:00
Nick Fitzgerald 3f13b01444 appendix-background: Link to *Static Program Analysis*
A+++++ resource IMHO!
2018-04-28 21:13:45 -05:00
Ehsan M.Kermani cf70e19520 lint add dots 2018-04-28 21:11:51 -05:00
Ehsan M.Kermani 6c293f0170 fix max line len 2018-04-28 21:11:51 -05:00
Ehsan M.Kermani 38a21e9ea6 expand compilation stages 2018-04-28 21:11:51 -05:00
cg-cnu ed758ee494 add: note about copy from rust-forge 2018-04-15 12:58:53 -05:00
cg-cnu a45853faf8 fix: changed rust code to bash formatting 2018-04-15 12:58:53 -05:00
cg-cnu e44a94eb24 refactor: fixed typos, text formatting suggested in the review 2018-04-15 12:58:53 -05:00
cg-cnu 3814a2eeef refactor: Fixed all the lines exceeding more than 80 characters 2018-04-15 12:58:53 -05:00
cg-cnu d4bc8827f8 refactor: Change the name from debugging to compiler-debuggin.md 2018-04-15 12:58:53 -05:00
cg-cnu a5221f3287 Add: Added the instructions for debugging from rust-forge 2018-04-15 12:58:53 -05:00
Samuel Wilson ea2e787899 Add definition of a fat pointer, double pointer, and wide pointer
Definition referenced from Programming Rust by Jim Blandy & Jason
Orendorff, published by O'Reilly. Page 214: References to Slices
and Trait Objects.

Double pointer and wide pointer both refer to fat pointer for
detail.
2018-04-14 20:29:42 -05:00
Samuel Wilson 7ba118ba5a Add definition of a fat pointer
Definition referenced from Programming Rust by Jim Blandy & Jason
Orendorff, published by O'Reilly. Page 214: References to Slices
and Trait Objects.
2018-04-14 20:29:42 -05:00
QuietMisdreavus 0dfbdb8c86 talk about `only-X` in compiletest 2018-04-10 20:44:29 -05:00
Rajkumar Natarajan 4de421131b update nightly documention for issue#100-b 2018-04-06 21:40:18 -05:00
varkor a52c0adf68 Fix unstable Rust code block issue 2018-04-06 14:18:08 -05:00
varkor 28ba13db20 Fix spacing 2018-04-06 14:18:08 -05:00
varkor c6b3ce0c96 Replace txt with text 2018-04-06 14:18:08 -05:00
varkor ad35712ddc Consolidate and fix code blocks 2018-04-06 14:18:08 -05:00
Rajkumar Natarajan cacdd73802 Fixing the long lines in appendix-stupid-status#100 2018-04-06 12:17:30 -05:00
Niko Matsakis 2065551af6 link directly to the compile-input function 2018-04-06 12:17:30 -05:00
Rajkumar Natarajan 041af7c28c Link to internal rustdocs#100 2018-04-06 12:17:30 -05:00
Philip Munksgaard 7a3cf36d65 Fix typo in rustdoc.md 2018-04-03 10:15:57 -05:00
Dan Robertson b9e26653c8 Update links
Add missing link and add link for UFCS.
2018-03-29 08:35:25 -05:00
Tomáš Gavenčiak c355768c91 Fix a typo 2018-03-27 20:03:56 +02:00
Tomáš Gavenčiak db6ecb92f9 Add info on test result caching 2018-03-27 11:36:14 -05:00
Mark Mansi 22d5d6e212 reformat basically the whole rustdoc.md 2018-03-26 20:28:00 -05:00
Mark Mansi 576b018a3b still more long lines 2018-03-26 20:28:00 -05:00
Mark Mansi 42b7ec9aa9 More long lines 2018-03-26 20:28:00 -05:00
Mark Mansi a0b171b868 Fix long lines in conventions 2018-03-26 20:28:00 -05:00
Mark Mansi 9afc44beac Fix long lines in const-eval 2018-03-26 20:28:00 -05:00
Mark Mansi fc16c05abe Fix long lines in compiletest 2018-03-26 20:28:00 -05:00
Mark Mansi a4c3361302 Fix long lines in stupid stats appendix 2018-03-26 20:28:00 -05:00
Mark Mansi 1bdb1402b6 Fix long lines in glossary 2018-03-26 20:28:00 -05:00
Alexander Regueiro b3d8fba198 Hard-wrapped lines that are too long. 2018-03-26 20:28:00 -05:00
Dan Robertson 52520205a3 Minor grammar and syntax fixes
Minor grammar and syntax fixes found while reading.
2018-03-25 13:50:58 +00:00
Niko Matsakis 966b4d8fe0 describe how the lowering code works 2018-03-19 10:53:39 -04:00
Mark Mansi e7ce4f411c Add incremental compilation debugging subchapter 2018-03-16 11:45:09 -05:00
Niko Matsakis 7dea4167cf add names to the trait lowering rules
This allows cross-references from the code.
2018-03-15 15:01:40 -05:00
Who? Me?! 80fa5ad68d Updated parenthetical 2018-03-15 15:00:10 -05:00
Mark Mansi 474bdb566c address review comments 2018-03-15 15:00:10 -05:00
Mark Mansi 4026b02fc8 Address review comments 2018-03-15 15:00:10 -05:00
Mark Mansi 5d70b9aae5 Add the rustdoc readme 2018-03-15 15:00:10 -05:00
Mark Mansi 1efd726166 Add the contents of the typeck READMEs 2018-03-12 19:39:56 -05:00
Mark Mansi 68063bc768 fix typo 2018-03-12 18:14:10 -05:00
Michael Bryan e19b1e23b5 Added links back to nrc's stupid-stats 2018-03-12 17:41:01 -05:00
Michael Bryan 856aa3adff Fixed a broken link 2018-03-12 17:41:01 -05:00
Michael Bryan b2581c0fdd Updated stupid-stats
cc: nrc/stupid-stats#8
2018-03-12 17:41:01 -05:00
Michael Bryan 75497d550b Addressed some of @nrc and @mark-i-m's comments 2018-03-12 17:41:01 -05:00
Michael Bryan eb765cdbe4 Added a couple definitions to the code index 2018-03-12 17:41:01 -05:00
Michael Bryan 1c8a0a94a4 Thank you link checker! 2018-03-12 17:41:01 -05:00
Michael Bryan ea7b99943a Renamed appendices and added @nrc's guide 2018-03-12 17:41:01 -05:00
Michael Bryan 558f16cc8a Added a very rough rustc-driver chapter 2018-03-12 17:41:01 -05:00
Mark Mansi 73cc6098c9 Fix a few typos 2018-03-11 21:05:29 -05:00
Shanavas M d41933a95b fix typo 2018-03-10 10:50:26 -06:00
Niko Matsakis b30174cf00 trailing whitespace 2018-03-10 07:11:11 -05:00
Niko Matsakis 45394e41e4 fix link 2018-03-10 07:10:44 -05:00
Niko Matsakis 70786e7025 update the summary landing page 2018-03-10 07:09:25 -05:00
Niko Matsakis c237f48c97 add implied bounds placeholder 2018-03-10 07:06:48 -05:00
Niko Matsakis 26c1254b0e numerous edits 2018-03-10 07:06:48 -05:00
Niko Matsakis 0a5a47d731 rework canon section substantially to spell out steps more clearly 2018-03-10 07:06:48 -05:00
Niko Matsakis 32c471b278 update for notation 2018-03-10 07:06:48 -05:00
Niko Matsakis 71e867a8ac add background material on trait queries 2018-03-10 07:06:48 -05:00
Niko Matsakis a7b1b24fe1 expand reorder topic list slightly 2018-03-10 07:06:48 -05:00
Niko Matsakis 96730e2455 don't say 'thing' 2018-03-10 07:06:48 -05:00
Niko Matsakis 70c84edf43 link to traits working group tracking issue 2018-03-10 07:06:48 -05:00
Niko Matsakis d4c2ab308a clarify how there are two traits chapters 2018-03-10 07:06:48 -05:00
Niko Matsakis 4d1dbd553b work on traits chapters 2018-03-10 07:06:48 -05:00
Vishal Sodani d4fd74f3de Better explanation for StringReader 2018-03-09 09:37:51 -06:00
vishalsodani ead02a47e7 Add info about StringReader for #50 2018-03-09 09:37:51 -06:00
Adam C. Foltzer 1f0d256254 Fix typos 2018-03-07 12:41:19 -06:00
Phlosioneer c2560d523f Fix typo in conventions.md 2018-03-06 19:09:22 -06:00
Michal 'vorner' Vaner bad6063311 Second pass of name resolution
Just small little tweaks
2018-03-04 13:29:37 -06:00
vishalsodani dc72b964cf keep alphabetical order 2018-03-02 19:42:26 +05:30
vishalsodani 6de540d76a Add info about TraitDef for #50 2018-03-02 11:03:20 +05:30
vishalsodani 375182e066 Add info about CodeMap for #50 2018-03-02 09:22:41 +05:30
vishalsodani 31756c8bbe Add info about ParseSess for code index #50 2018-03-01 10:48:06 -06:00
Mark Mansi a3dfe3ebf1 actually fix table with hack 2018-02-28 14:58:24 -06:00
Mark Mansi 533b96b6d0 fix table 2018-02-28 14:45:51 -06:00
Who? Me?! 4835c223f5 Fix funny glossary formatting 2018-02-28 14:40:18 -06:00
Niko Matsakis b74423facf address nits 2018-02-28 14:30:04 -06:00
Niko Matsakis bca4268e94 fix typo 2018-02-28 14:30:04 -06:00
Niko Matsakis 75b2591ab3 apply mark-i-m's suggestions 2018-02-28 14:30:04 -06:00
Niko Matsakis 644dccfa34 rework the MIR intro section, breaking out passes and visitors 2018-02-28 14:30:04 -06:00
Niko Matsakis a8c8f4ad3b Merge pull request #56 from mark-i-m/markim_glossary_002
Add some codegen related terminology to glossary
2018-02-25 21:59:51 -05:00
Eric Huss ca2bb760c4 Start documentation for test infrastructure.
CC #10
2018-02-25 15:47:48 -06:00
Mark Mansi f6844420a6 Add some codegen related terminology to glossary 2018-02-24 21:09:00 -06:00
Niko Matsakis a86c286a49 Merge pull request #57 from mark-i-m/markim_glossary_003
Add a few more terms to the glossary
2018-02-23 20:47:29 -05:00
Niko Matsakis 481588a13b Merge pull request #52 from mark-i-m/traits
Clean up and reorganize traits chapter
2018-02-23 20:47:05 -05:00
Mark Mansi dedf73b5f2 Add HIR MAP to glossary 2018-02-23 13:18:13 -06:00
Mark Mansi 895c6967ed Start a code index 2018-02-23 12:53:13 -06:00
Eric Huss 7df929b7e1 Add some more information about the various tests that get run.
CC #10
2018-02-23 12:45:17 -06:00
Mark Mansi 8d11e1ac3b Minor updates to specialization subchapter 2018-02-23 12:40:14 -06:00
Mark Mansi a4b5151b11 Edits and cleanup in trait-caching subchapter 2018-02-23 12:40:14 -06:00
Mark Mansi e5aca6a8ec Clarifications and edits to hrtb chapter 2018-02-23 12:40:14 -06:00
Mark Mansi cbd05bc786 Clean up and reorganize traits chapter 2018-02-23 12:40:14 -06:00
Oliver Schneider 77e872fb58 Add some documentation for const eval and related topics 2018-02-23 12:36:20 -06:00
Brad Gibson b84288f2ac changed to relative links, where possible 2018-02-21 10:44:23 -08:00
Brad Gibson 3d7bc934db cleaned up some stragglers 2018-02-21 07:44:07 -08:00
Brad Gibson 7eed06b83c merged with upstream/master 2018-02-20 15:37:14 -08:00
Brad Gibson f50f36177a added compiletest to summary.md; linked to existing resources for additional information 2018-02-20 15:32:17 -08:00
Niko Matsakis 49da9c9030 remove humorous footnote which is not supported 2018-02-17 10:51:29 -06:00
Niko Matsakis 8605464d3b correct links (mdbook seems to want them relative to the book root) 2018-02-17 10:51:29 -06:00
Niko Matsakis bcf38b78a4 mention tidy 2018-02-17 10:51:29 -06:00
Niko Matsakis dbb6900498 fix typo 2018-02-17 10:51:29 -06:00
Niko Matsakis cec7fed1ad link to brson's blog post 2018-02-17 10:51:29 -06:00
Niko Matsakis 4680105b89 complete sentence 2018-02-17 10:51:29 -06:00
Niko Matsakis e34e22bc5b give some advice about which test suite to use 2018-02-17 10:51:29 -06:00
Niko Matsakis 747cea1ae7 add some more conventions 2018-02-17 10:51:29 -06:00
Niko Matsakis e2a7f6f3ad add some notes on coding conventions and link to copyright notice 2018-02-17 10:51:29 -06:00
Niko Matsakis 228ecd29a8 document the test infrastructure 2018-02-17 10:51:29 -06:00
Mark Mansi 6cb1c99f99 Add a few more terms to the glossary 2018-02-15 18:11:15 -06:00
Who? Me?! 7f1566e8a3 Update glossary.md 2018-02-14 11:58:26 -06:00
Mark Mansi 35a13bae33 add soundness and completeness to glossary 2018-02-14 11:58:26 -06:00
Brad Gibson 2685d478fd Added 'How to add header commands to `compiletest`' 2018-02-13 09:53:45 -08:00
Brad Gibson 43afda3032 fixed typos 2018-02-13 09:45:26 -08:00
Brad Gibson 3c6e64ed70 Update compiletest.md
changed file references to GitHub links directly to files
2018-02-13 09:22:33 -08:00
Brad Gibson b4e2f6b643 created compiletest.md
describe the steps required to add a test and a header command to compiletest
2018-02-13 05:53:35 -08:00
Mark Mansi 63b6666b77 alphabetize glossary 2018-02-11 15:48:58 -06:00
Niko Matsakis e17efcf9e7 Merge pull request #46 from theotherphil/dumphir
Explain how to dump HIR
2018-02-08 04:13:33 -05:00
Phil Ellison cce2b0ae9c Use cargo rustc instead of setting RUSTFLAGS 2018-02-07 19:14:58 +00:00
Phil Ellison de6afbc261 Explain how to dump HIR 2018-02-07 07:08:58 +00:00
Philipp Hansch aa2d408c1e Order alphabetically, improve explanation of DAG 2018-02-06 11:26:34 -06:00
Philipp Hansch 7d53e449a9 Add DAG to glossary 2018-02-06 11:26:34 -06:00
Mark Mansi 5920d94563 Update link text 2018-02-04 21:52:30 -06:00
Alexander Regueiro 1187124cad Removed spurious `a`. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 5a9fce427e Fixed issues mentioned by @mark-i-m in review. 2018-02-04 21:46:26 -06:00
Alexander Regueiro c579c23694 More minor fixes. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 597ed7d4fd Cleaned up section on type inference. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 80e9252f12 Explained what HM type inference is. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 152c08b1c9 Very minor grammatical fixes. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 7c158a6acc Normalized instances of `N.B.`. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 072d698430 Changed all instances of `e.g.,` to `e.g.`, and similar. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 4f417f0be6 Improved grammar of HIR section. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 02b5849749 Renamed `trans: generating LLVM IR` section. 2018-02-04 21:46:26 -06:00
avborhanian b2ece4a61a Update glossary.md 2018-02-04 13:13:17 -06:00
avborhanian 5b7e442fc3 Update glossary.md 2018-02-04 13:13:17 -06:00
avborhanian 4489e9734f Adding ICH to the glossary. 2018-02-04 13:13:17 -06:00
Alexander Regueiro c95e604602 minor grammatical fixes 2018-02-01 11:03:07 -06:00
Alexander Regueiro 780e954a17 replaced all instances of `--` (double hyphen) with `-` (en-dash) 2018-02-01 11:03:07 -06:00
Alexander Regueiro 487b8e01c3 fixed definition of code_mr hyperlink 2018-02-01 11:03:07 -06:00
Niko Matsakis 2a9f806b8e Merge pull request #37 from nikomatsakis/staging
update wording on staging to be a bit more clear
2018-01-31 14:44:55 -05:00
Niko Matsakis 26954dcecb update wording to be a bit more clear 2018-01-31 14:18:51 -05:00
Niko Matsakis e4f4581cc6 fix some broken links 2018-01-31 14:13:49 -05:00
Niko Matsakis 04d35ee547 Update link to hir 2018-01-31 14:13:10 -05:00
Niko Matsakis 6ab5adfb2e update to link within the book 2018-01-31 14:13:10 -05:00
Michael Bryan 1d3f0bb532 Added the mdbook-linkcheck backend 2018-01-31 14:13:09 -05:00
Niko Matsakis 32ceadd9d9 Merge pull request #36 from mark-i-m/markim_readme_02
Copy MIR readme
2018-01-31 14:12:41 -05:00
Mark Mansi a6fb06e122 copy MIR readme 2018-01-31 12:22:42 -06:00
Niko Matsakis 030bc47d4d Merge pull request #31 from mark-i-m/markim_readme_01
Copy type inference readme
2018-01-31 11:28:11 -05:00
Niko Matsakis 16bf438749 Merge pull request #33 from mark-i-m/stages
Add a paragraph about bootstrapping
2018-01-31 11:25:10 -05:00
Niko Matsakis 4c0a9e144e Merge pull request #29 from rust-lang-nursery/mark-i-m-patch-1
I'm guessing this was a typo?
2018-01-31 11:19:25 -05:00
Niko Matsakis 4bff2b4fba Merge pull request #26 from mark-i-m/macros
Start macro expansion chapter
2018-01-31 11:18:20 -05:00
Alexander Regueiro 314bc0c525 changed hyphens to en-dashes 2018-01-30 20:14:12 -06:00
Alexander Regueiro 1903ff4b16 minor clarification 2018-01-30 20:14:12 -06:00
Alexander Regueiro c8c54f68ae fixed grammatical oversight 2018-01-30 20:14:12 -06:00
Alexander Regueiro d2740041b0 improved grammar and fixed small errors 2018-01-30 20:14:12 -06:00
Alexander Regueiro b66d8d9def improved grammar
use en-dashes instead of `--`
2018-01-30 20:14:12 -06:00
Mark Mansi 7022c0aac4 Add a para about bootstrapping 2018-01-30 16:29:16 -06:00
Who? Me?! 6da8a1b6a4 Fix minor typos 2018-01-30 11:38:37 -06:00
Michal 'vorner' Vaner 136cf15064 The first approximation of name resolution (#22)
* The first approximation of name resolution

The first attempt to write something useful about the name resolution.
As the TODO section says, his is not finished thing, but it might
hopefully be useful to someone already.
2018-01-29 22:18:35 +01:00
Mark Mansi e2eb8fc511 copy type inference readme 2018-01-29 13:12:28 -06:00
Mark Mansi 68e84c734d Corrected relationship of macro and rust parsers 2018-01-29 11:50:34 -06:00
Who? Me?! 3947a76572 I'm guessing this was a typo? 2018-01-29 11:37:40 -06:00
Mark Mansi 41a4f43684 Rewrite 'tokens' para... 2018-01-29 11:20:46 -06:00
Niko Matsakis cd055e97a4 link glossary to mir 2018-01-29 10:26:40 -05:00
Niko Matsakis aacd1c47c8 create links in the glossary 2018-01-29 10:25:44 -05:00
Niko Matsakis eb31ada5c7 breakup the MIR section and add an incremental compilation section 2018-01-29 10:20:03 -05:00
Mark Mansi 81e9d3bb83 Updated macros to address Niko's comments 2018-01-26 14:41:56 -06:00
Niko Matsakis d052d295ef move over the query chapter from src/librustc/ty/maps 2018-01-26 09:20:01 -05:00
Niko Matsakis 8d6d60a010 rename the hir chapter to The HIR 2018-01-26 09:12:15 -05:00
Mark Mansi ce6899ab8b Oops rename 2018-01-25 17:58:04 -06:00
Mark Mansi b58a3dc627 Add a bit about macro expansion 2018-01-25 17:56:33 -06:00
Mark Mansi 1c92abebd6 Start macro expansion chapter 2018-01-25 15:58:47 -06:00
Niko Matsakis af83b8e8d4 Merge pull request #21 from Michael-F-Bryan/parser
WIP: Started working on the Parser
2018-01-25 09:47:54 -05:00
Niko Matsakis 4588cebfe4 Merge pull request #24 from nikomatsakis/master
how to build and run compiler, first shot
2018-01-25 09:40:36 -05:00
Niko Matsakis 887d8829f6 fix nits 2018-01-25 09:40:07 -05:00
Michael Bryan d1f0ff2ed3 Mentioned the main players in the parser 2018-01-25 00:30:52 +08:00
Niko Matsakis 287c401283 how to build and run compiler, first shot 2018-01-24 09:14:35 -05:00
Phil Ellison bfb6388d7b Copy contents of README.md from librustc/hir 2018-01-23 20:04:27 +00:00
Michael Bryan 20970b6b85 Started working on the parser chapter 2018-01-20 22:13:39 +08:00
Niko Matsakis 141528264b move over the `ty` README 2018-01-19 06:51:52 -05:00
Niko Matsakis b440859ad3 add in the trait resolution README from rustc 2018-01-19 06:46:56 -05:00
Niko Matsakis 81d158b707 remove the `chap-NNN-` convention from file names
I don't want those showing up in the URLs.
2018-01-19 06:46:56 -05:00
Niko Matsakis 45c8176b95 replace "conventions" with "high-level overview"
Also bring in material from the librustc README.md
2018-01-19 06:46:56 -05:00
Niko Matsakis 2c8b1345c0 add an "about this guide" section 2018-01-19 06:39:09 -05:00
Niko Matsakis f0db733d99 remove `src/src` directory that somehow got created 2018-01-17 09:25:59 -05:00
Mark Mansi 4e03569d8d Add glossary 2018-01-16 18:43:10 -06:00
Niko Matsakis eaa28eb853 add outline and chapters 2018-01-16 17:35:19 -05:00
Niko Matsakis 27ec0dc6d6 add `mdbook init` 2018-01-16 16:35:44 -05:00