Commit graph

1325 commits

Author SHA1 Message Date
Joshua Nelson
8a8ae8ca9b Add docs for x.py setup 2020-09-27 04:24:18 +02:00
follower
df11ed503f Add link from "Writing Documentation" suggestion
A link to the relevant section of the contributing documentation makes it easier for contributors to locate the relevant information. (e.g. via an in-page search for "doc".)

This is particularly important currently as 85072e3303/CONTRIBUTING.md links directly to the (currently `rustc`-focused) "Getting Started" guide rather than the general Rust contribution content to which it used to point.
2020-09-26 11:52:14 -04:00
Shahar Or (mightyiam)
aace4f0c24 correct output path in Writing Documentation 2020-09-26 08:45:48 -04:00
Youngsuk_Kim
14fc590808 update link to 'BorrowKind' to be implicit in markdown 2020-09-25 22:55:49 -04:00
Youngsuk_Kim
34cfcbcf26 add link to 'BorrowKind' in closure.md 2020-09-25 22:55:49 -04:00
Youngsuk_Kim
3ee6367d1e update description of 'ByRef' borrows of closures 2020-09-25 22:55:49 -04:00
Youngsuk_Kim
268028e259 minor punctuation/grammar error fix 2020-09-25 22:55:49 -04:00
Jakob Degen
370b79975c Remove reference to copyright notices.
Immediately below the section on copyright notices being removed,
it is mentioned that a particular thing should be placed below the
notices. This seems confusing.
2020-09-24 11:45:35 -04:00
Dániel Buga
9373c8d588 Link to the -Zmir-opt-level proposal
I was confused about what the different levels mean. This PR adds a paragraph that shortly explains the rationale behind different mir-opt-levels and links to the current proposal where there's some information about them.

Let me know if I wrote something unreasonable or incorrect.

Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-23 18:42:23 -04:00
Joshua Nelson
30ca044a71 Don't recommend building the compiler for running tests on the standard library (#887)
Thought of this while reading https://internals.rust-lang.org/t/contributing-changes-to-std/12829/.
2020-09-23 15:46:43 +00:00
Camelid
08162cbd1e ConstEvalResult is now EvalToConstValueResult (#885)
Also fixed typo.
2020-09-22 22:52:05 +02:00
Joshua Nelson
0d195f113b Improve instructions for adding a new test (#881)
* Improve instructions for adding a new test

- Add a section for library tests
- Expand section on rustdoc tests

* Address review comments

- Say what should be considered a library test
- Mention adding error numbers to doc tests
- Link to #ui section
- Line wrapping

* Fix incorrect link

It shouldn't have been a link in the first place.

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-09-19 23:40:17 +00:00
Camelid
3fd9f3bd08 Fix typo in table of contents 2020-09-17 11:35:14 -04:00
Camelid
9d5753910d Revert "Mention that places are sometimes called "lvalues""
This reverts commit bf5e1c451de505fa453672c1168b09db07a145cb.
2020-09-17 11:35:14 -04:00
Camelid
c72daace49 Mention that places are sometimes called "lvalues" 2020-09-17 11:35:14 -04:00
Camelid
d706ba09db More improvements 2020-09-17 11:35:14 -04:00
Camelid
3829c92694 Improve MIR sections in appendix
Add a new graphical representation of one of the examples of MIR and
basic blocks!

And make other minor improvements.
2020-09-17 11:35:14 -04:00
Macdonald Umoren
72d3b5ab28 debug-logging=true instead of debug-assertions=yes 2020-09-16 21:56:05 -04:00
Dylan MacKenzie
4b013d3193 Add link for AnalysisDomain::NAME 2020-09-16 00:21:55 -04:00
Dylan MacKenzie
32ea891485 Describe how to generate graphviz diagrams for dataflow 2020-09-16 00:21:55 -04:00
Santiago Pastorino
bcf72c5049 Remove EN1 2020-09-15 18:13:33 -04:00
Santiago Pastorino
6651dfc4e4 Complete text about salsa base inputs 2020-09-15 18:13:33 -04:00
Santiago Pastorino
699c4ea15d Add Salsa In More Depth lecture 2020-09-15 18:13:33 -04:00
Camelid
1fce3538fe Use latest patch release of mdBook and linkcheck 2020-09-15 18:11:05 -04:00
Camelid
b2ef790264 Bump mdbook version
0.4.1 -> 0.4.3
2020-09-15 18:11:05 -04:00
LeSeulArtichaut
55aa7e3dd7 Fix typo
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-09-14 17:42:19 -05:00
LeSeulArtichaut
9688d2dc29 Make the HIR chapter point to the new chapter on IDs 2020-09-14 17:42:19 -05:00
LeSeulArtichaut
b89337828e Apply suggestions from code review
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-14 17:42:19 -05:00
LeSeulArtichaut
03eaf2a306 Add a chapter on all the identifiers used through rustc 2020-09-14 17:42:19 -05:00
Dylan MacKenzie
153e35ff27 Update Visitor and Cursor examples 2020-09-13 15:58:02 -04:00
Dylan MacKenzie
c6e556591e Line edits 2020-09-13 15:58:02 -04:00
Dylan MacKenzie
f75d4b1eb9 Add missing link to Engine 2020-09-13 15:58:02 -04:00
Dylan MacKenzie
f9d3b7f4db Initial draft of MIR dataflow framework docs 2020-09-13 15:58:02 -04:00
Monadic Cat
435040d125 correct attribute used here 2020-09-12 18:41:06 -04:00
Joshua Nelson
fde149364d Address nits 2020-09-12 13:12:14 -05:00
Joshua Nelson
27d5948e40 Note that the default is 2015 2020-09-12 13:12:14 -05:00
Joshua Nelson
cae32c9e59 Document edition flag for UI tests 2020-09-12 13:12:14 -05:00
LeSeulArtichaut
90f6ed4b82 Fix typo 2020-09-12 12:07:04 -04:00
LeSeulArtichaut
5baa430ffe Hide @rustdoc implementation details 2020-09-12 12:07:04 -04:00
LeSeulArtichaut
293aad5081 Apply suggestions from code review
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe
2961c91f12 Update src/rustbot.md 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe
9b1cee6911 Update src/rustbot.md 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe
d6f629822d Update src/contributing.md
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe
a28c6a4c86 Update src/contributing.md 2020-09-12 12:07:04 -04:00
LeSeulArtichaut
87b9d337b9 Add a chapter on useful @rustbot commands 2020-09-12 12:07:04 -04:00
Gus Wynn
453611df6f Improve link and description of entry points in parser section (#876)
This seemed to be out of date!
2020-09-12 08:49:05 +09:00
LeSeulArtichaut
7ccdf4c015 Fix typo
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-11 13:42:39 +02:00
LeSeulArtichaut
f9e705071e Apply suggestions from code review
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-11 13:42:39 +02:00
LeSeulArtichaut
531b8d5d50 Clean up 'Contributing to Rust - Pull Requests' 2020-09-11 13:42:39 +02:00
Joshua Nelson
69299dc069 Fix other library commands 2020-09-10 23:56:41 -04:00