Commit Graph

332 Commits

Author SHA1 Message Date
John Renner c13c5a019f Add testing chapter 2018-08-11 10:37:44 -05:00
Tom Tromey 37141c0825 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 2a1387faae minor improvements 2018-07-16 20:52:29 -05:00
mark e0d07aad5f add notes about generating llvm ir 2018-07-16 20:52:29 -05:00
mark 894893860d line length 2018-07-16 20:52:29 -05:00
mark 57c8403c88 add a bit on llvm 2018-07-16 20:52:29 -05:00
mark 315ae44507 add a bit about buffered lints 2018-07-14 16:47:17 -05:00
mark 1a696569a8 update definitions 2018-07-10 21:35:45 -05:00
mark d234211ca1 Attempt to address review comments 2018-07-10 21:35:45 -05:00
mark bdcd161d20 define FileMap; fix #35 2018-07-10 21:35:45 -05:00
mark 337c64e4d2 fix lacking spaces 2018-07-09 21:45:49 -05:00
mark 37a202cdba fix all the not-en-dashes 2018-07-09 21:45:49 -05:00
Who? Me?! 9112311803 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?! bf2f7c85b5
Quick fix: copy/paste error 2018-07-08 18:34:25 -05:00
Oliver Schneider c52d026a1f md -> html 2018-07-08 17:41:12 -05:00
Oliver Schneider 928470c8cc Satisfy tidy checks 2018-07-08 17:41:12 -05:00
Oliver Schneider f2e7ef1675 Add some details about `DefId` creation 2018-07-08 17:41:12 -05:00
Oliver Schneider e8a0108259 Address review 2018-07-08 17:41:12 -05:00
Oliver Schneider f394cd109c Add some explanation of lowering ids 2018-07-08 17:41:12 -05:00
Zack M. Davis 79ebdb7b53 "and has" → "because it has" 2018-07-04 17:14:02 -05:00
Zack M. Davis 196d10ea87 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 85645644db mention lint-level command line flags as well as attributes 2018-07-04 17:14:02 -05:00
Zack M. Davis 2cb56f31fe cautionary parenthetical about failing to emit a `DiagnosticBuilder` 2018-07-04 17:14:02 -05:00
Zack M. Davis c345de354c "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 14ef432e48 `span_to_snippet` return value is a `Result`, not an `Option` 2018-07-04 17:14:02 -05:00
Zack M. Davis 95bdeacaea 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 37872481ac Keep glossary definition of codegen 2018-06-26 19:04:30 -05:00
Alex Kitchens ec8d0498d6 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 7bf9416221 Update query.md 2018-06-25 21:20:30 -05:00
Eduard-Mihai Burtescu b1fa3579b8 Update high-level-overview.md 2018-06-25 21:20:30 -05:00
Eduard-Mihai Burtescu 85d30364b0 rustc: rename ty::maps to ty::query. 2018-06-25 21:20:30 -05:00
Zack M. Davis addc94950a 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 c98cd5a6a8 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 7139188c07 Capitalize a word 2018-06-12 18:20:35 -05:00
scalexm 529a75575b Add chalk rules for type defs 2018-06-12 18:20:35 -05:00
Niko Matsakis 6317149ca4
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 8e6bcbe004
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 318057e479 update trait ref 2018-06-08 20:38:38 -05:00
Mark Mansi 7681b6ccc4 mention bless 2018-06-08 20:32:04 -05:00
Niko Matsakis 43f7be67d6
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 b43d9881e2 fix build 2018-06-05 22:06:13 -05:00
Mark Mansi b859b33bbe Add bit about ctags; close #80 2018-06-05 22:06:13 -05:00
Mark Mansi 63eaf6b11c fix typo 2018-06-04 22:18:14 -05:00
Mark Mansi 390068501f tests dont need to pass 2018-06-04 22:18:14 -05:00
Mark 35780c196e long line 2018-06-04 22:18:14 -05:00
Mark eaa2cc1946 Address review feedback 2018-06-04 22:18:14 -05:00
Mark 8ee1d91c38 add more on crater + perf runs 2018-06-04 22:18:14 -05:00
Mark Mansi d0ad0c7bc1 add a bit about crater 2018-06-04 22:18:14 -05:00
Mark Mansi 809ca69001 A few more data structures to the code index 2018-06-04 20:26:40 -05:00
Mark Mansi 4a8412f3af add a bunch of type-related terms to glossary 2018-06-04 19:42:16 -05:00
Mark Mansi c0851bc66e fix remaining links 2018-06-02 17:20:47 -04:00
Mark Mansi 55883c4a7e first round of link fixes 2018-06-02 17:20:47 -04:00
Mark Mansi 13f38bebad mv traits 2018-06-02 17:20:47 -04:00
Mark Mansi 1b0fe8995a move mir 2018-06-02 17:20:47 -04:00
Mark Mansi 1af6fcfc67 move appendix 2018-06-02 17:20:47 -04:00
Who? Me?! dab4531fdc
clarify run-rustfix compiletest header 2018-06-02 16:06:00 -05:00
Tyler Mandry 8a98e39750 Update lowering rules for GATs 2018-06-01 10:31:49 -05:00
Oliver Schneider 37f5f859a3
Merge pull request #142 from rust-lang-nursery/oli-obk-patch-1
Fixes #141
2018-05-29 22:56:45 +02:00
Oliver Schneider 2d387350e2
Satisfy travis 2018-05-29 16:31:32 +02:00
Oliver Schneider 79ea4eeb14
Explain .fixed files 2018-05-29 15:37:24 +02:00
Oliver Schneider 1a25691cb4
Mention "run-rustfix" 2018-05-28 13:08:15 +02:00
Mark Mansi dbac00deda fix typo 2018-05-27 19:44:55 -05:00
Mark Mansi 3ea3ff8c70 line length 2018-05-27 19:44:55 -05:00
Mark Mansi 1624ba9923 add more on applicabilities 2018-05-27 19:44:55 -05:00
Mark Mansi 8a79f8b881 Address reviewers' comments 2018-05-27 19:44:55 -05:00
Mark Mansi c6ecc1f9b3 80 chars 2018-05-27 19:44:55 -05:00
Mark Mansi 5106793010 Add info about emitting lints and errors 2018-05-27 19:44:55 -05:00
Tyler Mandry bb867865fe Trait logic: Explain what each domain goal means 2018-05-27 16:11:27 -05:00
Tyler Mandry 2debb43b5a Clarify language in Trait Resolution 2018-05-27 16:11:27 -05:00
Takanori Ishibashi 50f44216f4 Fix typo 2018-05-27 13:11:59 -05:00
Oliver Schneider 3d48815cf4
Fixes #141 2018-05-23 11:55:16 +02:00
Alex Kitchens 3b0d3f27a5 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 6315267608 The type is inferenced, not things itself. 2018-05-21 13:57:59 -05:00
Philipp Hansch f91de90ea2 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 2bd5354411 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 2dc19d097a invokations -> invocations 2018-05-15 10:15:16 -05:00
Niko Matsakis 9fc991d15f
Merge pull request #131 from sunjay/overview-of-chalk
Added An Overview of Chalk
2018-05-14 17:57:43 -04:00
Sunjay Varma 389bd079a8 Missed a few things because of GitHub's UI 2018-05-14 11:26:15 -07:00
Sunjay Varma 7f83d68118 Even more review changes 2018-05-14 11:21:20 -07:00
Sunjay Varma edddf9fa3b More review changes 2018-05-14 11:18:14 -07:00
Sunjay Varma 5f58b0dc98 Changes from review 2018-05-14 10:52:21 -07:00
Mark Mansi b6f63df3eb remove have completed 2018-05-12 15:04:25 -05:00
Mark Mansi 359e814c8c reword HIR intro. Fix #116 2018-05-12 15:04:25 -05:00
Sunjay Varma f601a3aaca Updating links to match latest code 2018-05-11 17:14:26 -07:00
C Jones c11f57a262 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 b9eb2b6c13 Ignoring code examples that aren't actually compile-able 2018-05-10 15:48:24 -07:00
Sunjay Varma 58ef5a78de Lines must be <= 80 characters UNLESS there is a link 2018-05-10 15:43:18 -07:00
Sunjay Varma 8cfd5c5aed Added an overview of chalk 2018-05-10 15:24:02 -07:00
Sunjay Varma 0dc0dddb79 Closing all <a> tags 2018-05-10 14:46:44 -05:00
Sunjay Varma eeddfdaf70 Deleted <a> tag which was messing up the associated types page 2018-05-10 14:46:44 -05:00
Tomáš Gavenčiak 45cb1d368b 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 1cea2615e1 Issue84 Add note about ./x.py build 2018-05-10 08:14:43 -04:00
gnzlbg e39ea751a0 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 55ddb4df95 appendix-background: Link to *Static Program Analysis*
A+++++ resource IMHO!
2018-04-28 21:13:45 -05:00
Ehsan M.Kermani 7d4aee2431 lint add dots 2018-04-28 21:11:51 -05:00
Ehsan M.Kermani 9140b49321 fix max line len 2018-04-28 21:11:51 -05:00
Ehsan M.Kermani 30d20184b3 expand compilation stages 2018-04-28 21:11:51 -05:00
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