mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
1,336 Commits 3 Branches 0 Tags 114 MiB
Commit Graph

1336 Commits

Author SHA1 Message Date
Joshua Nelson 219c8df6dc Fix incorrect windows link 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-10-01 01:27:11 -04:00
Joshua Nelson a4a89a549d Add windows instructions 2020-10-01 01:27:11 -04:00
Joshua Nelson 3f1414cb00 Recommend setting up `check_line_lengths` as a pre-commit script 
I've run into lots of annoying failures from this.

- Make it runnable without arguments
- Add it in the README
 2020-10-01 01:27:11 -04:00
Joshua Nelson 1c59aa9409 Fix typo 2020-09-30 22:39:25 +02:00
Jakob Degen 7f590fa025 Incorporated suggestions into git page and edit for more brevity. 
The Advanced Rebasing section has been mostly rewritten to include
both a major suggestion from jyn and a general rewrite. Additional
thanks to camelid for some suggestions!
 2020-09-30 10:13:42 -04:00
Jakob Degen fb23f10071 Edit using git page for brevity and clarity. 
The previous iteration of the page was often wordy and
occasionally unclear. This has been cleaned up in places.

Additionally, the TODO in the no-merge policy section has been
removed and addressed.
 2020-09-30 10:13:42 -04:00
Jakob Degen 7fdae85e96 Add a section on using git. 
This section addresses the biggest issues that new contributors,
especially those with limited familiarity with git, are likely to
face. This is still a WIP.

Thanks to jyn for the recommended improvements!
 2020-09-30 10:13:42 -04:00
Santiago Pastorino 915fabf4cc --verbose is useful when not compiling and when compiling (#901) 2020-09-29 17:18:00 +02:00
follower 506f2e77c1 Use implicit reference links for shorter lines 
(As suggested by jyn514.)
 2020-09-27 10:37:22 -04:00
follower e2a1deb657 Fix line length error. 
Reduced line length to <100 (as indicated by PR build error).

(Also removed extra space character before link.)
 2020-09-27 10:37:22 -04:00
follower 1e77d7f743 Add links to documentation sources. 
Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them.
 2020-09-27 10:37:22 -04:00
Joshua Nelson edc31ef0bc Add docs for x.py setup 2020-09-27 04:24:18 +02:00
follower 3ac6fc75ef 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) 2ad2cb7c97 correct output path in Writing Documentation 2020-09-26 08:45:48 -04:00
Youngsuk_Kim 18c7583466 update link to 'BorrowKind' to be implicit in markdown 2020-09-25 22:55:49 -04:00
Youngsuk_Kim 49611100bf add link to 'BorrowKind' in closure.md 2020-09-25 22:55:49 -04:00
Youngsuk_Kim 06fdc4321e update description of 'ByRef' borrows of closures 2020-09-25 22:55:49 -04:00
Youngsuk_Kim a0958b664c minor punctuation/grammar error fix 2020-09-25 22:55:49 -04:00
Jakob Degen b7970e6c5e 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 727a536ba9 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 7609eb11ee 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 ca00e2eefe `ConstEvalResult` is now `EvalToConstValueResult` (#885) 
Also fixed typo.
 2020-09-22 22:52:05 +02:00
Joshua Nelson 9c5e356ed5 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 27ff56d829 Fix typo in table of contents 2020-09-17 11:35:14 -04:00
Camelid 0a80107e34 Revert "Mention that places are sometimes called "lvalues"" 
This reverts commit bf5e1c451d.
 2020-09-17 11:35:14 -04:00
Camelid e645304ce9 Mention that places are sometimes called "lvalues" 2020-09-17 11:35:14 -04:00
Camelid fd525a93d6 More improvements 2020-09-17 11:35:14 -04:00
Camelid 231e3d9c83 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 7bda848e3c debug-logging=true instead of debug-assertions=yes 2020-09-16 21:56:05 -04:00
Dylan MacKenzie 42be58a751 Add link for `AnalysisDomain::NAME` 2020-09-16 00:21:55 -04:00
Dylan MacKenzie ca60ec06df Describe how to generate graphviz diagrams for dataflow 2020-09-16 00:21:55 -04:00
Santiago Pastorino 9f4e7038fa Remove EN1 2020-09-15 18:13:33 -04:00
Santiago Pastorino a7d0f3f2dd Complete text about salsa base inputs 2020-09-15 18:13:33 -04:00
Santiago Pastorino 6cf849f63b Add Salsa In More Depth lecture 2020-09-15 18:13:33 -04:00
Camelid cf031f4008 Use latest patch release of mdBook and linkcheck 2020-09-15 18:11:05 -04:00
Camelid 63f5a8b43c Bump mdbook version 
0.4.1 -> 0.4.3
 2020-09-15 18:11:05 -04:00
LeSeulArtichaut 0d2b8eb1c4 Fix typo 
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-09-14 17:42:19 -05:00
LeSeulArtichaut e6a94b2355 Make the HIR chapter point to the new chapter on IDs 2020-09-14 17:42:19 -05:00
LeSeulArtichaut c7ec4769ab Apply suggestions from code review 
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
 2020-09-14 17:42:19 -05:00
LeSeulArtichaut fe19fc65f2 Add a chapter on all the identifiers used through `rustc` 2020-09-14 17:42:19 -05:00
Dylan MacKenzie 1fffd48313 Update `Visitor` and `Cursor` examples 2020-09-13 15:58:02 -04:00
Dylan MacKenzie ddc23efa5f Line edits 2020-09-13 15:58:02 -04:00
Dylan MacKenzie 0cc3a9f8f3 Add missing link to `Engine` 2020-09-13 15:58:02 -04:00
Dylan MacKenzie 3db7809e77 Initial draft of MIR dataflow framework docs 2020-09-13 15:58:02 -04:00
Monadic Cat 3b5a774a61 correct attribute used here 2020-09-12 18:41:06 -04:00
Joshua Nelson 7e42258f16 Address nits 2020-09-12 13:12:14 -05:00
Joshua Nelson 01c34848a3 Note that the default is 2015 2020-09-12 13:12:14 -05:00
Joshua Nelson 71853f5a5c Document edition flag for UI tests 2020-09-12 13:12:14 -05:00
LeSeulArtichaut eb39e07c58 Fix typo 2020-09-12 12:07:04 -04:00
LeSeulArtichaut 5ff253c02a Hide `@rustdoc` implementation details 2020-09-12 12:07:04 -04:00