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

1236 Commits

Author SHA1 Message Date
Camelid e58307a28e Clean up `compiletest` chapter (#935) 2020-10-26 11:58:00 +09:00
Yuki Okushi e55ee68ed0 Improve prerequisites section for Windows (#934) 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-10-26 08:15:21 +09:00
Nadrieril f0cd34e615 Explain lint renaming/removing 2020-10-22 20:41:09 -04:00
Yuki Okushi 61feec113f Add reference PRs for `r?` and `r+` comments (#928) 2020-10-21 23:53:32 +02:00
Yuki Okushi a6279510e2 Replace links to `buildbot2.r-l.o` with `bors.r-l.o` 2020-10-21 17:34:07 -04:00
Joshua Nelson ee849ff66e Revert "Remove outdated build rustdoc --stage 1" 
This reverts commit cd35d2b594.
 2020-10-19 23:17:17 -04:00
Ivan Tham e4a7be5779 Remove outdated build rustdoc --stage 1 
It builds with stage 1 by default.
 2020-10-19 22:23:59 -04:00
Santiago Pastorino 269158b77e Fix typo errros -> errors 2020-10-19 14:11:19 -04:00
Nadrieril d859c9924e Explain why exhaustiveness is necessary for soundness 2020-10-16 18:26:10 -04:00
Nadrieril 5ddfd9bfe9 Explain pattern exhaustiveness checking 2020-10-16 18:26:10 -04:00
Yuki Okushi 2b1e754e83 Fix a link on git.md 2020-10-15 23:11:33 -04:00
1c3t3a 5f06872226 Added description of word Scrutinee to the glossary (#921) 2020-10-13 01:57:18 +09:00
LeSeulArtichaut 66649d9c81 Apply suggestions from code review 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-10-10 12:12:44 -04:00
LeSeulArtichaut eee78ac90f Talk about git submodules 2020-10-10 12:12:44 -04:00
Joshua Nelson d056730692 Recommend debug-logging instead of debug 
This makes the compiler faster to running without sacrificing too much
performance. It still shows logging so contributors aren't confused by
`debug!` doing nothing.
 2020-10-08 16:15:06 -05:00
Justus K 1ae9303960 Update more occurrences of system llvm link 2020-10-08 11:47:32 -04:00
Stu ac6fb7efa1 Fix broken "system LLVM" link 2020-10-08 11:47:32 -04:00
mautamu db41bec0c9 Fix typos (#916) 
Fixed two typos.
 2020-10-08 16:19:56 +09:00
Cass 9ccc69f152 Add section describing git hook functionality 
This is a companion to [this PR](https://github.com/rust-lang/rust/pull/76356), which deals with including functionality for automatically running `tidy --bless` on each commit.

Undo editor auto-formatting and clarify git hook renaming

a word

Phrasing

Apply suggestions from code review

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-10-07 22:30:24 -04:00
Joshua Nelson 5fabea540a Document `Assemble` 2020-10-04 11:59:58 -04:00
Joshua Nelson fcc93a7043 Explain stages in terms of the compiler currently running (take N+1) (#857) 
* Explain stages in terms of the compiler currently running

- Address some confusing points
  + stage N+1 -> stage N artifacts
  + Use more likely examples of an ABI break
  + stage N -> stage N compiler

- Mention why rustc occasionally uses `cfg(bootstrap)`
- Note that stage1 is built using two different versions

- Add lots of examples
  + `test src/test/ui` and `test compiler/rustc` run different compilers 😢
  + Separate examples of what to do from examples of what not to do

- 'ship stage 1 artifacts' -> 'ship stage 2 compiler'

  This is hopefully less confusing.

* build -> x.py build

* Add section on build artifacts

* Improve wording

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>

* uplifted -> assembled

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-10-04 16:25:02 +02:00
Who? Me?! 3b4462f582 Link to .md files, rather than .html 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-10-04 10:14:22 -04:00
mark 42173ef770 address lingering reviewer comments 2020-10-04 10:14:22 -04:00
Gus Wynn 08d244e06c Apply suggestions from code review 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-10-04 10:14:22 -04:00
Gus Wynn 58255429d8 add note 2020-10-04 10:14:22 -04:00
Gus Wynn c3a67e32dc add suggested workflow to setup nightly rustup for rustc 2020-10-04 10:14:22 -04:00
Julian Wollersberger 9a46f17fab Did more measurements on what exactly affects llvm-lines: 
optimize, codegen-units and mir-opt do, but debug-assertions doesn't.
 2020-10-04 10:12:47 -04:00
Julian Wollersberger 476dd40f63 Document the usage of cargo-llvm-lines and -Ztimings. 2020-10-04 10:12:47 -04:00
Aleksey Kladov d1651dbd5e Document new way to not build LLVM 
Implemented in https://github.com/rust-lang/rust/pull/76349
 2020-10-03 20:39:32 -04:00
Santiago Pastorino 773b3c3e95 hir_map -> hir() 2020-10-03 19:38:38 -05:00
LeSeulArtichaut efb9029fc8 Fix time periods for Triage WG procedure 2020-10-03 19:25:05 -05:00
Tshepang Lekhonkhobe c63a20ccbf Update src/getting-started.md 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-10-03 19:25:05 -05:00
Tshepang Lekhonkhobe d3f37158ac Update src/getting-started.md 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-10-03 19:25:05 -05:00
LeSeulArtichaut ff894213a7 Add a paragraph about reviewers and review latency in Getting Started chapter 2020-10-03 19:25:05 -05:00
Camelid b431d8211c Use HTTPS whenever possible in bibliography links (#909) 
Also updated a few links that redirected.
 2020-10-03 22:56:29 +02:00
Yuki Okushi b61231e905 Fix the report link 2020-10-03 16:12:04 -04:00
Camelid d9a98418f7 Fix instructions for squashing 
`git merge-base master` does not work, you need
`git merge-base master HEAD` instead.
 2020-10-02 15:08:28 -04:00
Roman 62ae93b3a3 add the last missing code highlight to t-compiler in the docs 2020-10-02 12:37:27 +02: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