Commit Graph

489 Commits

Author SHA1 Message Date
Tom Tromey 351f75b4eb Document ignore-llvm-version
This documents the ignore-llvm-version directive.
2018-11-06 16:35:13 -06:00
Tyler Mandry 62c8d0465b SLG: Replace heritage section with links to it elsewhere
Maybe we want to include this in the bibliography or something, though.
2018-11-04 09:50:18 -06:00
Tyler Mandry 69d42aa4ce SLG: Add intro 2018-11-04 09:38:56 -06:00
Niko Matsakis 505c99f080
Merge pull request #222 from scalexm/wf
Write well-formedness checking chapter
2018-11-03 06:28:36 -04:00
Tyler Mandry 76a2c5eb86 Copy chalk_engine README 2018-11-02 16:20:56 -05:00
scalexm cbb021e93f Fix nits 2018-11-02 21:50:36 +01:00
Niko Matsakis 9fe13e7182
Merge pull request #223 from tmandry/improve-chalk-overview
Update chalk overview
2018-11-02 15:55:51 -04:00
Who? Me?! 9805434b94 Clarify why 'static is free 2018-10-31 20:44:30 -05:00
Who? Me?! 66e831eeb0 Missing link 2018-10-31 20:43:46 -05:00
Tyler Mandry cf2682ae86 Chalk Overview: Fill in testing section 2018-10-30 18:06:31 -05:00
Tyler Mandry 7f14c8254e Chalk Overview: Organize and sort links 2018-10-30 18:06:31 -05:00
Tyler Mandry b5024c3a73 Chalk Overview: Update old content 2018-10-30 18:06:25 -05:00
Tyler Mandry fe9dc61b89 Fix a few more things
Co-Authored-By: scalexm <alexandre@scalexm.fr>
2018-10-30 22:15:22 +01:00
Tyler Mandry d2238c30b7 Move Crates section down
Nest existing content under Chalk Structure. I think it reads better
this way.
2018-10-29 22:34:23 -05:00
Tyler Mandry b62fe76a35 Move Resources to bottom 2018-10-29 22:27:26 -05:00
Tyler Mandry 90716dc9da Add section on chalk structure 2018-10-29 22:16:17 -05:00
Who? Me?! e20f283a1e Fix a few things
Co-Authored-By: scalexm <alexandre@scalexm.fr>
2018-10-29 22:43:44 +01:00
scalexm 83652097f3 Fix code blocks 2018-10-29 18:58:13 +01:00
scalexm b5dff2ed5f Add some examples for impls 2018-10-29 16:18:26 +01:00
scalexm 462b7c3558 Write well-formedness checking chapter 2018-10-29 14:38:17 +01:00
Tom Tromey 34af41dddb Document the rust-lldb directive
Commit ac33b2e578de58016271012452e4f1be6af9d516 added a `rust-lldb`
directive to restrict the lldb part of a debuginfo test to only
versions of lldb that include the Rust plugin.
2018-10-26 18:23:38 -05:00
Tyler Mandry 74e2af231b Put "well-formedness checking" under "lowering rules"
This was also intended to be a reference chapter, according to @scalexm.
2018-10-26 13:43:31 -05:00
Tyler Mandry 2de4dc7a12 Get excited 2018-10-26 13:43:31 -05:00
Tyler Mandry c41019adda Add status of regions 2018-10-26 13:43:31 -05:00
Tyler Mandry fbb3ec6744 Associated types: Break up text for readability 2018-10-26 13:43:31 -05:00
Tyler Mandry 99a23f84a7 Associated types: Mention "lazy normalization" somewhere 2018-10-26 13:43:31 -05:00
Tyler Mandry c4708f8039 Traits: Improve index layout, add chalk blurb 2018-10-26 13:43:31 -05:00
Tyler Mandry 9ae8422607 Reflect traits chapter structure in index key ideas 2018-10-26 11:09:46 -05:00
Tyler Mandry 5c67241e1a Group logic-related things under one section
I found the layout to be a bit inconsistent before. This groups anything
that touches logic rules under "Lowering to logic".

