Commit Graph

2135 Commits

Author SHA1 Message Date
cg-cnu eb396e7883 add: note about copy from rust-forge 2018-04-15 12:58:53 -05:00
cg-cnu b4228a73ce fix: changed rust code to bash formatting 2018-04-15 12:58:53 -05:00
cg-cnu 29572cd2e4 refactor: fixed typos, text formatting suggested in the review 2018-04-15 12:58:53 -05:00
cg-cnu 8e02b37349 refactor: Fixed all the lines exceeding more than 80 characters 2018-04-15 12:58:53 -05:00
cg-cnu 5653c13077 refactor: Change the name from debugging to compiler-debuggin.md 2018-04-15 12:58:53 -05:00
cg-cnu 81116ab977 Add: Added the instructions for debugging from rust-forge 2018-04-15 12:58:53 -05:00
Samuel Wilson a87b323307 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 27a32adb72 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 df6b73fb99 talk about `only-X` in compiletest 2018-04-10 20:44:29 -05:00
Rajkumar Natarajan ad77d418fa update nightly documention for issue#100-b 2018-04-06 21:40:18 -05:00
varkor 46864ca971 Fix unstable Rust code block issue 2018-04-06 14:18:08 -05:00
varkor 79eaa63c54 Fix spacing 2018-04-06 14:18:08 -05:00
varkor 8889dcd15d Replace txt with text 2018-04-06 14:18:08 -05:00
varkor 43341c8894 Consolidate and fix code blocks 2018-04-06 14:18:08 -05:00
Rajkumar Natarajan f25f298963 Fixing the long lines in appendix-stupid-status#100 2018-04-06 12:17:30 -05:00
Niko Matsakis 1aceb34508 link directly to the compile-input function 2018-04-06 12:17:30 -05:00
Rajkumar Natarajan f5ff6d03be Link to internal rustdocs#100 2018-04-06 12:17:30 -05:00
Philip Munksgaard 3c189daf2c Fix typo in rustdoc.md 2018-04-03 10:15:57 -05:00
Dan Robertson 3d4332cd4f Update links
Add missing link and add link for UFCS.
2018-03-29 08:35:25 -05:00
Tomáš Gavenčiak 4d5ad15ad4
Fix a typo 2018-03-27 20:03:56 +02:00
Tomáš Gavenčiak 36179fb741 Add info on test result caching 2018-03-27 11:36:14 -05:00
Mark Mansi 066ba9ef82 reformat basically the whole rustdoc.md 2018-03-26 20:28:00 -05:00
Mark Mansi 9e6cdf3de3 still more long lines 2018-03-26 20:28:00 -05:00
Mark Mansi 2bb61a3f59 More long lines 2018-03-26 20:28:00 -05:00
Mark Mansi 42ef2ad0b8 Fix long lines in conventions 2018-03-26 20:28:00 -05:00
Mark Mansi 80de3962fb Fix long lines in const-eval 2018-03-26 20:28:00 -05:00
Mark Mansi 94757096ad Fix long lines in compiletest 2018-03-26 20:28:00 -05:00
Mark Mansi 8615d9e9b0 Fix long lines in stupid stats appendix 2018-03-26 20:28:00 -05:00
Mark Mansi cd053f3cb4 Fix long lines in glossary 2018-03-26 20:28:00 -05:00
Alexander Regueiro e6acd30581 Hard-wrapped lines that are too long. 2018-03-26 20:28:00 -05:00
Dan Robertson 6136199bf5
Minor grammar and syntax fixes
Minor grammar and syntax fixes found while reading.
2018-03-25 13:50:58 +00:00
Niko Matsakis 28da7a02ac describe how the lowering code works 2018-03-19 10:53:39 -04:00
Mark Mansi 1131ff4bba Add incremental compilation debugging subchapter 2018-03-16 11:45:09 -05:00
Niko Matsakis 52787a6ec4 add names to the trait lowering rules
This allows cross-references from the code.
2018-03-15 15:01:40 -05:00
Who? Me?! 81071c6838 Updated parenthetical 2018-03-15 15:00:10 -05:00
Mark Mansi 7c2af89682 address review comments 2018-03-15 15:00:10 -05:00
Mark Mansi 21ed6e6ce4 Address review comments 2018-03-15 15:00:10 -05:00
Mark Mansi a19cdc7a71 Add the rustdoc readme 2018-03-15 15:00:10 -05:00
Mark Mansi e74567479d Add the contents of the typeck READMEs 2018-03-12 19:39:56 -05:00
Mark Mansi ed04741208 fix typo 2018-03-12 18:14:10 -05:00
Michael Bryan 9874533b6e Added links back to nrc's stupid-stats 2018-03-12 17:41:01 -05:00
Michael Bryan 746753138a Fixed a broken link 2018-03-12 17:41:01 -05:00
Michael Bryan c919a89995 Updated stupid-stats
cc: nrc/stupid-stats#8
2018-03-12 17:41:01 -05:00
Michael Bryan 27225507d7 Addressed some of @nrc and @mark-i-m's comments 2018-03-12 17:41:01 -05:00
Michael Bryan d28ae97736 Added a couple definitions to the code index 2018-03-12 17:41:01 -05:00
Michael Bryan 53aa601f7f Thank you link checker! 2018-03-12 17:41:01 -05:00
Michael Bryan 121d05098c Renamed appendices and added @nrc's guide 2018-03-12 17:41:01 -05:00
Michael Bryan 0da5774acb Added a very rough rustc-driver chapter 2018-03-12 17:41:01 -05:00
Mark Mansi ce45556483 Fix a few typos 2018-03-11 21:05:29 -05:00
Shanavas M 5dfe4f26c5 fix typo 2018-03-10 10:50:26 -06:00
Niko Matsakis 49e8e092c1 trailing whitespace 2018-03-10 07:11:11 -05:00
Niko Matsakis d9f0a45a04 fix link 2018-03-10 07:10:44 -05:00
Niko Matsakis 994a38b198 update the summary landing page 2018-03-10 07:09:25 -05:00
Niko Matsakis 7a78a998ce add implied bounds placeholder 2018-03-10 07:06:48 -05:00
Niko Matsakis 95f9957277 numerous edits 2018-03-10 07:06:48 -05:00
Niko Matsakis 53115310f7 rework canon section substantially to spell out steps more clearly 2018-03-10 07:06:48 -05:00
Niko Matsakis 22b5ec4796 update for notation 2018-03-10 07:06:48 -05:00
Niko Matsakis c3a35021d6 add background material on trait queries 2018-03-10 07:06:48 -05:00
Niko Matsakis 3c8a827a37 expand reorder topic list slightly 2018-03-10 07:06:48 -05:00
Niko Matsakis fd92491375 don't say 'thing' 2018-03-10 07:06:48 -05:00
Niko Matsakis 6f99f12c2a link to traits working group tracking issue 2018-03-10 07:06:48 -05:00
Niko Matsakis e4aaa9c7f9 clarify how there are two traits chapters 2018-03-10 07:06:48 -05:00
Niko Matsakis 479d914ff0 work on traits chapters 2018-03-10 07:06:48 -05:00
Vishal Sodani 86c5f6c9b4 Better explanation for StringReader 2018-03-09 09:37:51 -06:00
vishalsodani f04757a901 Add info about StringReader for #50 2018-03-09 09:37:51 -06:00
Adam C. Foltzer 6660e4466a Fix typos 2018-03-07 12:41:19 -06:00
Phlosioneer 8a005f5dac Fix typo in conventions.md 2018-03-06 19:09:22 -06:00
Michal 'vorner' Vaner 23b3e84c11 Second pass of name resolution
Just small little tweaks
2018-03-04 13:29:37 -06:00
vishalsodani fd0223e50b keep alphabetical order 2018-03-02 19:42:26 +05:30
vishalsodani f1bda065d8 Add info about TraitDef for #50 2018-03-02 11:03:20 +05:30
vishalsodani 7fa92ec4a5 Add info about CodeMap for #50 2018-03-02 09:22:41 +05:30
vishalsodani 12e382d2d5 Add info about ParseSess for code index #50 2018-03-01 10:48:06 -06:00
Mark Mansi 017796049d actually fix table with hack 2018-02-28 14:58:24 -06:00
Mark Mansi a797e14afa fix table 2018-02-28 14:45:51 -06:00
Who? Me?! 3025c38976
Fix funny glossary formatting 2018-02-28 14:40:18 -06:00
Niko Matsakis 03044a350e address nits 2018-02-28 14:30:04 -06:00
Niko Matsakis 64963f85af fix typo 2018-02-28 14:30:04 -06:00
Niko Matsakis 906746500b apply mark-i-m's suggestions 2018-02-28 14:30:04 -06:00
Niko Matsakis 54873601a8 rework the MIR intro section, breaking out passes and visitors 2018-02-28 14:30:04 -06:00
Niko Matsakis 5803d3d14e
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 ae39f92b66 Start documentation for test infrastructure.
CC #10
2018-02-25 15:47:48 -06:00
Mark Mansi 18e8e25551 Add some codegen related terminology to glossary 2018-02-24 21:09:00 -06:00
Niko Matsakis 9a9c8c3178
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 588b1ebf96
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 9f0be41a06 Add HIR MAP to glossary 2018-02-23 13:18:13 -06:00
Mark Mansi b35bd94e82 Start a code index 2018-02-23 12:53:13 -06:00
Eric Huss bfcdce6604 Add some more information about the various tests that get run.
CC #10
2018-02-23 12:45:17 -06:00
Mark Mansi a0ddc8aa8a Minor updates to specialization subchapter 2018-02-23 12:40:14 -06:00
Mark Mansi 0236316fb2 Edits and cleanup in trait-caching subchapter 2018-02-23 12:40:14 -06:00
Mark Mansi 93958df2e7 Clarifications and edits to hrtb chapter 2018-02-23 12:40:14 -06:00
Mark Mansi 2f04df39d1 Clean up and reorganize traits chapter 2018-02-23 12:40:14 -06:00
Oliver Schneider 6e1eccd30c Add some documentation for const eval and related topics 2018-02-23 12:36:20 -06:00
Brad Gibson b1c4662b01 changed to relative links, where possible 2018-02-21 10:44:23 -08:00
Brad Gibson 572eaa6e5d cleaned up some stragglers 2018-02-21 07:44:07 -08:00
Brad Gibson 8751dfe831 merged with upstream/master 2018-02-20 15:37:14 -08:00
Brad Gibson 84c2cd5f60 added compiletest to summary.md; linked to existing resources for additional information 2018-02-20 15:32:17 -08:00
Niko Matsakis c7c80abb0b remove humorous footnote which is not supported 2018-02-17 10:51:29 -06:00
Niko Matsakis 7f8364d6f9 correct links (mdbook seems to want them relative to the book root) 2018-02-17 10:51:29 -06:00
Niko Matsakis caea7ae5ad mention tidy 2018-02-17 10:51:29 -06:00
Niko Matsakis b502a6a3fc fix typo 2018-02-17 10:51:29 -06:00
Niko Matsakis 2e04d6444a link to brson's blog post 2018-02-17 10:51:29 -06:00
Niko Matsakis a8bdd52e56 complete sentence 2018-02-17 10:51:29 -06:00
Niko Matsakis 346cbab485 give some advice about which test suite to use 2018-02-17 10:51:29 -06:00
Niko Matsakis 14f74dff91 add some more conventions 2018-02-17 10:51:29 -06:00
Niko Matsakis 8c657b1f88 add some notes on coding conventions and link to copyright notice 2018-02-17 10:51:29 -06:00
Niko Matsakis 58b67c21d6 document the test infrastructure 2018-02-17 10:51:29 -06:00
Mark Mansi 169cdeb78f Add a few more terms to the glossary 2018-02-15 18:11:15 -06:00
Who? Me?! 4357cf5c8e Update glossary.md 2018-02-14 11:58:26 -06:00
Mark Mansi 6ae355c18d add soundness and completeness to glossary 2018-02-14 11:58:26 -06:00
Brad Gibson fc83b6fe19
Added 'How to add header commands to `compiletest`' 2018-02-13 09:53:45 -08:00
Brad Gibson 5723bce6f1
fixed typos 2018-02-13 09:45:26 -08:00
Brad Gibson 59485d219a
Update compiletest.md
changed file references to GitHub links directly to files
2018-02-13 09:22:33 -08:00
Brad Gibson f79e0d0cb1
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 4b7bdec2e3 alphabetize glossary 2018-02-11 15:48:58 -06:00
Niko Matsakis 39bf7d63b6
Merge pull request #46 from theotherphil/dumphir
Explain how to dump HIR
2018-02-08 04:13:33 -05:00
Phil Ellison 5ba0d6bc04 Use cargo rustc instead of setting RUSTFLAGS 2018-02-07 19:14:58 +00:00
Phil Ellison a2d2cfa89a Explain how to dump HIR 2018-02-07 07:08:58 +00:00
Philipp Hansch 6ebe10d55a Order alphabetically, improve explanation of DAG 2018-02-06 11:26:34 -06:00
Philipp Hansch 7d8cdcbb53 Add DAG to glossary 2018-02-06 11:26:34 -06:00
Mark Mansi 45db49d4de Update link text 2018-02-04 21:52:30 -06:00
Alexander Regueiro 2b9828a566 Removed spurious `a`. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 7336639671 Fixed issues mentioned by @mark-i-m in review. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 606e39a58b More minor fixes. 2018-02-04 21:46:26 -06:00
Alexander Regueiro fde99687ab Cleaned up section on type inference. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 61d67c582c Explained what HM type inference is. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 6bacd33a0b Very minor grammatical fixes. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 8a0935c485 Normalized instances of `N.B.`. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 7d7d9171b8 Changed all instances of `e.g.,` to `e.g.`, and similar. 2018-02-04 21:46:26 -06:00
Alexander Regueiro 1a399f5ea3 Improved grammar of HIR section. 2018-02-04 21:46:26 -06:00
Alexander Regueiro c32587aaed Renamed `trans: generating LLVM IR` section. 2018-02-04 21:46:26 -06:00
avborhanian 1d9eeb079f Update glossary.md 2018-02-04 13:13:17 -06:00
avborhanian 4a72994f11 Update glossary.md 2018-02-04 13:13:17 -06:00
avborhanian e022bcd214 Adding ICH to the glossary. 2018-02-04 13:13:17 -06:00
Alexander Regueiro 96d3038965 minor grammatical fixes 2018-02-01 11:03:07 -06:00
Alexander Regueiro 9ad3a69332 replaced all instances of `--` (double hyphen) with `-` (en-dash) 2018-02-01 11:03:07 -06:00
Alexander Regueiro ddad2c3e95 fixed definition of code_mr hyperlink 2018-02-01 11:03:07 -06:00
Niko Matsakis cff1185eda
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 4066211f47 update wording to be a bit more clear 2018-01-31 14:18:51 -05:00
Niko Matsakis 04cee3e1be fix some broken links 2018-01-31 14:13:49 -05:00
Niko Matsakis 0cedd25595 Update link to hir 2018-01-31 14:13:10 -05:00
Niko Matsakis 046dc79b9d update to link within the book 2018-01-31 14:13:10 -05:00
Michael Bryan d39ba39a24 Added the mdbook-linkcheck backend 2018-01-31 14:13:09 -05:00
Niko Matsakis 87ae827ab0
Merge pull request #36 from mark-i-m/markim_readme_02
Copy MIR readme
2018-01-31 14:12:41 -05:00
Mark Mansi 239e2c600a copy MIR readme 2018-01-31 12:22:42 -06:00
Niko Matsakis 28b7fabf0b
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 6ccb3b028f
Merge pull request #33 from mark-i-m/stages
Add a paragraph about bootstrapping
2018-01-31 11:25:10 -05:00
Niko Matsakis 0bda06e3d6
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 b4b2b0d742
Merge pull request #26 from mark-i-m/macros
Start macro expansion chapter
2018-01-31 11:18:20 -05:00
Alexander Regueiro ed1e1f24de changed hyphens to en-dashes 2018-01-30 20:14:12 -06:00
Alexander Regueiro 606fe05114 minor clarification 2018-01-30 20:14:12 -06:00
Alexander Regueiro 2ee639a7aa fixed grammatical oversight 2018-01-30 20:14:12 -06:00
Alexander Regueiro d15c82a6c5 improved grammar and fixed small errors 2018-01-30 20:14:12 -06:00
Alexander Regueiro c3eb273f8e improved grammar
use en-dashes instead of `--`
2018-01-30 20:14:12 -06:00
Mark Mansi 4f983ebe14 Add a para about bootstrapping 2018-01-30 16:29:16 -06:00
Who? Me?! 150db58b61
Fix minor typos 2018-01-30 11:38:37 -06:00
Michal 'vorner' Vaner 066a32c961
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 f47633dd33 copy type inference readme 2018-01-29 13:12:28 -06:00
Mark Mansi 82da67a751 Corrected relationship of macro and rust parsers 2018-01-29 11:50:34 -06:00
Who? Me?! ed50f8d5d7
I'm guessing this was a typo? 2018-01-29 11:37:40 -06:00
Mark Mansi dee42c1673 Rewrite 'tokens' para... 2018-01-29 11:20:46 -06:00
Niko Matsakis bf775929af link glossary to mir 2018-01-29 10:26:40 -05:00
Niko Matsakis 0414ffee78 create links in the glossary 2018-01-29 10:25:44 -05:00
Niko Matsakis 65263b6752 breakup the MIR section and add an incremental compilation section 2018-01-29 10:20:03 -05:00
Mark Mansi 858dfdf054 Updated macros to address Niko's comments 2018-01-26 14:41:56 -06:00
Niko Matsakis 40daff36d4 move over the query chapter from src/librustc/ty/maps 2018-01-26 09:20:01 -05:00
Niko Matsakis 458685bbb8 rename the hir chapter to The HIR 2018-01-26 09:12:15 -05:00
Mark Mansi ba3dd183e6 Oops rename 2018-01-25 17:58:04 -06:00
Mark Mansi 4992b47628 Add a bit about macro expansion 2018-01-25 17:56:33 -06:00
Mark Mansi 1627505cab Start macro expansion chapter 2018-01-25 15:58:47 -06:00
Niko Matsakis 3b4fab42f9
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 f0e17c62a5
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 3b142e54c2 fix nits 2018-01-25 09:40:07 -05:00
Michael Bryan b2a850faf0 Mentioned the main players in the parser 2018-01-25 00:30:52 +08:00
Niko Matsakis c44964bd14 how to build and run compiler, first shot 2018-01-24 09:14:35 -05:00
Phil Ellison 11bb542a9c Copy contents of README.md from librustc/hir 2018-01-23 20:04:27 +00:00
Michael Bryan 3c98b0f189 Started working on the parser chapter 2018-01-20 22:13:39 +08:00
Niko Matsakis 761119ef83 move over the `ty` README 2018-01-19 06:51:52 -05:00
Niko Matsakis dfa328fc39 add in the trait resolution README from rustc 2018-01-19 06:46:56 -05:00
Niko Matsakis 3492c534fe 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 6cafcbb06f 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 ae4b5503b2 add an "about this guide" section 2018-01-19 06:39:09 -05:00
Niko Matsakis 5e297beb81 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