Commit Graph

1457 Commits

Author SHA1 Message Date
Camelid ba9259eaaf
Fix typo (#1016)
"currenty"!
2021-01-09 17:18:57 -08:00
Ryan Levick ed721052a6 Break up long line 2021-01-05 16:13:58 -05:00
Ryan Levick a62429b367 Remove backticks and comment about possible bug 2021-01-05 16:13:58 -05:00
Ryan Levick df8df90fe9 Update src/compiler-debugging.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-05 16:13:58 -05:00
Ryan Levick 468faaea87 Make instructions for configuring compiler for debug more explicit 2021-01-05 16:13:58 -05:00
Camelid 92e47a0559 Remove old sentence that should have been removed
It was mistakenly not removed in #997.
2021-01-04 22:43:03 -05:00
Yuki Okushi 49f1ed8d77 Fix "Potential incomplete link" error on compiler-debugging.md 2021-01-04 20:12:37 -05:00
Eric Huss f08a6b3b83 Update mdbook 2021-01-04 11:16:42 -05:00
Ryan Levick 11b83ebb5a Add link to rust-analyzer docs on getting started page 2021-01-04 10:09:49 -05:00
Sebastian Widua a0819a6d98 Fix some typos 2021-01-04 10:02:33 -05:00
Camelid de3bdce4b8 Tweak wording around provider purity 2021-01-03 22:31:09 -05:00
Laurențiu Nicola 64c4632faf Fix typo (reflex -> reflect) 2021-01-02 09:25:03 -05:00
Joshua Nelson 541976f658
Clarify that `check` uses a different stage than `build` (#999) 2021-01-01 20:59:23 +00:00
Yuki Okushi 148742b6ce
Fix broken link for `BoundRegion` (#998) 2020-12-31 01:13:49 +01:00
Camelid f2e7d46f28
Update logging section and explain `RUSTC_LOG_COLOR` (#997)
* Update logging section and explain `RUSTC_LOG_COLOR`

* Small fixes

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

* Mention that prefixes of paths work as log filters

* `=debug` matches `debug!` *and higher*

* Note that `MIRI_LOG_COLOR` only applies to logs from Miri

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-31 01:08:00 +01:00
Joshua Nelson e7da4fd769
Fix broken link in the contributing guide (#996) 2020-12-29 21:08:55 +01:00
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
mark f98c407fcd exclude play.rlo from linkchecks 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 e66adf6bb5
Improve contributor experience for the dev-guide itself (#973)
- Fix typos in the README
- Don't echo all instructions in the linkcheck.sh shellscript; this is
  noisy and unhelpful when developing locally. Verbose output is still
  enabled in CI.
- Link to the index page for compiler docs, not `rustc_middle`. Note
  that the compiler docs are not a guide - that's us!
- Remove outdated instructions about avoiding 429s. These should no
  longer be occurring locally now that we're using caching.
- Consolidate info about `mdbook` and `mdbook-linkcheck` near each other
2020-11-30 11:08:32 -03: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
mark 8ebb338abb don't use cache while running PR builds 2020-11-23 18:42:24 -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