This might be crowding too many things under that section, but it makes
more sense to me overall.
2018-10-26 11:09:46 -05:00
Nikita Popov 34c9d3fc77 Update TypeVariants to TyKind
This has been renamed in https://github.com/rust-lang/rust/pull/53581.
2018-10-26 11:05:19 -05:00
Who? Me?! 4196710286 Update src/traits/caching.md
Co-Authored-By: csmoe <csmoe@msn.com>
2018-10-24 23:22:17 -05:00
Who? Me?! e35e081b52 Update src/traits/hrtb.md
Co-Authored-By: csmoe <csmoe@msn.com>
2018-10-24 23:22:17 -05:00
Who? Me?! bd8d3f5f30 Update src/borrow_check/region_inference.md
Co-Authored-By: csmoe <csmoe@msn.com>
2018-10-24 23:22:17 -05:00
Who? Me?! 8cbf135744 Update src/borrow_check/region_inference.md
Co-Authored-By: csmoe <csmoe@msn.com>
2018-10-24 23:22:17 -05:00
csmoe 695728741e replace bound region with placeholder 2018-10-24 23:22:17 -05:00
csmoe 294fcd31ac clean up skolemiza in traits 2018-10-24 23:22:17 -05:00
csmoe a07a6de51d clean up skolemiza in borrow_ck 2018-10-24 23:22:17 -05:00
csmoe 8759055876 clean up skolemiza in glossary 2018-10-24 23:22:17 -05:00
Rajkumar Natarajan 607a58f8d2 issue_100_4 Updated the rustc documentation location 2018-10-24 19:32:09 -05:00
Who? Me?! 2fd124856d Add a note on bisecting 2018-10-23 16:27:58 -05:00
scalexm 39cdd4f920 Clarify wording 2018-10-22 12:18:04 -05:00
Who? Me?! 2b8f3d40e1 Fix typos and punctuation
Co-Authored-By: scalexm <alexandre@scalexm.fr>
2018-10-22 12:18:04 -05:00
scalexm 2df0fcfdfb Write implied bounds chapter 2018-10-22 12:18:04 -05:00
scalexm dfa38e973e Change wording 2018-10-22 12:14:46 -05:00
Who? Me?! ab89ea2446 Fix typo
Co-Authored-By: scalexm <alexandre@scalexm.fr>
2018-10-22 12:14:46 -05:00
Who? Me?! 07bf5e332b Add an apostrophe
Co-Authored-By: scalexm <alexandre@scalexm.fr>
2018-10-22 12:14:46 -05:00
scalexm 3db38fe7f3 Polish lowering chapters and update rules 2018-10-22 12:14:46 -05:00
Who? Me?! 4aeae78bdb Fix typo 2018-10-19 23:03:00 -05:00
Collins Abitekaniza a01aa11b7b fix typo in build instructions 2018-10-19 21:37:01 -05:00
Rajkumar Natarajan ceff08f6b3 updated with review comments 2018-09-29 08:50:30 -05:00
Rajkumar Natarajan 61cadd2097 issue-130 updated the review comments 2018-09-29 08:50:30 -05:00
Rajkumar Natarajan 062e158a67 issue-130 incorporate the review comments 2018-09-29 08:50:30 -05:00
Rajkumar Natarajan 0f65024f26 issue-130 copy contents related x.py from rust-forge 2018-09-29 08:50:30 -05:00
David Sanders d3b0eaed01 Typo nits #181 (#205) 2018-09-28 20:47:52 -05:00
Alcaro 946e11a578 conventions: Fix semicolon/colon typo 2018-09-28 20:04:05 -05:00
Tom Tromey 8871bd77b9 Document no-system-llvm 2018-09-28 13:00:41 -05:00
Mark Mansi 9297caaac3 Fix all the links! 2018-09-21 15:54:25 -05:00
Mark Mansi d36f89182d fix the last link 2018-09-21 15:54:25 -05:00
Mark Mansi 5ca9b3b326 Fix all the links to be relative for mdbook 2 2018-09-21 15:54:25 -05:00
Philipp Hansch 5ec3e1a620
Fix line lengths 2018-09-12 07:33:41 +02:00
Philipp Hansch c4ac71e1d0
Fix typos
These were fixed using [codespell](https://github.com/codespell-project/codespell).
2018-09-12 07:32:18 +02:00
Niko Matsakis a6284183f8 ignore various sample tests 2018-09-11 16:43:36 -04:00
Niko Matsakis d2cecbf3cd fix glossary links 2018-09-11 16:31:47 -04:00
Niko Matsakis 87382baca6 address nits 2018-09-11 16:31:47 -04:00
Niko Matsakis d453faee7a add content 2018-09-11 16:31:47 -04:00
Niko Matsakis 0ab21a2aa5 rearrange to promote the borrow checker into its own section 2018-09-11 16:31:47 -04:00
Niko Matsakis b655878d2c wrap lines in `running.md` 2018-09-11 16:22:15 -04:00
Niko Matsakis 69cdc0a77e wrap long lines 2018-09-11 12:02:58 -04:00
Niko Matsakis 4490acdbe6 remove silly `note:` 2018-09-11 12:02:58 -04:00
Niko Matsakis 576581da0d fix some more typos 2018-09-11 12:02:58 -04:00
Niko Matsakis 8cbf9d0b01 fix typo, add link 2018-09-11 12:02:58 -04:00
Niko Matsakis 4a6c34a168 fix typos 2018-09-11 12:02:57 -04:00
Niko Matsakis 4ab5fec4c6 note about why stage1/stage2 are different 2018-09-11 12:02:57 -04:00
Niko Matsakis 7d87e3cab2 wrap long lines 2018-09-11 12:02:57 -04:00
Niko Matsakis a2ad0a8eb2 document keep-stage1 2018-09-11 12:02:57 -04:00
Philipp Hansch 732dc4782e Mention incremental compilation in testing chapter
The `--incremental` flag was only mentioned in [how_to_build_and_run] so
far. Faster testing means faster iteration and perhaps even more added
tests.

[how_to_build_and_run]: https://rust-lang-nursery.github.io/rustc-guide/how-to-build-and-run.html
2018-09-10 19:30:07 -05:00
Niko Matsakis f72ba710ab fix various bash snippets 2018-09-10 19:25:29 -05:00
Niko Matsakis 5665ed6a7a links are always relative to root or what? 2018-09-10 19:25:29 -05:00
Niko Matsakis 694a90c19d fix link 2018-09-10 19:25:29 -05:00
Niko Matsakis fcbd9b907e add a note about the collector executable 2018-09-10 19:25:29 -05:00
Niko Matsakis 85ed2e32de update with njn's insight 2018-09-10 19:25:29 -05:00
Niko Matsakis 9a463df833 don't write `rust-prof` bur rather `<toolchain> 2018-09-10 19:25:29 -05:00
Niko Matsakis 37aa15e93f link to build-and-run, fix em-dash 2018-09-10 19:25:29 -05:00
Niko Matsakis cdc688451e say function, not fn 2018-09-10 19:25:29 -05:00
Niko Matsakis fb59bf5383 be consistent about bash snippets 2018-09-10 19:25:29 -05:00
Niko Matsakis 4e5ab2ac25 fix long lines 2018-09-10 19:25:29 -05:00
Niko Matsakis f1e087db37 switch to em-dash 2018-09-10 19:25:29 -05:00
Niko Matsakis 5571290aac various nits from mark-i-m 2018-09-10 19:25:29 -05:00
Niko Matsakis 44c05c72be add a section about profiling with perf 2018-09-10 19:25:29 -05:00
Dale Wijnand ad03ec4ee8
Write in English 2018-09-07 11:47:56 +01:00
Dale Wijnand e731de5755
No copyright notices on new tests 2018-09-07 11:46:53 +01:00
Niko Matsakis 81fd1c02f2 note about discussion channels 2018-08-31 23:03:48 -05:00
Niko Matsakis e295ad412e includ some notes on finding bugs 2018-08-31 23:03:48 -05:00
Niko Matsakis 207e669c1f fix various minor points 2018-08-31 23:03:48 -05:00
Niko Matsakis 7c200dffd7 adjust long lines 2018-08-31 23:03:48 -05:00
Niko Matsakis 3d094aa310 add a section about the compiler team 2018-08-31 23:03:48 -05:00
Niko Matsakis 5321d0059f tweak long line 2018-08-31 12:05:36 -05:00
Niko Matsakis f893fe8019 sprinkle links to rustdoc through the HIR explanation 2018-08-31 12:05:36 -05:00
Sébastien Duquette 581b5fc9cf address review comment 2018-08-23 21:56:35 -05:00
Sébastien Duquette a28a4cf252 Fix lines over 80 columns. 2018-08-23 21:56:35 -05:00
Sébastien Duquette 3aa13477d1 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 7836a59e48 add rust,ignore to code snippets 2018-08-20 11:46:41 -05:00
Oliver Schneider 6533ccebba Update existential-types.md 2018-08-20 11:46:41 -05:00
Oliver Schneider 9efa9f1346 Explain existential types 2018-08-20 11:46:41 -05:00
Josh Triplett 1f8e117292 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 6568317234 More descriptive name for #[test] implementation 2018-08-11 10:37:44 -05:00
John Renner 61adf4cb4b Shorten line length 2018-08-11 10:37:44 -05:00
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