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

1299 Commits

Author SHA1 Message Date
Alexis Bourget f36f645daf Links to htmldocck/@has/matches for searchability 2020-11-11 19:02:37 -05:00
Olivier FAURE 10869964a7 Update src/compiler-debugging.md 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-11-11 10:39:15 -05:00
Olivier FAURE c15e119fd5 Update link in compiler-debugging.md 
Link didn't point to latest version of `env_logger` crate.

Add an explanation to disambiguate the RUSTC_LOG syntax.
 2020-11-11 10:39:15 -05:00
Casey Rodarmor b4acbb95ad Update src/building/how-to-build-and-run.md 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-11-09 09:07:41 +02:00
Casey Rodarmor 4e9e17fba4 Fix install command 2020-11-09 09:07:41 +02:00
Casey Rodarmor d0988bcb5d Document `src/tools/x`, an `x.py` wrapper 
Document the newly added `x` binary that wraps `x.py`, which can be
installed system-wide, and can be run from any subdirectory of a rust
repo checkout.
 2020-11-09 09:07:41 +02:00
Joshua Nitschke 877f5fbdaf
correct minor grammar mistake (#944) 
correct `a lots to `a lot` on implementing_new_features.md
 2020-11-08 19:15:22 +01:00
Yuki Okushi 1b43503411 Use `provide_both` link instead of `provide(_extern)` 2020-11-06 19:18:15 -06:00
Camelid cc841a185f Use new-style mdBook internal links in glossary 2020-10-28 18:33:30 -04:00
Camelid 384eddb2ef Put `TyCtxt` at the right position 
It should now be at its alphabetical position.

Also fixed link to `TyCtxt` anchor.
 2020-10-28 18:33:30 -04:00
Camelid 5d6a0cdf69 Fix broken tags in glossary 2020-10-28 18:33:30 -04:00
Santiago Pastorino 5b3fd170fc
Small improvements (#936) 
* Fix typo errros -> errors

* an -> a

* hir -> hir()
 2020-10-27 19:34:28 +01:00
Camelid de4ca80796
Add "ctxt" and `TyCtxt` to the glossary (#937) 2020-10-27 19:30:20 +01:00
Camelid 30c298dd7c
Clean up `compiletest` chapter (#935) 2020-10-26 11:58:00 +09:00
Yuki Okushi 53a7fd3ad3
Improve prerequisites section for Windows (#934) 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-10-26 08:15:21 +09:00
Nadrieril b1af2f0c07 Explain lint renaming/removing 2020-10-22 20:41:09 -04:00
Yuki Okushi 47893bacd8
Add reference PRs for `r?` and `r+` comments (#928) 2020-10-21 23:53:32 +02:00
Yuki Okushi 97eebb9adb Replace links to `buildbot2.r-l.o` with `bors.r-l.o` 2020-10-21 17:34:07 -04:00
Joshua Nelson bd82b75020 Revert "Remove outdated build rustdoc --stage 1" 
This reverts commit cd35d2b594.
 2020-10-19 23:17:17 -04:00
Ivan Tham cd35d2b594 Remove outdated build rustdoc --stage 1 
It builds with stage 1 by default.
 2020-10-19 22:23:59 -04:00
Santiago Pastorino 783c5849c4 Fix typo errros -> errors 2020-10-19 14:11:19 -04:00
Nadrieril b04860c078 Explain why exhaustiveness is necessary for soundness 2020-10-16 18:26:10 -04:00
Nadrieril ada57a32f2 Explain pattern exhaustiveness checking 2020-10-16 18:26:10 -04:00
Yuki Okushi 7f9c36b6a9 Fix a link on git.md 2020-10-15 23:11:33 -04:00
1c3t3a f34dd04a39
Added description of word Scrutinee to the glossary (#921) 2020-10-13 01:57:18 +09:00
LeSeulArtichaut 50f1e77e4a Apply suggestions from code review 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-10-10 12:12:44 -04:00
LeSeulArtichaut 3f9812cfaa Talk about git submodules 2020-10-10 12:12:44 -04:00
Joshua Nelson d1e314f53e 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 95b1f2b08e Update more occurrences of system llvm link 2020-10-08 11:47:32 -04:00
Stu e912d1904b Fix broken "system LLVM" link 2020-10-08 11:47:32 -04:00
mautamu 2e8a3e8f6d
Fix typos (#916) 
Fixed two typos.
 2020-10-08 16:19:56 +09:00
Cass b8cc0a5355 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 d4581a56ae Document `Assemble` 2020-10-04 11:59:58 -04:00
Joshua Nelson 10878783ce
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?! 5b895d7040 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 3f853d5a30 address lingering reviewer comments 2020-10-04 10:14:22 -04:00
Gus Wynn e5bf706189 Apply suggestions from code review 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-10-04 10:14:22 -04:00
Gus Wynn 1753f0f10d add note 2020-10-04 10:14:22 -04:00
Gus Wynn 9175746a7e add suggested workflow to setup nightly rustup for rustc 2020-10-04 10:14:22 -04:00
Julian Wollersberger f7870395f5 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 7adeb090fc Document the usage of cargo-llvm-lines and -Ztimings. 2020-10-04 10:12:47 -04:00
Aleksey Kladov 95650a8cbb 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 c583e8b982 hir_map -> hir() 2020-10-03 19:38:38 -05:00
LeSeulArtichaut 47ce12a4c8 Fix time periods for Triage WG procedure 2020-10-03 19:25:05 -05:00
Tshepang Lekhonkhobe f833b8bcdf 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 080b0c8aad Update src/getting-started.md 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-10-03 19:25:05 -05:00
LeSeulArtichaut 3d6d0e04ed Add a paragraph about reviewers and review latency in Getting Started chapter 2020-10-03 19:25:05 -05:00
Camelid 6a5b29b31e
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 156423221c Fix the report link 2020-10-03 16:12:04 -04:00
Camelid 6159dde37a 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 fdd5946d58 add the last missing code highlight to t-compiler in the docs 2020-10-02 12:37:27 +02:00
Joshua Nelson a8b7e92c12 Fix typo 2020-09-30 22:39:25 +02:00
Jakob Degen c26ab70782 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 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
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