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,331 Commits 3 Branches 0 Tags 114 MiB
Commit Graph

1331 Commits

Author SHA1 Message Date
Jakob Degen be11a5201d 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 328bd35e7d 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 5ee9d96c07
--verbose is useful when not compiling and when compiling (#901) 2020-09-29 17:18:00 +02:00
follower 6b5c62c6f8 Use implicit reference links for shorter lines 
(As suggested by jyn514.)
 2020-09-27 10:37:22 -04:00
follower e281cf57a6 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 35b702bf36 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 5f39b8131f Add docs for x.py setup 2020-09-27 04:24:18 +02:00
follower ea7ee3a503 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) c320337018 correct output path in Writing Documentation 2020-09-26 08:45:48 -04:00
Youngsuk_Kim e34496fb61 update link to 'BorrowKind' to be implicit in markdown 2020-09-25 22:55:49 -04:00
Youngsuk_Kim 80537ec118 add link to 'BorrowKind' in closure.md 2020-09-25 22:55:49 -04:00
Youngsuk_Kim 4a9c3579f3 update description of 'ByRef' borrows of closures 2020-09-25 22:55:49 -04:00
Youngsuk_Kim 0adf8a36c8 minor punctuation/grammar error fix 2020-09-25 22:55:49 -04:00
Jakob Degen d35a4c4bcb 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 30d03d013f 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 22b096ba2f
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 2a09b06365
`ConstEvalResult` is now `EvalToConstValueResult` (#885) 
Also fixed typo.
 2020-09-22 22:52:05 +02:00
Joshua Nelson 447064120f
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 1a547f7568 Fix typo in table of contents 2020-09-17 11:35:14 -04:00
Camelid f6ba69175b Revert "Mention that places are sometimes called "lvalues"" 
This reverts commit bf5e1c451d.
 2020-09-17 11:35:14 -04:00
Camelid c758b595b0 Mention that places are sometimes called "lvalues" 2020-09-17 11:35:14 -04:00
Camelid deb6710734 More improvements 2020-09-17 11:35:14 -04:00
Camelid 7ca5568bae 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 ed59c2d47d debug-logging=true instead of debug-assertions=yes 2020-09-16 21:56:05 -04:00
Dylan MacKenzie be58aab880 Add link for `AnalysisDomain::NAME` 2020-09-16 00:21:55 -04:00
Dylan MacKenzie a72fe531ce Describe how to generate graphviz diagrams for dataflow 2020-09-16 00:21:55 -04:00
Santiago Pastorino c911b40be5 Remove EN1 2020-09-15 18:13:33 -04:00
Santiago Pastorino f19d3e64b4 Complete text about salsa base inputs 2020-09-15 18:13:33 -04:00
Santiago Pastorino c99dc88eb8 Add Salsa In More Depth lecture 2020-09-15 18:13:33 -04:00
Camelid 42938a33fd Use latest patch release of mdBook and linkcheck 2020-09-15 18:11:05 -04:00
Camelid 4150ebb4ed Bump mdbook version 
0.4.1 -> 0.4.3
 2020-09-15 18:11:05 -04:00
LeSeulArtichaut d4ae7b08a9 Fix typo 
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-09-14 17:42:19 -05:00
LeSeulArtichaut 557f8063d3 Make the HIR chapter point to the new chapter on IDs 2020-09-14 17:42:19 -05:00
LeSeulArtichaut a87ac24331 Apply suggestions from code review 
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
 2020-09-14 17:42:19 -05:00
LeSeulArtichaut d91788c71d Add a chapter on all the identifiers used through `rustc` 2020-09-14 17:42:19 -05:00
Dylan MacKenzie 0520a58b42 Update `Visitor` and `Cursor` examples 2020-09-13 15:58:02 -04:00
Dylan MacKenzie 92fdaa6c42 Line edits 2020-09-13 15:58:02 -04:00
Dylan MacKenzie e8003db79a Add missing link to `Engine` 2020-09-13 15:58:02 -04:00
Dylan MacKenzie ed3d255153 Initial draft of MIR dataflow framework docs 2020-09-13 15:58:02 -04:00
Monadic Cat 2c733c97e8 correct attribute used here 2020-09-12 18:41:06 -04:00
Joshua Nelson 434556f9e0 Address nits 2020-09-12 13:12:14 -05:00
Joshua Nelson d333d1e74f Note that the default is 2015 2020-09-12 13:12:14 -05:00
Joshua Nelson e7b11c1d89 Document edition flag for UI tests 2020-09-12 13:12:14 -05:00
LeSeulArtichaut 716adae5ac Fix typo 2020-09-12 12:07:04 -04:00
LeSeulArtichaut e64ac0997e Hide `@rustdoc` implementation details 2020-09-12 12:07:04 -04:00
LeSeulArtichaut ff958b3d4b 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 5fa00e0074 Update src/rustbot.md 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 3c749064d3 Update src/rustbot.md 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 1d9675c905 Update src/contributing.md 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 58c2b85aa9 Update src/contributing.md 2020-09-12 12:07:04 -04:00