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

1834 Commits

Author SHA1 Message Date
Iñaki Garay 320df682bd
rustc invocation standarized (#992) 
* rustc invocation standarized

* Addressed comments

* Addressed comments

* Addressed comments

* Updated command output
 2020-12-28 23:34:51 +01:00
Wesley Wiser a436d3aedf
Update glossary.md (#994) 
* Update glossary.md

- Added additional information to some of the definitions.

- Made term capitalization consistent so that only terms which refer to acronyms or concrete types are capitalized. Please let me know if that isn't desirable for some reason.

* Update src/appendix/glossary.md

Co-authored-by: Joshua Nelson <jyn514@gmail.com>

* Update src/appendix/glossary.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Update src/appendix/glossary.md

Co-authored-by: Joshua Nelson <jyn514@gmail.com>
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
 2020-12-28 20:05:06 +01:00
Iñaki Garay a17b865540
[Fixes #778] Added and reorganized lecture links (#993) 
* Added and reorganized lecture links

* Addressed comments

* Addressed comments
 2020-12-27 20:50:53 +01:00
Yuki Okushi 3eb86119dc
Document `error-pattern` header (#989) 
* Document `error-pattern` header

* Address some reviews
 2020-12-12 16:06:30 +01:00
Yuki Okushi 1838d293f7 Fix some link failures and typos 2020-12-11 16:00:15 -05:00
Nixon Enraght-Moony a6a9c67616 All links to rustdoc-internals.md 2020-12-10 14:51:04 -05:00
Camelid 1135856424
Add a section on identifiers in the MIR (#951) 
* Add a section on identifiers in the MIR

* Better wording

* Use loose lists; fix typo; fix link

* Update info

* Note how you can retrieve the associated data

Suggested by @LeSeulArtichaut.

* Update src/identifiers.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Add TODO for `Promoted` re `GlobalId`

Co-authored-by: Oli Scherer <github35764891676564198441@oli-obk.de>
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
 2020-12-07 20:56:25 +01:00
Rich Kadel 9f612dace6 Adds a dev guide section on Rust Coverage 2020-12-07 14:22:45 -05:00
Siddharth edc94c0c84
Edit the Mir page to fix infelicities. (#984) 
* Edit the Mir page to fix infelicities.

- Remove dead reference to Mir. reflow sentence to talk about
  `Body::local_decls`
- Fix broken links to render properly.
- Add links for `Terminator`, `RETURN_PLACE`, `ProjectionElem`.

* Update src/mir/index.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Edit the Mir page to fix infelicities.

- Remove dead reference to Mir. reflow sentence to talk about
  `Body::local_decls`
- Fix broken links to render properly.
- Add links for `Terminator`, `RETURN_PLACE`, `ProjectionElem`.

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
 2020-12-06 15:36:52 +01:00
Siddharth 02068c0612
Add links to the rust documentation for all MIR structs (#982) 
* Add links to the rust documentation for all MIR structs

* Update src/mir/index.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Update src/mir/index.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
 2020-12-06 14:40:45 +01:00
Joshua Nelson 55c7be5d83
Link to the Rustdoc book in the rustdoc chapter (#981) 
This makes a) makes it easier to find info about rustdoc's features and
b) redirects people in the wrong place to where they should be looking.
 2020-12-04 18:23:46 +01:00
mark af2aa997d0 fix a couple links 2020-12-03 00:06:19 -05:00
jumbatm 459e414b3a Use shorter [][]-style link to not pass 100 chars. 2020-12-02 22:34:16 -06:00
jumbatm 3658303988 Apply suggestions from review. 
Co-authored-by: Camelid <camelidcamel@gmail.com>
 2020-12-02 22:34:16 -06:00
jumbatm f7d7e48874 Document SessionDiagnostic 2020-12-02 22:34:16 -06:00
Camelid 29c66a3f02 Use shorter 'rustbot label' command 
'rustbot modify labels: ...' -> 'rustbot label ...'
 2020-12-01 13:56:48 -05:00
Joshua Nelson 792ccb1523
Move the bootstrapping section later in the guide (#975) 
Now that `x.py build` works in most cases, I don't think we need to
teach people all the intricacies of bootstrap right away. This moves it
to the 'overview of the compiler' section instead.
 2020-11-30 20:08:17 -03:00
Ben Striegel dc72220925 Address feedback 2020-11-30 18:06:43 -05:00
Ben Striegel fb6176d2a2 Add notes about running the UI test suite 2020-11-30 18:06:43 -05:00
Joshua Nelson 59de3a0c58 Document what 'sysroot' means 2020-11-29 20:02:55 -05:00
Joshua Nelson eb8fefbea0 Don't imply that the name of the fork always needs to be changed 2020-11-29 10:42:20 -05:00
Joshua Nelson 4663f85bd0 Add information about common git issues 2020-11-29 10:42:20 -05:00
Hirochika Matsumoto ad67023401 Fix a typo 2020-11-28 14:09:03 -05:00
Camelid f9b3946411 Link to feature-stabilization docs 2020-11-26 20:43:36 -05:00
Camelid 23b04794db Move instructions for adding a feature gate to "Feature Gates" 2020-11-26 20:43:36 -05:00
Camelid 72eca8fcc5 Document how to modify feature gates 
How to remove them and how to rename them.

cc <https://github.com/rust-lang/rust/pull/79336#discussion_r528627318>
cc @varkor
 2020-11-26 20:43:36 -05:00
Camelid 5f7bd57942
Document when errors should have an associated error code (#967) 
Document when errors should have an associated error code
 2020-11-24 17:09:59 -08:00
Gabriel de Perthuis b5af9f07f2 Update bootstrap documentation with the new envvars for RUSTFLAGS 
This follows <https://github.com/rust-lang/rust/pull/63722>.
 2020-11-24 09:06:33 -05:00
Camelid 8e87c1cf0a Update `param_env` link 
`rustc_ty` was recently [renamed] to `rustc_ty_utils`, so this link has
to be updated.

[renamed]: f59d03038c
 2020-11-23 18:40:46 -05:00
cjkenn da0701b979 add small explanation of why fuel can be useful for debugging 2020-11-22 08:43:00 -05:00
cjkenn 8f5a1440ae add mir-opt section for optimization fuel 2020-11-22 08:43:00 -05:00
hosseind88 2777deecfa
add string interning wikipedia link (#960) 2020-11-15 12:14:06 -05:00
Camelid 25016aeb3b Provide a brief example of a data-flow analysis 2020-11-12 11:53:00 -05:00
Camelid 79b3788fd7 Explain the purpose of the bottom value 2020-11-12 11:53:00 -05:00
Camelid 9e346c9d17 Add a section on data-flow convergence 2020-11-12 11:53:00 -05:00
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
Tshepang Lekhonkhobe 58c2b85aa9 Update src/contributing.md 2020-09-12 12:07:04 -04:00
LeSeulArtichaut e616159576 Add a chapter on useful `@rustbot` commands 2020-09-12 12:07:04 -04:00
Gus Wynn cccee1a93e
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 150b915338 Fix typo 
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
 2020-09-11 13:42:39 +02:00
LeSeulArtichaut 6366c1dbaa Apply suggestions from code review 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-09-11 13:42:39 +02:00
LeSeulArtichaut ee99dea822 Clean up 'Contributing to Rust - Pull Requests' 2020-09-11 13:42:39 +02:00
Joshua Nelson a85aed08e4 Fix other library commands 2020-09-10 23:56:41 -04:00
Joshua Nelson b3b8f0ad6c Fix incorrect docs about stages 
`build library/core` builds the compiler, not just the standard library.
 2020-09-10 23:56:41 -04:00
Camelid 0b58331de0 Add back information about Googling 
Also cleaned up some other things.
 2020-09-09 22:58:18 -04:00
Camelid 3c353e4eec Add back comma 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-09-09 22:58:18 -04:00
Camelid 9e00fdfc93 Add more info about Rustdoc 2020-09-09 22:58:18 -04:00
Camelid d145fcdb4e Update "Helpful Links" section 2020-09-09 22:58:18 -04:00
Joshua Nelson ab19c3eef8 Use imprecise times, because the time to build depends on your computer 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-09-09 20:58:30 -04:00
Camelid a7ac2cbad6 Minor cleanup for "How to build and run" 2020-09-09 20:58:30 -04:00
Rich Kadel 91a4afbcc6 broken intra-page link from spanview to graphviz 
Just noticed the link was not correct. Fixed here.
 2020-09-09 19:01:14 -04:00
Joshua Nelson 683cbdda74 Fix nit 2020-09-09 21:39:55 +02:00
Tshepang Lekhonkhobe 987b5ef008 Update src/building/new-target.md 2020-09-09 21:39:55 +02:00
Joshua Nelson 7d54418137 Document how to promote a target from cross-compiled to hosted 2020-09-09 21:39:55 +02:00
Santiago Pastorino af3a92e843 Update src/queries/profiling.md 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-09-09 12:30:56 -04:00
Santiago Pastorino 91bfaa8e20 Update def_id.rs location 2020-09-09 12:30:56 -04:00
Santiago Pastorino e1f750feda Fix typo, hellow -> hello 2020-09-09 12:30:56 -04:00
Santiago Pastorino 35af35dd89 Add ./ to run x.py 2020-09-09 12:30:56 -04:00
Joshua Nelson ab5809b018
Update prerequisites, with an eye towards windows (#863) 
* Update prerequisites, with an eye towards windows

* Address review comments

- Say version of MSVC needed
- Link to more details windows section
- Fix grammar
 2020-09-09 16:24:01 +00:00
Joshua Nelson b29062cb76
Fix broken hyperlink (#862) 
* Fix broken hyperlink

* Link to previous pages instead of skipping ahead

* Fix line lengths
 2020-09-09 16:22:56 +00:00
Joshua Nelson daa7597067 Add information about default stages for x.py 2020-09-09 11:05:26 -04:00
Joshua Nelson 13c18fccbe Fix typo 2020-09-09 16:58:05 +02:00
Joshua Nelson 75ad441702
Document speculative crate loading (#859) 2020-09-09 10:19:01 +03:00
Joshua Nelson 677a95f264 Update error codes to match the current implementation 
- All codes are in one crate, `rustc_error_codes`
- Extended descriptions are loaded using `include_str!`
- Give an example of a PR adding an error code
 2020-09-08 13:59:34 +02:00
Joshua Nelson fb88941f06
Consolidate information about bootstrapping into one place (#851) 
Previously, 'How to build and run' had a long section on the different
stages of boostrap. But new contributors aren't interested in bootstrap;
they want to start their build (because they heard it takes forever and
want to start it so they aren't waiting more than necessary).

This moves the section on stages into the bootstrapping page, and links
there instead of discussing it on the main page.
 2020-09-07 15:25:11 +00:00
Aman Arora d8db731a4a Document CGU partioning in case of generic and inline functions 2020-09-07 10:07:40 -04:00
Tshepang Lekhonkhobe d117002719 Update src/building/how-to-build-and-run.md 2020-09-07 08:55:08 -04:00
Joshua Nelson e69542d0ea Link to 'prerequisites' immediately 
Several of the commands on 'how to build' use python.
But we haven't yet told the user how to install it!
Do that first before going into detail on how x.py works.
 2020-09-07 08:55:08 -04:00
Ivan Tham bb4695345e Rename src/rustc to compiler/rustc 2020-09-06 16:21:08 +02:00
Gus Wynn 039e29f77c update docs to refer to the move 2020-09-03 19:25:02 -04:00
Santiago Pastorino af533030a2 Fix dep-graph-caller-callee test location 2020-09-03 16:21:30 +02:00
Rich Kadel b737f79192 Adds documentation to cover spanview output 
Documents the feature introduced in #76074.
 2020-09-02 12:39:47 +02:00
Joshua Nelson 2924b6962d Use fewer stages in bootstrapping docs 
After https://github.com/rust-lang/rust/pull/73964, they're redundant.
 2020-08-31 05:19:36 +02:00
Joshua Nelson 9ab50113c2 Fix misguided suggestions in config.toml 
- `verbose-tests` is for debugging the test harness, not the tests
themselves. See also https://github.com/rust-lang/rust/pull/76141
- `codegen-units` defaults to `256` whenever `incremental = true`. So
there's no need to explicitly set it to `0` if we already recommend
incremental. See also https://github.com/rust-lang/rustc-dev-guide/pull/795#discussion_r479762977.
 2020-08-31 05:18:50 +02:00
Who? Me?! 45a1535007 Typo 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-08-31 05:12:13 +02:00
mark 4cb43d8160 fix typos 2020-08-31 05:12:13 +02:00
mark b259473dd1 fix line lengths 2020-08-31 05:12:13 +02:00
mark 9bb3872dc7 fix links and names after compiler mv to compiler/ 2020-08-31 05:12:13 +02:00
Tshepang Lekhonkhobe 76efc9b91f nits 2020-08-26 08:07:52 -04:00
Camelid 7e3fe0a961 Apply review suggestion 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-08-26 13:13:14 +02:00
Camelid 92499eadd4 Clarify section on MIR construction 2020-08-26 13:13:14 +02:00
Guillaume Gomez 401abb9bdf
Add new section to have a local HTTP server easily (#833) 2020-08-23 14:36:45 +02:00
Gurwinder Singh 844361cb78
fix type in example (#832) 
Because the below explanation says that function type is `fn(u32) -> u32`
 2020-08-21 18:54:59 +09:00
Yuki Okushi 76d7b6ac70
Remove duplicate MIR chapter entry (#830) 2020-08-19 11:46:02 +00:00
Aleksey Kladov 75aa32f7b4
Document how to use build task for x.py check (#828) 2020-08-17 23:10:29 +09:00
Lzu Tao 6a59d0df34 Link ref to edge concept in graph theory 2020-08-17 09:00:47 -04:00
Who? Me?! 3dcd4e393f
Remove unneeded hashmarks (#826) 
Co-authored-by: Joshua Nelson <jyn514@gmail.com>
 2020-08-17 04:51:37 +09:00
Matthew Jasper f08527cc4b Address revuew comments 2020-08-16 14:14:35 -05:00
Matthew Jasper 6ff87f49ba Document serialization in rustc 2020-08-16 14:14:35 -05:00
Takayuki Nakata 4657fbcda7
Some small fixes (#823) 
* Fix some typos
* Update from `typeck_tables_of` to `typeck`
* Fix comment
 2020-08-11 19:36:48 -04:00
Takayuki Nakata cb51d0e1f0 Use angle brackets to turn URL into a link 2020-08-04 09:50:19 -04:00
Takayuki Nakata f1cf48835d Fix typo 2020-08-04 09:50:19 -04:00
Takayuki Nakata eb0522c4ac Fix a broken link 2020-08-04 09:50:19 -04:00
Takayuki Nakata ec373ae12e Enable a link 2020-08-04 09:50:19 -04:00
Takayuki Nakata 44f1ab3bcf Some small fixes 2020-08-03 11:07:57 -05:00
Takayuki Nakata 04bd4ccd97 Fix typo 2020-08-03 11:07:57 -05:00
Takayuki Nakata 2cc652be17 Fix: crates -> a list of crates 2020-08-03 11:07:57 -05:00
Takayuki Nakata 4db8160fa3 Avoid "whitelist" 
Fixed according to 62cf767a4a
 2020-08-03 11:07:57 -05:00
Yuki Okushi 4e41d060c1 Prefer `::` than `.` 2020-08-02 23:16:01 -05:00
Yuki Okushi e54d59ca74 Fix link/wording for `parse_nt` 2020-08-02 23:16:01 -05:00
Who? Me?! cec6addcaf Typo 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-08-02 19:44:04 -05:00
mark f8dfca5001 some updates after std libs move 2020-08-02 19:44:04 -05:00
Who? Me?! 5756aa3ecf Typo 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-08-02 19:44:04 -05:00
mark 6f98316930 mention the overview chapter 2020-08-02 19:44:04 -05:00
Who? Me?! fc7b7a5723 Link to overview ch instead of internals 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-08-02 19:44:04 -05:00
mark 0dab310a1b missing link 2020-08-02 19:44:04 -05:00
mark abd77148a4 add a bit more discussion of big picture 2020-08-02 19:44:04 -05:00
mark 041e86cb95 fix typo 2020-08-02 19:44:04 -05:00
mark 146635d7ff line length 2020-08-02 19:44:04 -05:00
mark 80c2dfd9d6 rewrite/update compiler source code chapter 2020-08-02 19:44:04 -05:00
Yuki Okushi 61824dde4f Mention `HAIR` to clarify 2020-08-02 08:39:33 -05:00
Yuki Okushi d89c8c9b12 Rename `HAIR` to `THIR` 2020-08-02 08:39:33 -05:00
Yuki Okushi c7a3bca829 Adjust mentions about CI to GitHub Actions 2020-08-02 08:38:26 -05:00
Yuki Okushi f8012dbf42
Rename `src/libstd` to `library/std` etc. (#815) 2020-07-30 22:47:22 +09:00
Jake Goulding 5bde3efd90
Add basic steps for a new target (#805) 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-07-29 04:41:28 +09:00
Joshua Nelson eeca3757b8
Update docs to match the new x.py defaults (#813) 2020-07-29 04:20:00 +09:00
Yuki Okushi e20ac5d64b
Add RISC-V notification group instructions (#814) 
* Clean-up notification groups instructions

* Add RISC-V notification group instructions

* Re-order summary of notification groups

* Add a list of the notification groups

* Apply review suggestion
 2020-07-28 19:06:07 +02:00
Santiago Pastorino 87a11a3045
Fix MIR to LLVM IR sentence (#811) 2020-07-28 05:03:37 +09:00
David Wood fd458b988c
Expand on the documentation for polymorphization. (#803) 
This commit elaborates on the existing documentation for
polymorphization now that polymorphization has almost landed
in rustc.

Signed-off-by: David Wood <david@davidtw.co>
 2020-07-22 19:42:50 +09:00
Yuki Okushi aecb593979
Fix links for cranelift (#809) 2020-07-22 19:32:21 +09:00
Federico Ponzi 63536944b0
Fixes menu for rustdoc page (#804) 2020-07-18 19:18:06 +09:00
Yuki Okushi 26adefdb05
Clean-up minor issues (#802) 2020-07-18 00:00:34 +09:00
Felix S Klock II 467d429597
Update chat info to reflect decision to close down Discord `#compiler`. (#800) 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-07-17 13:01:31 +09:00
Takayuki Nakata e403d51932
Change `rustc::*` to `rustc_middle::*` (#798) 2020-07-16 11:13:49 +09:00
Santiago Pastorino 3078d380cf Resync config.toml and suggest better settings 2020-07-14 15:03:16 -05:00
Yuki Okushi 2c49ec2367 Fix typos 2020-07-14 14:26:41 -05:00
Yuki Okushi 37ab8da24d Fix distortions of "representation" 2020-07-14 14:26:41 -05:00
Joshua Nelson f196779cbe Improve getting-started guide 
- Clean up wording
- Suggest `build --stage 1 src/libstd`, which doesn't recompile rustc
twice unnecessarily
- Fix rustdoc globs which only work on Linux
- Add suggestion for `build --stage 0 src/libstd`
- Suggest `-j1` for very slow builds
- Suggesting letting CI run tests when using a slow machine
 2020-07-14 14:24:40 -05:00
Takayuki Nakata d3e682e590
Fix the difference of title in appendix A (#793) 2020-07-14 10:06:22 +09:00
Ivan Veselov 3394e1696a
Earlier clarification of pFCP abbreviation (#791) 2020-07-12 10:29:17 +09:00
Ivan Veselov 745c831429 Fix typo: review -> reviewer 2020-07-11 09:30:19 -05:00
Santiago Pastorino b04ff74782 inluding -> including 2020-07-10 16:47:54 -05:00
Matt Kraai 954802cc68
Canonicalize part 1 name (#788) 2020-07-05 08:19:10 +09:00
Nadrieril f3339032d6 Suggest selectively disabling optimizations 2020-07-04 18:06:41 -05:00
Eric Huss eb07beaf8e Update bug report links. 2020-07-04 13:09:55 -05:00
Yuki Okushi 87b9ecf2bb Fix link for armhf-gnu Dockerfile 2020-07-04 13:06:27 -05:00
Eric Huss 689eca469d Update docs on using Docker images. 2020-07-04 12:44:57 -05:00
Takayuki Nakata 2c51b6f628
Fix jump marker of debruijn index (#783) 2020-07-04 00:31:52 +09:00
Eric Huss 30518e3df2
Minor updates to stage docs. (#781) 2020-07-04 00:28:44 +09:00
Who? Me?! 7a42bf2c92
add stub inline asm chapter (#773) 2020-07-03 07:37:29 +09:00
Takayuki Nakata bd1801c8b9 Fix the names of table of contents and heading are different 
Not to write the part of Appendix `A` in heading along with other appendix.
 2020-07-02 15:44:52 -05:00
mark b85f30d013 fix links 2020-07-01 22:07:52 -05:00
Who? Me?! 00b67a55de Escape other non-link 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-07-01 22:07:52 -05:00
Who? Me?! c2c219af6c Fix non-link 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2020-07-01 22:07:52 -05:00
mark e82626f802 fix links 2020-07-01 22:07:52 -05:00
mark dbaa12ec12 fix links 2020-07-01 22:07:52 -05:00
mark 431df827e2 line length 2020-07-01 22:07:52 -05:00
mark b1198eff6b move CONTRIBUTING.md to rustc-dev-guide 2020-07-01 22:07:52 -05:00
pierwill 0006f19915
Edit Part 2 introduction (#777) 
* Edit Part 2 introduction

* needs a pause

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
 2020-07-01 13:26:25 +02:00
mark fe7856889a fix file name 2020-06-30 16:04:28 -05:00
Who? Me?! 99745b9931 Move Getting Started to a "prefix chapter" 2020-06-30 16:04:10 -05:00
Who? Me?! fd4c83f4ab Move Errors and Lints to Analysis 2020-06-30 16:03:50 -05:00
Yuki Okushi 19f7d2e77d
Rename resolvers following the latest rustc change (#776) 2020-06-30 16:22:38 +02:00
pierwill 2c6f17671f Edit ty.md 
Makes various edits throughout for formatting, punctuation, and typo fixes.
Also makes some edits and re-wording for clarity.
 2020-06-28 18:39:46 -05:00
Joshua Nelson be8c8bb7bc Fix line lengths 2020-06-28 12:15:23 -05:00
Joshua Nelson 1c68f636cf Improve wording and fix typos 
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-06-28 12:15:23 -05:00
Joshua Nelson c1c66a82f2 Revamp bootstrapping section 
- Move most of the overview to building/bootstrapping.md
- Add things besides stages to bootstrapping.md
 2020-06-28 12:15:23 -05:00
Aaron Hill b7095995aa Add 'recovery' to the gloassary 2020-06-27 11:05:32 -05:00
Who? Me?! e7db51faca Fix formatting 2020-06-24 21:38:54 -05:00
Who? Me?! 093b9032de
Upgrade to mdbook 0.4 and switch to book parts (#764) 
* upgrade to mdbook 0.4 and switch to book parts

* update linkcheck

* fix links, update about-this-guide
 2020-06-24 14:47:50 -03:00
Joshua Nelson 2e104620d1 Move x.py commands to overview 2020-06-23 17:40:16 -05:00
Joshua Nelson 4329b8e91a Split up rustdoc page 2020-06-23 17:40:16 -05:00
Joshua Nelson b8065faa0f Move rustdoc to 'How to build the compiler' 
The old layout was less about rustdoc and more about the compiler:
"Here is an example of a project using rustc_interface".
This gives focus to rustdoc on something you might want to work on for
its own sake. It also makes the page much easier to find for newcomers.
 2020-06-23 17:40:16 -05:00
Drew Youngwerth 917f7efa28 Small spelling fix. 2020-06-23 12:44:15 -05:00
mark ca5591815c address review comments 2020-06-23 12:42:06 -05:00
Florian Gilcher f85ef8ec94 Add prerequisite page 2020-06-23 12:42:06 -05:00
Andy Russell 21ee99e5af add suggestion style guide 
The guide is based on [existing rustdoc].

[existing rustdoc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_errors/struct.Diagnostic.html#method.span_suggestion
 2020-06-23 12:35:07 -05:00
Who? Me?! d103f0d897 Fix links for now. 2020-06-23 00:35:54 -05:00
ThePuzzlemaker 34df55db77 Add information about size for building the Rust Compiler 
The Rust codebase is large, not to mention the submodules. It would be helpful for some to have a warning or note about storage required before they spend possible hours to build, only to get a message in some form that they are running out/already out of storage. I did a stage1 build incrementally and it produced a build directory of about 14 gigabytes.
 2020-06-22 15:48:14 -05:00
Who? Me?! a10ba12047
Fix master branch links (#757) 
* fix links

* some debugging

* more debugging

* fix git checkout in ci

* try again

* already tests with a merge

* Typo

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
 2020-06-21 20:25:43 +02:00
Who? Me?! 45e540ca81
new tykind::error convention (#715) 2020-06-19 07:55:58 +02:00
mark 6c580ad664 fix line length 2020-06-18 12:16:00 -05:00
mark f880b1b21a address a bunch of review comments 2020-06-18 12:16:00 -05:00
Who? Me?! d90acc8e37 LeSeulArtichaut wording/typo fixes 
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-06-18 12:16:00 -05:00
mark c99d5245be address review comments 2020-06-18 12:16:00 -05:00
Who? Me?! 46099c094e Apply suggestions from code review 
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-06-18 12:16:00 -05:00
Who? Me?! 814d27d760 Better wording 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-06-18 12:16:00 -05:00
mark e1c7b6ce92 Slightly reorganize to first present the slow command then the fast commands 2020-06-18 12:16:00 -05:00
mark db004ad24f add a note about disk space 2020-06-18 12:16:00 -05:00
mark e72e2c5613 python 3 also 2020-06-18 12:16:00 -05:00
Who? Me?! aa9b3ecc22 Apply suggestions from code review 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
Co-authored-by: Phil Hansch <dev@phansch.net>
 2020-06-18 12:16:00 -05:00
mark 69baf677ef add forge 2020-06-18 12:16:00 -05:00
Who? Me?! 5ff627e2d5 Apply suggestions from code review 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-06-18 12:16:00 -05:00
mark 5784b6cb92 add note on submodules 2020-06-18 12:16:00 -05:00
mark e2620a8199 add a bit more 2020-06-18 12:16:00 -05:00
mark 2abbee9b5c fix link 2020-06-18 12:16:00 -05:00
mark b5e41a5e0c mention incremental disk space 2020-06-18 12:16:00 -05:00
mark 73d88a1385 a couple more small changes 2020-06-18 12:16:00 -05:00
mark d255b4a0cb some minor updates 2020-06-18 12:16:00 -05:00
mark ba2d73db5f write about processes 2020-06-18 12:16:00 -05:00
mark c5c498ca19 address some review comments 2020-06-18 12:16:00 -05:00
Who? Me?! 324eb69950 Typo fixes 
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
 2020-06-18 12:16:00 -05:00
mark 8fbc9f5241 start a getting started guide 2020-06-18 12:16:00 -05:00
Eric Huss 708acbc72b
Add a link to the forge procedure on adding new options. (#754) 2020-06-18 10:33:15 +02:00
Joshua Nelson 163efc6fcd Don't give `x.py clean` as the first x.py example 
This command shouldn't be used very often, and it has its own whole
section below anyway.
 2020-06-18 04:41:59 +02:00
Joshua Nelson 178e3052b2 Document rustdoc behavior 
- `RUSTDOC_LOG`
- `// aux-build:filename.rs`
- `// build-aux-docs`
 2020-06-17 09:24:41 -05:00
Eric Huss 4228f46777 Add some more detail on compiletest normalization. 2020-06-16 23:14:05 -05:00
Ralf Jung 5371f13236
tag/niche terminology (#747) 2020-06-11 12:38:42 +02:00
LeSeulArtichaut 3b1866b1ea
Clean up the paragraph about aliases for pinging the notification groups (#743) 
* Clean up the paragraph about aliases for pinging the notification groups

* Add windows and arm command invocations

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
 2020-06-10 18:04:19 -04:00
LeSeulArtichaut e647444811
Include "Lint" in the title of the diagnostics chapter (#742) 2020-06-10 15:19:59 -03:00
Niko Matsakis 1a229d6d60 complete the ICE-breaker => notification group rename 2020-06-09 18:03:33 -05:00
Niko Matsakis 089b82651d
add the ARM notification group (#740) 2020-06-09 23:58:22 +02:00
Niko Matsakis e349f81b22
Rebrand ICE-breakers, introduce Windows notification group (#739) 
* rename ice-breakers to the more general notification-group

also less confusing

* add windows notification group

* rebrand LLVM ICE-breakers as a "notification group"

* include the link to example windows PR
 2020-06-09 16:42:00 -03:00
Tomasz Miąsko 42520d3ca8 Document needs-* compiletest directives 2020-06-08 12:33:35 -05:00
Who? Me?! caac584a9e
Add a bit about various type system concepts (#697) 
* add a bit on dataflow analysis

* add a bit on quanitification

* add a bit on debruijn index

* add a bit on early and late bound params

* add missing link

* Typos

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>

* clarify dataflow example

* fix formatting

* fix typos

* Typos

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>

* fix errors in background

* remove dup material and make early/late intro short

* adjust intro

* Niko's intro

Co-authored-by: Niko Matsakis <niko@alum.mit.edu>

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
 2020-06-05 13:11:09 -03:00
Bastian Kauschke 8a9a1f935f
update conventions (#735) 
* update conventions

* typo

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
 2020-06-05 13:06:39 -03:00
Bastian Kauschke 8c8130ed2d braces 2020-06-05 10:34:56 -05:00
Bastian Kauschke 8f2e466f3c words 2020-06-05 10:33:15 -05:00
Who? Me?! 7119767f69
Fix link (#734) 2020-06-05 17:10:01 +02:00
LeSeulArtichaut 2c2fb3f05f
Add more info on useful workflows (#727) 
* Add more info on useful workflows

* Apply suggestions from code review

Co-authored-by: mark-i-m <mark-i-m@users.noreply.github.com>
Co-authored-by: spastorino <spastorino@gmail.com>

Co-authored-by: mark-i-m <mark-i-m@users.noreply.github.com>
Co-authored-by: spastorino <spastorino@gmail.com>
 2020-06-03 22:46:04 +02:00
Yuki Okushi b381598b3f
Update lint declaration example (#713) 2020-05-30 08:49:25 +09:00
Tom Eccles 8a5438b4b1 Document more //ignore-X test headers 2020-05-29 13:27:03 -05:00
Tom Eccles a6bace14e4 Document remote testing 2020-05-29 13:27:03 -05:00
LeSeulArtichaut 55c92daeb6
Document `RUSTFLAGS_STAGE_` bootstrap environment variables (#728) 
* Document `RUSTFLAGS_STAGE_`

* Fix typos

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-30 01:20:24 +09:00
Chris Simpkins c9850bb7d2 Update src/tests/adding.md 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-28 19:57:59 -05:00
Chris Simpkins 8ca0464e65 add documentation of UI test error annotation substring support 2020-05-28 19:57:59 -05:00
Chris Simpkins 6a54bc6dab
Expand error annotations section with examples (#724) 
* expand error annotations section with examples

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-29 02:43:22 +09:00
Eric Huss d7067f19d2 Clarify lint vs fixed diagnostic. 2020-05-27 20:33:46 -05:00
Eric Huss 4d94eb902e Updates from review. 2020-05-27 20:33:46 -05:00
Eric Huss 1e8a467bc2 Apply suggestions from code review 
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-05-27 20:33:46 -05:00
Eric Huss 39edbe59ed Add some guidelines on diagnostics. 2020-05-27 20:33:46 -05:00
LeSeulArtichaut aca2a716ea Apply suggestions from code review 
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-05-27 15:17:33 -05:00
LeSeulArtichaut 54d64bd8ac Fix typo 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-27 15:17:33 -05:00
LeSeulArtichaut 8bb723c673 Add definition of `niche` to the glossary 2020-05-27 15:17:33 -05:00
Eric Huss 6e2b70c9df Move CLI to part 3. 2020-05-27 12:35:13 -05:00
Eric Huss ba1a8dfd35 Apply suggestions from code review 
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-05-27 12:35:13 -05:00
Eric Huss fe96650d1a Add some guidelines on the CLI. 2020-05-27 12:35:13 -05:00
Michael Bryan 6d5e0740f5
It looks like the high-level-overview was renamed (#721) 2020-05-28 00:04:56 +09:00
LeSeulArtichaut 4295e7b578
Add section for debugging rustc type layouts (#720) 2020-05-27 14:17:39 +02:00
Yuki Okushi f53fc666ea Rename `upvars` query to `upvars_mentioned` 2020-05-26 11:05:21 -05:00
Yuki Okushi c2561c4351
Update docs related to const-eval/Miri (#676) 
* Update docs related to const-eval

Co-authored-by: Ralf Jung <post@ralfj.de>
 2020-05-25 17:23:15 +09:00
Adam Perry d10f70b005
Extern blocks are allowed for #[track_caller] now. (#710) 
since https://github.com/rust-lang/rust/pull/70916
 2020-05-23 22:40:23 +02:00
Paul Daniel Faria 59c9fa7b3e
Fix BodyId link typo in glossary (#709) 
* Fix BodyId link typo in glossary

* Fix broken link to rustc_middle's Predicate
 2020-05-23 16:25:53 -04:00
Chris Simpkins 266ab6e3a9
typo fix (#706) 2020-05-19 11:30:27 +09:00
Jade McGough 7fb45e52e9
Add missing closing paren (#705) 2020-05-16 21:19:52 -04:00
Tshepang Lekhonkhobe 8e126df6fe Update src/appendix/glossary.md 
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-05-11 23:52:00 +02:00
Tshepang Lekhonkhobe d7649f4b44 glossary: make soundness definition more readable 2020-05-11 23:52:00 +02:00
Who? Me?! 95420468b9
fix links (#702) 2020-05-11 16:51:33 -03:00
Tshepang Lekhonkhobe 1caba74063
glossary: intro feels like not adding much (#699) 2020-05-11 07:57:46 +02:00
Who? Me?! c386ec3d1a Fix typo 2020-05-08 12:02:56 -05:00
Who? Me?! b6d140f789 Typo 
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-05-08 09:42:27 -05:00
mark d1bb132780 add some section headers 2020-05-08 09:42:27 -05:00
mark 1f6d127a70 move discussion of eager expansion to the end 2020-05-08 09:42:27 -05:00
Who? Me?! 9c7befcdd8 Use full path of span 
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-05-08 09:42:27 -05:00
Who? Me?! 2d639a3696 Typos 
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-05-08 09:42:27 -05:00
mark 7e916519ed fix some links 2020-05-08 09:42:27 -05:00
mark 5dedd70447 fix line length 2020-05-08 09:42:27 -05:00
mark bc9c0e6c35 SPRINKLE ALL THE THINGS 2020-05-08 09:42:27 -05:00
mark a1cf766577 sprinkle around a bunch of links 2020-05-08 09:42:27 -05:00
mark f05ff9c30d expand notes on expansion heirarchies 2020-05-08 09:42:27 -05:00
mark ba8620f34a add a bit more info about eager exp 2020-05-08 09:42:27 -05:00
mark e8f918c0ba expand some notes about expansion :P 2020-05-08 09:42:27 -05:00
mark 0980ebf2c6 reorganize the macro expansion chapter 2020-05-08 09:42:27 -05:00
mark 3f23b32c63 add note about macros in parser chapter 2020-05-08 09:42:27 -05:00
mark d62ed17895 reorder some chapters 2020-05-08 09:42:27 -05:00
mark 6ee323dce3 add a bit to syntax intro 2020-05-08 09:42:27 -05:00
mark 5d0cdc814a add a bit to part 3 intro 2020-05-08 09:42:27 -05:00
mark b8935a916b get rid of old todo 2020-05-08 09:42:27 -05:00
mark 984d5a8b4d finish going through discussion 2020-05-08 09:42:27 -05:00
mark ff2f232772 more notetaking 2020-05-08 09:42:27 -05:00
mark 8bbe1ff044 start working through discussion 2020-05-08 09:42:27 -05:00
mark ee0059a6e2 some cleanup in the macros chapter 2020-05-08 09:42:27 -05:00
George Fraser 0a3ac2d34f Reference complete examples 2020-05-07 17:30:27 -05:00
George Fraser 718047c647 Line length 2020-05-07 17:30:27 -05:00
George Fraser 7f394a5579 Example of getting diagnostics 2020-05-07 17:30:27 -05:00
Hanif Ariffin 6f79c282d8
Added link to the `ty::Adt` (#696) 
* Added link to the `ty::Adt`

* Formatting fixes

Thanks @JohnTitor

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-07 23:44:39 +09:00
Who? Me?! e1736cc9d0 typo 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-06 17:03:52 -05:00
mark 32f3330167 add a bit more on parallel compilation 2020-05-06 17:03:52 -05:00
Bastian Kauschke a8bb0c17f3 Fix example for winnowing 2020-05-02 21:23:21 -05:00
Tshepang Lekhonkhobe 98e94be044 improve info regarding incremental a little 2020-05-01 09:18:42 -05:00
Tshepang Lekhonkhobe 03282ca486 I confirmed this 2020-05-01 09:17:27 -05:00
Who? Me?! 26e0ae52dd tidy 2020-04-30 21:25:29 -05:00
Hanif Ariffin 1b9f80cc40 Update src/queries/incremental-compilation.md 
Removed `at`.

Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-04-30 21:25:29 -05:00
Hanif Ariffin c0ad843003 Hide link behind a clickable text 
It currently does not appear as a clickable link here https://rustc-dev-guide.rust-lang.org/queries/incremental-compilation.html
Additionally, this is a particularly long and nasty link.
 2020-04-30 21:25:29 -05:00
Hanif Ariffin 0b32573dd7 Minute formatting fix 2020-04-30 21:25:17 -05:00
Santiago Pastorino 622be10b7b
It's just ICE-breaker (#685) 2020-04-28 21:19:37 +02:00
Santiago Pastorino 36a06c0f25 Remove extra the 2020-04-27 15:45:00 -05:00
Santiago Pastorino 159cb7e700 Fix sub-diagnostic typo 2020-04-27 15:45:00 -05:00
Who? Me?! f57f25dc45
remove info about diag ice breakers; doesn't exist yet (#682) 2020-04-25 16:23:59 -03:00
Charles Lew bdf565dba6 Address review comments. 
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-04-25 06:57:48 -05:00
Charles Lew 9d9eb150de Fix links. 2020-04-25 06:57:48 -05:00
Charles Lew d79227e453 Address review comments. 2020-04-25 06:57:48 -05:00
Charles Lew cbbe9b423f Fix links and CI error. 2020-04-25 06:57:48 -05:00
Charles Lew d596ab2bee Remove details about chalk and point to Chalk Book instead. 2020-04-25 06:57:48 -05:00
Santiago Pastorino 1398a6fe9d treat-err-as-bug=n means panic on nth error 2020-04-24 13:48:01 -05:00
Bastian Kauschke cbd8d437da
Replace `rustc` with `rustc_middle` (#680) 2020-04-20 15:16:27 +02:00
Who? Me?! a450260a5f Typo 2020-04-19 13:08:39 -05:00
Esteban Küber 0ecf993367 review comments: move text to more relevant section 2020-04-19 13:08:39 -05:00
Esteban Küber 5d0f59959b Add diagnostics ICE-breakers page 2020-04-19 13:08:39 -05:00
Santiago Pastorino 0daa3f7053
Fix typo (#678) 2020-04-19 17:54:45 +02:00
Yuki Okushi 695e58d5ec Apply suggestions from Zoxc 2020-04-18 20:58:14 -05:00
Michael Woerister 2154b85ca4 Apply feedback. 2020-04-18 20:58:14 -05:00
Michael Woerister 4840ad250b Add documentation about incr. comp. query attributes and the projection query pattern. 2020-04-18 20:58:14 -05:00
Who? Me?! bc5445760e
Fix some whitespace (#677) 2020-04-19 01:40:16 +09:00
Yuki Okushi e927db936f Apply suggestions from code review 
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
 2020-04-18 11:11:33 -05:00
mark 96e912e6a6 add link to intrinsic 2020-04-18 11:11:33 -05:00
Who? Me?! 8046502e80 Remove various todos 
With some items added to https://github.com/rust-lang/rustc-dev-guide/issues/674

Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
 2020-04-18 11:11:33 -05:00
mark a578fc11c5 line length 2020-04-18 11:11:33 -05:00
Chris Simpkins 5090bb8d0f [overview.md] add lexer updates, parser updates 
includes feedback from matklad (lexer) and centril (parser)
 2020-04-18 11:11:33 -05:00
Chris Simpkins 4eadacdf29 [overview.md] add initial parser documentation 2020-04-18 11:11:33 -05:00
mark 68a9c1f605 fix links 2020-04-18 11:11:33 -05:00
mark ae4e472959 add intrinsics to glossary 2020-04-18 11:11:33 -05:00
mark dc88fe372e minor wording change on bootstrapping 2020-04-18 11:11:33 -05:00
mark c3f9d0810f update mono entry points 2020-04-18 11:11:33 -05:00
Chris Simpkins 9bf8f9ed16 [overview.md] add documentation of lexer support for Unicode encoding 2020-04-18 11:11:33 -05:00
mark 8eeada5768 correct entry points for codegen 2020-04-18 11:11:33 -05:00
mark 52bc0f6350 some cleanup 2020-04-18 11:11:33 -05:00
mark 2ff2f56041 add entry points for type check and type inference 
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-04-18 11:11:33 -05:00
mark 2f7a6b1a62 add a para on interning and arenas 2020-04-18 11:11:33 -05:00
Chris Simpkins cf14e7aa42 [overview.md] add parser entry point links 2020-04-18 11:11:33 -05:00
mark 5afed5f5ad fix lexer entry point 2020-04-18 11:11:33 -05:00
Who? Me?! 7a58fdc10c Improve wording 
Co-Authored-By: Santiago Pastorino <spastorino@gmail.com>
 2020-04-18 11:11:33 -05:00
mark 0d0611b7d9 add an entry point 2020-04-18 11:11:33 -05:00
mark 55e7d6d1ed remove a todo 2020-04-18 11:11:33 -05:00
mark fe38e8a9de fix links 2020-04-18 11:11:33 -05:00
mark beb654898f line lengths 2020-04-18 11:11:33 -05:00
mark 443e47cb1f add a few todos 2020-04-18 11:11:33 -05:00
mark 31ae8b8b07 write a bit about bootstrapping 2020-04-18 11:11:33 -05:00
mark e154e2684d add a note on tcx name 2020-04-18 11:11:33 -05:00
mark 6cdb777909 break long sentence 2020-04-18 11:11:33 -05:00
mark cc3fb247dd Improve description of MIR 
Co-Authored-By: Centril <twingoow@gmail.com>
 2020-04-18 11:11:33 -05:00
mark 2d81262bc0 correct the note about HAIR 2020-04-18 11:11:33 -05:00
mark cc6b013460 mention token stream as an IR 2020-04-18 11:11:33 -05:00
mark 4c50a79b08 mention the hair 2020-04-18 11:11:33 -05:00
mark cb68eca0c1 Add some entry points 
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-04-18 11:11:33 -05:00
mark 9fd274d967 fix old rustc-dev-guide links 2020-04-18 11:11:33 -05:00
Chris Simpkins 10d6839434 Update src/overview.md 
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-04-18 11:11:33 -05:00
Chris Simpkins df51d81272 Update src/overview.md 
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
 2020-04-18 11:11:33 -05:00
Chris Simpkins 0783019c12 [overview.md] Add command line argument parsing, lexer stages, and parser outline 2020-04-18 11:11:33 -05:00
mark a43ef4d3b3 Apply Centril suggestions 
Co-Authored-By: Centril <twingoow@gmail.com>
 2020-04-18 11:11:33 -05:00
mark 62e6bd0131 correct a few links 2020-04-18 11:11:33 -05:00
mark fe12e05523 add overview 2020-04-18 11:11:33 -05:00
Jan-Erik Rediger d7b4c7e899
Start with the basics (#675) 
* The very first step should be to clone the repository

* Make the command copy-able

By having the plain command users can select and copy the text and paste
it, without needing to fiddle around to remove extra characters.

Now that the previous command switched directories it is not necessary
to be called out here again either.

* Update src/building/how-to-build-and-run.md

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-04-17 21:16:56 +09:00
Ralf Jung f9b673309f
codegen tests: add link to LLVM FileCheck docs (#673) 2020-04-12 02:34:25 +09:00
Arlo Siemsen b315ce5219 Add section describing source file checksums in debug info 2020-04-08 15:50:31 -05:00
Who? Me?! 7adfab42ba
fix a link (#672) 2020-04-08 08:52:05 +02:00
Chris Simpkins 826eddfbcc mark-i-m review edits 2020-04-07 12:11:56 -05:00
Chris Simpkins 2e90d88241 consistent section title casing 2020-04-07 12:11:56 -05:00
Chris Simpkins daa1d91013 update about-this-guide.md with new Guide sections 2020-04-07 12:11:56 -05:00
Who? Me?! 269b5f08e7
Reorganize the guide (#651) 
* start on guide reorg

* backend intro

* part 2, 3, 4 intros

* some missing files

* Fix typos

Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>

* add links from intro

* rename compiler source chapter and add placeholder for overview

* rename parts, mv rustc_driver to part 3, make syntax chapter

* update part intros

* add syntax ch intro

* address review comments

* Better overview chapter placeholder

Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>

* fix link

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
 2020-04-06 13:23:34 -03:00
Paul Daniel Faria c33f0c6158 Remove duplicate trait reference entry from glossary, fix alphabetical sorting 2020-04-06 10:41:28 -05:00
LeSeulArtichaut af75c1001a Rework commit message 2020-04-05 12:49:29 -05:00
LeSeulArtichaut 255bf3cf35 Note that the invocation now are aliases 2020-04-05 12:49:29 -05:00
LeSeulArtichaut fabea21d80 Change ICE-breaker ping to use the aliases 
Related to rust-lang/rust#69949
 2020-04-05 12:49:29 -05:00
Paul Daniel Faria 0833cdbcd8 Wrap link in borrow_check.md to satify line length checks 2020-04-05 12:46:22 -05:00
Paul Daniel Faria 6e91f8d0e9 Add ids to all glossary items, make existing glossary links point to glossary, add links for def id in query.md 2020-04-05 12:46:22 -05:00
Tshepang Lekhonkhobe 14a08a3663 remove stupid-stats, and some references to removed API 2020-04-04 13:36:17 -05:00
Tshepang Lekhonkhobe e89d981d41
add pre-requisite for calling into compiler API (#663) 2020-04-04 09:37:39 +02:00
Paul Daniel Faria e1301ac847
Add BodyId to glossary, and links for ids to HIR identifiers section (#660) 2020-04-03 19:22:08 +02:00
Santiago Pastorino 27269235d3
Update some projects locations (#658) 2020-04-02 18:40:15 +02:00
Who? Me?! 8a1879a279 Shorten line 2020-04-01 20:09:08 -05:00
George Fraser d3cca657f3 Update src/SUMMARY.md 
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-04-01 20:09:08 -05:00
George Fraser c27285e707 Update src/rustc-driver-interacting-with-the-ast.md 
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-04-01 20:09:08 -05:00
George Fraser aee609b57e How to get the type of an expression using rustc_interface 2020-04-01 20:09:08 -05:00
Santiago Pastorino f212f322fb
Remove left overs from HackMD migration (#655) 2020-04-01 16:25:14 +02:00
Tshepang Lekhonkhobe 610d8e89d6
Resolver trait moved (#652) 2020-04-01 11:04:45 +02:00
Tshepang Lekhonkhobe 498f7bd279
add link for Resolver::resolve_crate (#653) 2020-04-01 10:57:35 +02:00
Tshepang Lekhonkhobe af7286d2c8
add some type inference links, and fix/improve some stuff (#654) 2020-04-01 10:52:31 +02:00
Tshepang Lekhonkhobe e2c733c481 it is rustc_parse, not rustc_parser 2020-03-31 22:17:35 -05:00
Tshepang Lekhonkhobe d3f1ef2a87 follow 4-space indent idiom 2020-03-31 22:17:15 -05:00
Tshepang Lekhonkhobe ce08bcc1e6 point to new Cranelift home 2020-03-31 21:35:36 -05:00
Adam Perry f38f17c9d7 fix broken links 2020-03-31 21:34:55 -05:00
Adam Perry 20fe7df2aa Implicit Caller Location section. 2020-03-31 21:34:55 -05:00
mark 595f2f386c and a few more links 2020-03-31 15:43:14 -05:00
mark 518da21a47 fix a few more links 2020-03-31 15:43:14 -05:00
Tshepang Lekhonkhobe 6b25ed2753 QueryDescription has moved 2020-03-31 15:43:14 -05:00
LeSeulArtichaut 83cd94ed2b Rename `librustc` to `librustc_middle` 2020-03-31 15:43:14 -05:00
ecstatic-morse 10ad00edc2 Update reference to `has_any_child_of` in docs 
This function was obsoleted by `find_in_move_path_or_its_descendants`.
 2020-03-31 15:43:14 -05:00
Tshepang Lekhonkhobe 3cc54f2194
glossary: misc improvements (#638) 2020-03-28 21:29:57 +02:00
Alex Aktsipetrov 3d3c26143f
Fix typo (#635) 
* Typo

* Update src/queries/query-evaluation-model-in-detail.md

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-03-27 19:42:53 +09:00
Michael Woerister 6b441177f3 Update description of incremental compilation. 2020-03-26 15:50:51 -05:00
Alex Aktsipetrov ed2ad0eccb Update high-level-overview.md 
Remove an obsolete clarification about libsyntax and co.
 2020-03-25 14:46:29 -05:00
Chris Simpkins ff0e4f098d minor grammar edit 2020-03-22 19:27:23 -05:00
Chris Simpkins cc7b8e9099 change title 
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-03-22 19:27:23 -05:00
Chris Simpkins 5a9d784d9e Update src/licenses.md 
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-03-22 19:27:23 -05:00
Chris Simpkins d1cd418908 add rust-lang/rust license documentation 2020-03-22 19:27:23 -05:00
Chris Simpkins 0e1ad678ed [stupid-stats] replace removed rustc_codegen_utils with rustc_codegen_ssa 2020-03-22 17:58:00 -05:00
George Fraser 09ed54f557 run_compiler is exported by rustc_interface 2020-03-22 14:33:47 -05:00
George Fraser 506d2d36a4 Fix reference 
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-03-21 19:48:32 -05:00
George Fraser 75f77eadfe Reference example from #621 2020-03-21 19:48:32 -05:00
Who? Me?! 1ed6139b14
Move GenericArgs chapter under ty (#624) 2020-03-21 01:32:33 +09:00
Bastian Kauschke 8c26c367b3
words (#622) 2020-03-20 03:57:12 +09:00
bjorn3 77600c0204
Fix typo (#618) 2020-03-17 21:14:48 +02:00
Santiago Pastorino 0d631447bc Update src/walkthrough.md 
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-03-17 12:16:02 -05:00
Santiago Pastorino 39ebd5dea7 Update src/bug-fix-procedure.md 
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-03-17 12:16:02 -05:00
Santiago Pastorino 769826dffc use-jemalloc -> jemalloc 2020-03-17 12:16:02 -05:00
Santiago Pastorino 9263df7668 Fix line lengths 2020-03-17 12:16:02 -05:00
Santiago Pastorino 8a934937df Remove typo 2020-03-17 12:16:02 -05:00
Santiago Pastorino 6d6e8fa329 This page is diagnostics.html now 2020-03-17 12:16:02 -05:00
Santiago Pastorino 8a848cecab It may Take a lot of time instead of 2 hours 2020-03-17 12:16:02 -05:00
Santiago Pastorino 89d3be4709 All the text is at the time of this writing 2020-03-17 12:16:02 -05:00
Santiago Pastorino 320624ae55 Suites are defined in enum Mode 2020-03-17 12:16:02 -05:00
Santiago Pastorino 4215ea9f25 This is no longer true since rust#49219 2020-03-17 12:16:02 -05:00
Santiago Pastorino 7afd3c3eb1 Avoid as of this writing given that everything is as of this writing :) 2020-03-17 12:16:02 -05:00
Santiago Pastorino 831a8709c9 Rephrase where compiletest is located 2020-03-17 12:16:02 -05:00
Who? Me?! 13f86ff472
Add some more info to param_env (#610) 
* add some more info to param_env

* Remove some trailing spaces

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-03-17 20:11:37 +09:00
Solomon Ucko acd39231b6 Changed rustc-ty link to go to first message 2020-03-16 21:25:37 -05:00
Solomon Ucko 84791e1c44 Change Rust Koans link to point to first koan 2020-03-16 21:00:47 -05:00
Who? Me?! c2978595fc
Fix broken link (#612) 2020-03-17 08:20:38 +09:00
DillionMango 14a92d3762
quote some commands by to make the style more consistent (#611) 2020-03-16 17:43:48 +09:00
Youngsuk Kim 601fee4da8 Clarify sentence meaning 2020-03-15 21:27:40 -05:00
Yuki Okushi 1f80effa08 Fix broken link 2020-03-15 12:47:04 -05:00
Who? Me?! cf572f5e35 Fix sentence grammar 2020-03-12 14:11:01 -05:00
Who? Me?! 12900c8c46 Use common (American) spellings 
Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-03-12 14:11:01 -05:00
Who? Me?! 75f60ec24e Update src/backend/codegen.md 
Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-03-12 14:11:01 -05:00
Mark Mansi 83f0ba422a update backend chapters from nagisa's notes 2020-03-12 14:11:01 -05:00
Mark Mansi 1f4d07155e monomorphization chapter 2020-03-12 14:11:01 -05:00
Mark Mansi 469c5af255 add some placeholder text, short intro 2020-03-12 14:11:01 -05:00
Mark Mansi f4f5d4c151 skeleton for backend chapters 2020-03-12 14:11:01 -05:00
Santiago Pastorino 66be765404
Rename rustc-guide to rustc-dev-guide (#601) 
* Rename rustc-guide to rustc-dev-guide

* rust-lang.github.io/rustc-dev-guide -> rustc-dev-guide.rust-lang.org
 2020-03-10 11:01:43 -03:00
Chris Simpkins 56cff94ce7
Update ./x.py tidy testing documentation (#607) 
* update all docs to use ./x.py test tidy syntax
 2020-03-10 12:02:24 +09:00
Who? Me?! 0e8bd00d90
Just lol (#603) 
* Just lol

* Update src/appendix/humorust.md

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-03-08 11:05:26 +09:00
Yuki Okushi b96bf135a6
Remove references to chalkify tests (#604) 2020-03-08 00:24:56 +09:00
Who? Me?! cf476b2adc
typo (#599) 2020-03-04 01:41:36 +09:00
LeSeulArtichaut 3751350235
Get rid of references to the refractored `libsyntax` crate (#598) 
* Get rid of references to the refractored `libsyntax` crate

* Apply suggestions from code review

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-03-03 04:41:41 +09:00
LeSeulArtichaut d752bd35fa Make all links in Appendix E active 2020-03-01 20:54:40 -06:00
Yuki Okushi 692f81f35d Move bless section to running chapter 2020-02-27 11:10:14 -06:00
SarthakSingh31 fa6c80ddb6
Fixed wrong variable name (#593) 2020-02-27 09:08:34 +09:00
Philipp Hansch 9b3803d35d Don't reference librustc_resolve just yet. 
It's mentioned further down with more details.
 2020-02-25 22:39:16 -06:00
Philipp Hansch c28c5e8ef8 typo: eg. -> e.g. 2020-02-25 22:39:16 -06:00
Philipp Hansch 29b0d1ca81 Name resolution: Add intro section 2020-02-25 22:39:16 -06:00
Mark Mansi 69a3667335 add back link 2020-02-20 16:01:35 -06:00
Mark Mansi 31304c075f update glossary 2020-02-20 16:01:35 -06:00
Mark Mansi f007762b9c create a separate chapter on arenas/interning 2020-02-20 16:01:35 -06:00
Mark Mansi 4b34444364 mention tidy bless 2020-02-20 10:28:24 -06:00
Mark Mansi 1938249be0 tidy runs rustfmt check 2020-02-20 10:28:24 -06:00
Mark Mansi 04832fa1be document ./x.py fmt 2020-02-20 10:28:24 -06:00
Who? Me?! 3dd93bf6b9
spit of type folder and generics subchapters (#586) 2020-02-19 10:31:20 -03:00
Mark Mansi d2e17ebf9c fix link 2020-02-18 16:05:50 -06:00
Yuki Okushi 84d2a48f81 Update section following current state 2020-02-18 11:29:39 -06:00
LORIS INTERGALACTIQUE 39dd586828
Add links to the rustc docs (#578) 2020-02-15 09:35:11 +09:00
Yuki Okushi f53a659623 Fix link 2020-02-14 16:21:53 -06:00
Youngsuk Kim d6a6122b95
Add link to `rustc::mir::Location` (#579) 2020-02-14 23:56:21 +09:00
Youngsuk Kim df680be24b
Correction of type name (#576) 
`ConstraintSet` => `OutlivesConstraintSet`
 2020-02-12 17:15:44 -03:00
Loris-intergalactique cb4c20039d Minor typo correction 2020-02-12 10:55:46 -06:00
Youngsuk Kim 6480932518 minor typo fix 2020-02-10 23:07:17 -06:00
Youngsuk Kim 2d834a7578 minor typo fix 2020-02-10 16:26:29 -06:00
Tomasz Miąsko 693a92f2d2
Update sanitizers documentation (#562) 2020-02-10 10:53:59 -05:00
Felix S Klock II d1ea643074 Added example of icebreakers-cleanup-crew 
(I figure its low cost to just list all the possible pings, compared to the cost of people getting the command wrong or not even knowing the full set of teams possible.)
 2020-02-06 17:10:27 -06:00
Eduard-Mihai Burtescu e69b987357
mir: begin documenting user variable debuginfo. (#571) 2020-02-05 23:55:42 +01:00
Wesley Wiser 5bd60bc51e Add a mention of the new `-Zllvm-time-trace` flag 2020-02-02 23:54:00 -06:00
Who? Me?! f0a23c81ef
Fix broken links (#570) 2020-02-03 14:26:13 +09:00
Santiago Pastorino 7f19120125 Add an example PR to join the Cleanup Crew ICE-Breakers 2020-01-30 15:36:22 -06:00
LeSeulArtichaut 0e32b4eeef Replaced simple comment with doc comment 2020-01-29 12:19:31 -06:00
Niko Matsakis a8b58d4c0d
add cleanup crew (#556) 
* add cleanup crew

* update the text about carog-bisect-rustc etc

* Update src/ice-breaker/cleanup-crew.md

Co-Authored-By: lqd <remy.rakic+github@gmail.com>

* finish the 3rd section

* fix typo

* clarify when you need to find PR range

* add link to zulip stream

Co-authored-by: lqd <remy.rakic+github@gmail.com>
 2020-01-23 14:18:51 -05:00
Yuki Okushi 92baf7293d Fix link 2020-01-13 22:58:05 -06:00
Yuki Okushi 41efacea44 Fix links 2020-01-13 13:14:26 -06:00
Yuki Okushi 97cab0192d Fix links and paths 2020-01-12 14:31:55 -06:00
Yuki Okushi ba48252682 Fix line length 2020-01-10 13:12:39 -05:00
Yuki Okushi 2ef6c927d1 Fix links and paths 2020-01-10 13:12:39 -05:00
Yuki Okushi 702f224bf6 Fix links 2020-01-05 18:38:38 -05:00
Santiago Pastorino 2de64f7caf Summarize the lecture of ty into a chapter (#530) 
* Summarize the lecture of ty into a chapter

* Add note that def-id is explained later

* Add mark-i-am fixes

* Address some of Niko's comments

* address last review comments

* fix link

Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-01-03 09:12:37 -05:00
Aaron Hill 629c135e0b Add missing hash marks 
Fixes #550

I can no longer reproduce the issue
 2020-01-02 22:00:26 -06:00
Aaron Hill 97dfbc964e Apply fixes 
Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-01-02 21:54:14 -06:00
Aaron Hill 01c0b04ee3 Fix line lengths 2020-01-02 21:54:14 -06:00
Aaron Hill 7c078d35b4 Update for method renames in libstd 2020-01-02 21:54:14 -06:00
Aaron Hill 6897e6b8cf Fix name of lang item 2020-01-02 21:54:14 -06:00
Aaron Hill 25c226cfa8 Fix typo 2020-01-02 21:54:14 -06:00
Aaron Hill 90af55903a Apply some fixes 
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
 2020-01-02 21:54:14 -06:00
Aaron Hill a675ddedef Add panic implementation docs 2020-01-02 21:54:14 -06:00
Yuki Okushi b5c6babcdd Fix links (#549) 2019-12-31 19:45:01 +01:00
Who? Me?! a59a612451 More info about using local LLVM (#547) 
* more info about llvm-config

* typo

Co-Authored-By: Santiago Pastorino <spastorino@gmail.com>

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
 2019-12-31 09:46:49 -03:00
Who? Me?! e668a1ff29 add a bit about def path (#548) 2019-12-31 09:46:18 -03:00
YOUNGSUK KIM 423808fb45 minor grammar fixes 2019-12-28 17:02:38 -06:00
Yuki Okushi e997e06db1 Fix link 2019-12-28 16:59:45 -06:00
Yuki Okushi ad604436f3 Update link 2019-12-26 13:53:05 -06:00
Oliver Scherer c461c8597e Introduce `rustc_const_stable` and explain `rustc_const_unstable` (#542) 2019-12-24 01:16:23 +01:00
Ross MacArthur 846743c713 Minor update to stability.md 2019-12-22 17:17:47 -06:00
Ross MacArthur 8a232d0d2f Update stability documentation, mention `issue = "none"` 2019-12-22 17:17:47 -06:00
Ross MacArthur 6c09a68d97 Rewrap stability.md to column 79 2019-12-22 17:17:47 -06:00
Who? Me?! 3e7993aefe Document rustc internal env vars a little bit (#513) 2019-12-21 08:00:09 -05:00
Tshepang Lekhonkhobe a6cf2843b9 chalk: place brackets in usual positions 2019-12-19 23:03:31 -06:00
Tshepang Lekhonkhobe bd77dc061a salsa: reduce overlong sentence 2019-12-19 23:03:08 -06:00
Christoph Schmidler 6dd78f5b15 Correct statement that wrongly claims the json emitter still lives in libsyntax crate 2019-12-17 08:35:30 -06:00
Mark Mansi e695b62250 update NLL after refactorings 2019-12-14 06:41:11 -06:00
Mark Mansi e30bc0fcef fix link 2019-12-09 10:52:52 -06:00
Mark Mansi cd85fbd68b move the last few things from the forge 2019-12-09 10:52:52 -06:00
Yuki Okushi 7c56708aab Fix links 2019-12-06 09:42:24 -06:00
Laurențiu Nicola d0b93fd015 Remove reference to run-pass tests 2019-12-03 19:37:21 -06:00
Tshepang Lekhonkhobe 746f7e1799 fix links 2019-12-03 19:34:15 -06:00
Who? Me?! 9e8af60434 Add Karrq's salsa chapter (#529) 
* add Karrq's salsa chapter

* add youtu.be short url
 2019-11-27 14:06:07 -03:00
Who? Me?! 3984184a44 Update src/walkthrough.md 
Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
 2019-11-26 21:01:59 -06:00
Mark Mansi 4edb95271d Define FCP where first used 2019-11-26 21:01:59 -06:00
Who? Me?! efe3ab7ad1 Revert "website has disappeared" 
This reverts commit 0930e773f1.
 2019-11-26 21:00:47 -06:00
Hanif Bin Ariffin d373bca885 Couple of changes to code so that its safe 
Specifically, `> $1` causes it to write into the file $1 if it exist
And `> ./x.py` is particularly bad because it overwrite the script with
empty spaces...
 2019-11-26 17:18:04 -06:00
Ivan Tham 55e5a8a2fa Fix typo 2019-11-26 17:14:05 -06:00
Mark Mansi 0930e773f1 website has disappeared 2019-11-26 17:05:11 -06:00
Tyler Mandry a839812326 -Cllvm-arg is actually -Cllvm-args 2019-11-26 17:03:43 -06:00
Santiago Pastorino b3aa636dc2 Minor mir chapter fixes 2019-11-20 08:00:49 -06:00
homersimpsons 3981656d44 ty.md: fix a typo 2019-11-19 17:57:31 -06:00
Mark Mansi fe8585a9b6 some cleanup 2019-11-14 14:14:39 -06:00
Who? Me?! c1eea21696 typo 
Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
 2019-11-14 13:08:20 -06:00
Who? Me?! be4bd173ef typo 
Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
 2019-11-14 13:08:20 -06:00
Mark Mansi 692ac4df9f add oli note 2019-11-14 13:08:20 -06:00
Mark Mansi f4e7bbe473 add something for mir opt 2019-11-14 13:08:20 -06:00
Who? Me?! 9106ae1c3a add compilers biblio (#512) 2019-11-13 16:51:01 +01:00
ksqsf 6d07d62ad3 backtraces work on Mac 2019-11-12 14:44:41 -06:00
Mark Mansi 934380b7cf update parser chapter 2019-11-12 10:28:31 -06:00
Mark Mansi 75a5f9236c Fix chalk links 2019-11-08 11:24:48 -06:00
Tshepang Lekhonkhobe 3e1213e728 trim down "Document rustc" 2019-11-08 10:19:32 -06:00
Tshepang Lekhonkhobe 399d543e38 whitespace 2019-11-08 10:19:32 -06:00