Commit Graph

1400 Commits

Author SHA1 Message Date
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
Youngsuk_Kim 49611100bf add link to 'BorrowKind' in closure.md 2020-09-25 22:55:49 -04:00
Youngsuk_Kim 06fdc4321e update description of 'ByRef' borrows of closures 2020-09-25 22:55:49 -04:00
Youngsuk_Kim a0958b664c minor punctuation/grammar error fix 2020-09-25 22:55:49 -04:00
Jakob Degen b7970e6c5e Remove reference to copyright notices.
Immediately below the section on copyright notices being removed,
it is mentioned that a particular thing should be placed below the
notices. This seems confusing.
2020-09-24 11:45:35 -04:00
Dániel Buga 727a536ba9 Link to the -Zmir-opt-level proposal
I was confused about what the different levels mean. This PR adds a paragraph that shortly explains the rationale behind different mir-opt-levels and links to the current proposal where there's some information about them.

Let me know if I wrote something unreasonable or incorrect.

Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-23 18:42:23 -04:00
Joshua Nelson 7609eb11ee Don't recommend building the compiler for running tests on the standard library (#887)
Thought of this while reading https://internals.rust-lang.org/t/contributing-changes-to-std/12829/.
2020-09-23 15:46:43 +00:00
Camelid ca00e2eefe `ConstEvalResult` is now `EvalToConstValueResult` (#885)
Also fixed typo.
2020-09-22 22:52:05 +02:00
Joshua Nelson 9c5e356ed5 Improve instructions for adding a new test (#881)
* Improve instructions for adding a new test

- Add a section for library tests
- Expand section on rustdoc tests

* Address review comments

- Say what should be considered a library test
- Mention adding error numbers to doc tests
- Link to #ui section
- Line wrapping

* Fix incorrect link

It shouldn't have been a link in the first place.

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-09-19 23:40:17 +00:00
Camelid 27ff56d829 Fix typo in table of contents 2020-09-17 11:35:14 -04:00
Camelid 0a80107e34 Revert "Mention that places are sometimes called "lvalues""
This reverts commit bf5e1c451d.
2020-09-17 11:35:14 -04:00
Camelid e645304ce9 Mention that places are sometimes called "lvalues" 2020-09-17 11:35:14 -04:00
Camelid fd525a93d6 More improvements 2020-09-17 11:35:14 -04:00
Camelid 231e3d9c83 Improve MIR sections in appendix
Add a new graphical representation of one of the examples of MIR and
basic blocks!

And make other minor improvements.
2020-09-17 11:35:14 -04:00
Macdonald Umoren 7bda848e3c debug-logging=true instead of debug-assertions=yes 2020-09-16 21:56:05 -04:00
Dylan MacKenzie 42be58a751 Add link for `AnalysisDomain::NAME` 2020-09-16 00:21:55 -04:00
Dylan MacKenzie ca60ec06df Describe how to generate graphviz diagrams for dataflow 2020-09-16 00:21:55 -04:00
Santiago Pastorino 9f4e7038fa Remove EN1 2020-09-15 18:13:33 -04:00
Santiago Pastorino a7d0f3f2dd Complete text about salsa base inputs 2020-09-15 18:13:33 -04:00
Santiago Pastorino 6cf849f63b Add Salsa In More Depth lecture 2020-09-15 18:13:33 -04:00
LeSeulArtichaut 0d2b8eb1c4 Fix typo
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-09-14 17:42:19 -05:00
LeSeulArtichaut e6a94b2355 Make the HIR chapter point to the new chapter on IDs 2020-09-14 17:42:19 -05:00
LeSeulArtichaut c7ec4769ab Apply suggestions from code review
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-14 17:42:19 -05:00
LeSeulArtichaut fe19fc65f2 Add a chapter on all the identifiers used through `rustc` 2020-09-14 17:42:19 -05:00
Dylan MacKenzie 1fffd48313 Update `Visitor` and `Cursor` examples 2020-09-13 15:58:02 -04:00
Dylan MacKenzie ddc23efa5f Line edits 2020-09-13 15:58:02 -04:00
Dylan MacKenzie 0cc3a9f8f3 Add missing link to `Engine` 2020-09-13 15:58:02 -04:00
Dylan MacKenzie 3db7809e77 Initial draft of MIR dataflow framework docs 2020-09-13 15:58:02 -04:00
Monadic Cat 3b5a774a61 correct attribute used here 2020-09-12 18:41:06 -04:00
Joshua Nelson 7e42258f16 Address nits 2020-09-12 13:12:14 -05:00
Joshua Nelson 01c34848a3 Note that the default is 2015 2020-09-12 13:12:14 -05:00
Joshua Nelson 71853f5a5c Document edition flag for UI tests 2020-09-12 13:12:14 -05:00
LeSeulArtichaut eb39e07c58 Fix typo 2020-09-12 12:07:04 -04:00
LeSeulArtichaut 5ff253c02a Hide `@rustdoc` implementation details 2020-09-12 12:07:04 -04:00
LeSeulArtichaut ab47942c65 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 ade9b19f51 Update src/rustbot.md 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 9f396a3f1e Update src/rustbot.md 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 317a5b33a4 Update src/contributing.md
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 28ca77209b Update src/contributing.md 2020-09-12 12:07:04 -04:00
LeSeulArtichaut a9264c50d6 Add a chapter on useful `@rustbot` commands 2020-09-12 12:07:04 -04:00
Gus Wynn 2ac4ba41ef 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 4a8945792e Fix typo
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-11 13:42:39 +02:00
LeSeulArtichaut 57794fe4dc Apply suggestions from code review
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-11 13:42:39 +02:00
LeSeulArtichaut d26f268757 Clean up 'Contributing to Rust - Pull Requests' 2020-09-11 13:42:39 +02:00
Joshua Nelson 81f52ce0db Fix other library commands 2020-09-10 23:56:41 -04:00
Joshua Nelson 86e02cda81 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 f0d769ea49 Add back information about Googling
Also cleaned up some other things.
2020-09-09 22:58:18 -04:00
Camelid 53a9cde26c Add back comma
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 22:58:18 -04:00
Camelid 38d726f367 Add more info about Rustdoc 2020-09-09 22:58:18 -04:00
Camelid dd3b2059b6 Update "Helpful Links" section 2020-09-09 22:58:18 -04:00
Joshua Nelson 185f43c746 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 350ee4b260 Minor cleanup for "How to build and run" 2020-09-09 20:58:30 -04:00
Rich Kadel ca3b0a5571 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 f3b5db1057 Fix nit 2020-09-09 21:39:55 +02:00
Tshepang Lekhonkhobe dc0cff54bb Update src/building/new-target.md 2020-09-09 21:39:55 +02:00
Joshua Nelson 059ad38ddf Document how to promote a target from cross-compiled to hosted 2020-09-09 21:39:55 +02:00
Santiago Pastorino 3d0543b644 Update src/queries/profiling.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 12:30:56 -04:00
Santiago Pastorino 2d1322d62e Update def_id.rs location 2020-09-09 12:30:56 -04:00
Santiago Pastorino 8638351e9d Fix typo, hellow -> hello 2020-09-09 12:30:56 -04:00
Santiago Pastorino 6d3eb2bc75 Add ./ to run x.py 2020-09-09 12:30:56 -04:00
Joshua Nelson 6dd6d868e5 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 808774289f 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 8623da3dab Add information about default stages for x.py 2020-09-09 11:05:26 -04:00
Joshua Nelson 794b32feac Fix typo 2020-09-09 16:58:05 +02:00
Joshua Nelson 45f6000c37 Document speculative crate loading (#859) 2020-09-09 10:19:01 +03:00
Joshua Nelson 60f15f096e 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 1b40f033d2 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 cc121cd4c5 Document CGU partioning in case of generic and inline functions 2020-09-07 10:07:40 -04:00
Tshepang Lekhonkhobe 68407cbe37 Update src/building/how-to-build-and-run.md 2020-09-07 08:55:08 -04:00
Joshua Nelson 5fac3dca3d 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 33efb2a2ab Rename src/rustc to compiler/rustc 2020-09-06 16:21:08 +02:00
Gus Wynn 4ce4873606 update docs to refer to the move 2020-09-03 19:25:02 -04:00
Santiago Pastorino 1519df6945 Fix dep-graph-caller-callee test location 2020-09-03 16:21:30 +02:00
Rich Kadel 7b4ab23cc7 Adds documentation to cover spanview output
Documents the feature introduced in #76074.
2020-09-02 12:39:47 +02:00
Joshua Nelson 4411cf2001 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 f6b1f9d49d 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?! b3e17b1b1f Typo
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-31 05:12:13 +02:00
mark 54ffd393c9 fix typos 2020-08-31 05:12:13 +02:00
mark b361ef92ac fix line lengths 2020-08-31 05:12:13 +02:00
mark 89f0b60ccc fix links and names after compiler mv to compiler/ 2020-08-31 05:12:13 +02:00
Tshepang Lekhonkhobe cd2f461d9c nits 2020-08-26 08:07:52 -04:00
Camelid 51da18c90d Apply review suggestion
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-26 13:13:14 +02:00
Camelid 014d434f46 Clarify section on MIR construction 2020-08-26 13:13:14 +02:00
Guillaume Gomez a49fce9a12 Add new section to have a local HTTP server easily (#833) 2020-08-23 14:36:45 +02:00
Gurwinder Singh 9b803e1dfe 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 908d4ff483 Remove duplicate MIR chapter entry (#830) 2020-08-19 11:46:02 +00:00
Aleksey Kladov 776e14a3f0 Document how to use build task for x.py check (#828) 2020-08-17 23:10:29 +09:00
Lzu Tao 8effbe65b6 Link ref to edge concept in graph theory 2020-08-17 09:00:47 -04:00
Who? Me?! 369ec46a1b Remove unneeded hashmarks (#826)
Co-authored-by: Joshua Nelson <jyn514@gmail.com>
2020-08-17 04:51:37 +09:00
Matthew Jasper 0ecf777a50 Address revuew comments 2020-08-16 14:14:35 -05:00
Matthew Jasper 281526c5a2 Document serialization in rustc 2020-08-16 14:14:35 -05:00
Takayuki Nakata 463489182d 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 5462868f4b Use angle brackets to turn URL into a link 2020-08-04 09:50:19 -04:00
Takayuki Nakata 68daabb4bf Fix typo 2020-08-04 09:50:19 -04:00
Takayuki Nakata 1fd664124d Fix a broken link 2020-08-04 09:50:19 -04:00
Takayuki Nakata f24f0b15e0 Enable a link 2020-08-04 09:50:19 -04:00
Takayuki Nakata 574f709928 Some small fixes 2020-08-03 11:07:57 -05:00
Takayuki Nakata cb87579a2f Fix typo 2020-08-03 11:07:57 -05:00
Takayuki Nakata e7b3cd7f6a Fix: crates -> a list of crates 2020-08-03 11:07:57 -05:00
Takayuki Nakata ff9814cc3c Avoid "whitelist"
Fixed according to 62cf767a4a
2020-08-03 11:07:57 -05:00
Yuki Okushi 9522f3e934 Prefer `::` than `.` 2020-08-02 23:16:01 -05:00
Yuki Okushi 65770bcd1f Fix link/wording for `parse_nt` 2020-08-02 23:16:01 -05:00
Who? Me?! 14c2f80da2 Typo
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
mark a8eab86aa0 some updates after std libs move 2020-08-02 19:44:04 -05:00
Who? Me?! c693f66a8e Typo
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
mark 8e76708b6c mention the overview chapter 2020-08-02 19:44:04 -05:00
Who? Me?! 12bf5b4747 Link to overview ch instead of internals
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
mark e10dbb8586 missing link 2020-08-02 19:44:04 -05:00
mark a9024bd3b2 add a bit more discussion of big picture 2020-08-02 19:44:04 -05:00
mark a1ef8389eb fix typo 2020-08-02 19:44:04 -05:00
mark 63a0c1f3da line length 2020-08-02 19:44:04 -05:00
mark 3852cb1592 rewrite/update compiler source code chapter 2020-08-02 19:44:04 -05:00
Yuki Okushi f31532d3b2 Mention `HAIR` to clarify 2020-08-02 08:39:33 -05:00
Yuki Okushi 8a3e706aca Rename `HAIR` to `THIR` 2020-08-02 08:39:33 -05:00
Yuki Okushi 9c351189e9 Adjust mentions about CI to GitHub Actions 2020-08-02 08:38:26 -05:00
Yuki Okushi 68a2b034c5 Rename `src/libstd` to `library/std` etc. (#815) 2020-07-30 22:47:22 +09:00
Jake Goulding 38aef99f68 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 879ca582de Update docs to match the new x.py defaults (#813) 2020-07-29 04:20:00 +09:00
Yuki Okushi 593facff2a 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 a99182921c Fix MIR to LLVM IR sentence (#811) 2020-07-28 05:03:37 +09:00
David Wood 50706fc2a2 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 bc72178000 Fix links for cranelift (#809) 2020-07-22 19:32:21 +09:00
Federico Ponzi ed2e2b1d3f Fixes menu for rustdoc page (#804) 2020-07-18 19:18:06 +09:00
Yuki Okushi 9085f687dd Clean-up minor issues (#802) 2020-07-18 00:00:34 +09:00
Felix S Klock II aca4e6b2a4 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 973ced6951 Change `rustc::*` to `rustc_middle::*` (#798) 2020-07-16 11:13:49 +09:00
Santiago Pastorino a93d729018 Resync config.toml and suggest better settings 2020-07-14 15:03:16 -05:00
Yuki Okushi bda916e75d Fix typos 2020-07-14 14:26:41 -05:00
Yuki Okushi 1e14491218 Fix distortions of "representation" 2020-07-14 14:26:41 -05:00
Joshua Nelson a03162ec35 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 e2389e57d8 Fix the difference of title in appendix A (#793) 2020-07-14 10:06:22 +09:00
Ivan Veselov 87554a233a Earlier clarification of pFCP abbreviation (#791) 2020-07-12 10:29:17 +09:00
Ivan Veselov a744c0ae04 Fix typo: review -> reviewer 2020-07-11 09:30:19 -05:00
Santiago Pastorino e17cf59c30 inluding -> including 2020-07-10 16:47:54 -05:00
Matt Kraai e89e5fecc5 Canonicalize part 1 name (#788) 2020-07-05 08:19:10 +09:00
Nadrieril 6889dcc7d5 Suggest selectively disabling optimizations 2020-07-04 18:06:41 -05:00
Eric Huss 20e080bf38 Update bug report links. 2020-07-04 13:09:55 -05:00
Yuki Okushi 85b8077831 Fix link for armhf-gnu Dockerfile 2020-07-04 13:06:27 -05:00
Eric Huss 401d0bf12b Update docs on using Docker images. 2020-07-04 12:44:57 -05:00
Takayuki Nakata 45fb510957 Fix jump marker of debruijn index (#783) 2020-07-04 00:31:52 +09:00
Eric Huss 434631397b Minor updates to stage docs. (#781) 2020-07-04 00:28:44 +09:00
Who? Me?! f86c34e7d7 add stub inline asm chapter (#773) 2020-07-03 07:37:29 +09:00
Takayuki Nakata 0fd8abe5bf 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 27b9565b71 fix links 2020-07-01 22:07:52 -05:00
Who? Me?! 92cbc030cd Escape other non-link
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
Who? Me?! d3c6f899cb Fix non-link
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
mark 6bc1c18282 fix links 2020-07-01 22:07:52 -05:00
mark 638073deb1 fix links 2020-07-01 22:07:52 -05:00
mark 6796449f88 line length 2020-07-01 22:07:52 -05:00
mark 60b8d21d5c move CONTRIBUTING.md to rustc-dev-guide 2020-07-01 22:07:52 -05:00
pierwill 431c3a3be2 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 3d657229ad fix file name 2020-06-30 16:04:28 -05:00
Who? Me?! 342c4b7ba9 Move Getting Started to a "prefix chapter" 2020-06-30 16:04:10 -05:00
Who? Me?! 3e6097db7e Move Errors and Lints to Analysis 2020-06-30 16:03:50 -05:00
Yuki Okushi 38d14755b3 Rename resolvers following the latest rustc change (#776) 2020-06-30 16:22:38 +02:00
pierwill d18ab7154a 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 089dd18f03 Fix line lengths 2020-06-28 12:15:23 -05:00
Joshua Nelson e4d6bfe303 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 38e0461def 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 e362fdc8c7 Add 'recovery' to the gloassary 2020-06-27 11:05:32 -05:00
Who? Me?! 7884fdfdb0 Fix formatting 2020-06-24 21:38:54 -05:00
Who? Me?! 32c4f1aa61 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 541f88e8dd Move x.py commands to overview 2020-06-23 17:40:16 -05:00
Joshua Nelson bf38f1b6f8 Split up rustdoc page 2020-06-23 17:40:16 -05:00
Joshua Nelson ee73a81989 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 cb950b77e8 Small spelling fix. 2020-06-23 12:44:15 -05:00
mark 93c21dd722 address review comments 2020-06-23 12:42:06 -05:00
Florian Gilcher 59e5e68074 Add prerequisite page 2020-06-23 12:42:06 -05:00
Andy Russell 20d3370db9 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?! 98a67dc23b Fix links for now. 2020-06-23 00:35:54 -05:00
ThePuzzlemaker c398a14f33 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?! 8011445536 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?! 92fafef00a new tykind::error convention (#715) 2020-06-19 07:55:58 +02:00
mark 8017824161 fix line length 2020-06-18 12:16:00 -05:00
mark b5864347d0 address a bunch of review comments 2020-06-18 12:16:00 -05:00
Who? Me?! d94394322b LeSeulArtichaut wording/typo fixes
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
mark d4056d0820 address review comments 2020-06-18 12:16:00 -05:00
Who? Me?! b24d9eb1fa Apply suggestions from code review
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
Who? Me?! 28ccf26223 Better wording
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
mark 4250a4030a Slightly reorganize to first present the slow command then the fast commands 2020-06-18 12:16:00 -05:00
mark d829ce6f9b add a note about disk space 2020-06-18 12:16:00 -05:00
mark 0acd363057 python 3 also 2020-06-18 12:16:00 -05:00
Who? Me?! b7e8d5f398 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 c6766dfb7c add forge 2020-06-18 12:16:00 -05:00
Who? Me?! e492cf389b Apply suggestions from code review
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
mark 5e2d3c35ed add note on submodules 2020-06-18 12:16:00 -05:00
mark 3bedf5c442 add a bit more 2020-06-18 12:16:00 -05:00
mark a9a82c4420 fix link 2020-06-18 12:16:00 -05:00
mark 1f0f15f380 mention incremental disk space 2020-06-18 12:16:00 -05:00
mark 6e482fb047 a couple more small changes 2020-06-18 12:16:00 -05:00
mark 96a7a9a49c some minor updates 2020-06-18 12:16:00 -05:00
mark 7942336575 write about processes 2020-06-18 12:16:00 -05:00
mark 655b6ba886 address some review comments 2020-06-18 12:16:00 -05:00
Who? Me?! 78e224ca52 Typo fixes
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
mark 4cbb4c384e start a getting started guide 2020-06-18 12:16:00 -05:00
Eric Huss 7c51350dfc Add a link to the forge procedure on adding new options. (#754) 2020-06-18 10:33:15 +02:00
Joshua Nelson b5be6012f6 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 7e3da5c2ee Document rustdoc behavior
- `RUSTDOC_LOG`
- `// aux-build:filename.rs`
- `// build-aux-docs`
2020-06-17 09:24:41 -05:00
Eric Huss 6d921020b6 Add some more detail on compiletest normalization. 2020-06-16 23:14:05 -05:00
Ralf Jung 4c48d4c0eb tag/niche terminology (#747) 2020-06-11 12:38:42 +02:00
LeSeulArtichaut a50d9c590a 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 78b302c3a9 Include "Lint" in the title of the diagnostics chapter (#742) 2020-06-10 15:19:59 -03:00
Niko Matsakis a7a83e664d complete the ICE-breaker => notification group rename 2020-06-09 18:03:33 -05:00
Niko Matsakis df8ee5af1f add the ARM notification group (#740) 2020-06-09 23:58:22 +02:00
Niko Matsakis d152893e86 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 df23757b09 Document needs-* compiletest directives 2020-06-08 12:33:35 -05:00
Who? Me?! 98d000fb3c 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 e74b4ab3a4 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 f9c6c1b117 braces 2020-06-05 10:34:56 -05:00
Bastian Kauschke c9f49c6581 words 2020-06-05 10:33:15 -05:00
Who? Me?! 138c73f545 Fix link (#734) 2020-06-05 17:10:01 +02:00
LeSeulArtichaut c4590c0644 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 6b85d54752 Update lint declaration example (#713) 2020-05-30 08:49:25 +09:00
Tom Eccles 01f01823ed Document more //ignore-X test headers 2020-05-29 13:27:03 -05:00
Tom Eccles d56a31f73c Document remote testing 2020-05-29 13:27:03 -05:00
LeSeulArtichaut 2b3522a840 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 1036ac82ed Update src/tests/adding.md
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-28 19:57:59 -05:00
Chris Simpkins 154e750ec5 add documentation of UI test error annotation substring support 2020-05-28 19:57:59 -05:00
Chris Simpkins f086b737ef 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 3bb5fc53b5 Clarify lint vs fixed diagnostic. 2020-05-27 20:33:46 -05:00
Eric Huss 000f04e2f9 Updates from review. 2020-05-27 20:33:46 -05:00
Eric Huss 9befa0d9cc 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 5ae9e9191e Add some guidelines on diagnostics. 2020-05-27 20:33:46 -05:00
LeSeulArtichaut cf38ea60b2 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 bc9d1d0d76 Fix typo
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-27 15:17:33 -05:00
LeSeulArtichaut fc379a898f Add definition of `niche` to the glossary 2020-05-27 15:17:33 -05:00
Eric Huss 865e5542ad Move CLI to part 3. 2020-05-27 12:35:13 -05:00
Eric Huss 3d077bb26e 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 8f7abbdf41 Add some guidelines on the CLI. 2020-05-27 12:35:13 -05:00
Michael Bryan e4c502318f It looks like the high-level-overview was renamed (#721) 2020-05-28 00:04:56 +09:00
LeSeulArtichaut a3287df2ad Add section for debugging rustc type layouts (#720) 2020-05-27 14:17:39 +02:00
Yuki Okushi 523e300c04 Rename `upvars` query to `upvars_mentioned` 2020-05-26 11:05:21 -05:00
Yuki Okushi 85d815d11d 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 c777d434f5 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 9272d05ea7 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 78cf9b2ba1 typo fix (#706) 2020-05-19 11:30:27 +09:00
Jade McGough 05aee3ef6c Add missing closing paren (#705) 2020-05-16 21:19:52 -04:00