Commit Graph

1543 Commits

Author SHA1 Message Date
Camelid 4142cf8b8d 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 659281e739 Fix broken link in the contributing guide (#996) 2020-12-29 21:08:55 +01:00
Iñaki Garay 7268945c0f 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 e0425a9563 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 2f9696bdeb [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 cb0b7b64ee Document `error-pattern` header (#989)
* Document `error-pattern` header

* Address some reviews
2020-12-12 16:06:30 +01:00
Yuki Okushi 4e871ea1db Fix some link failures and typos 2020-12-11 16:00:15 -05:00
Nixon Enraght-Moony a801509b43 All links to rustdoc-internals.md 2020-12-10 14:51:04 -05:00
Camelid 0265b964a7 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 a7c82e3ba9 Adds a dev guide section on Rust Coverage 2020-12-07 14:22:45 -05:00
Siddharth 2adddd99f2 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 a4871f5013 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 903f6277f4 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 b3fc04e298 fix a couple links 2020-12-03 00:06:19 -05:00
mark 44c7c54da1 exclude play.rlo from linkchecks 2020-12-03 00:06:19 -05:00
jumbatm e98d87a670 Use shorter [][]-style link to not pass 100 chars. 2020-12-02 22:34:16 -06:00
jumbatm dc31ca1ca8 Apply suggestions from review.
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-12-02 22:34:16 -06:00
jumbatm 0e7f5c08b1 Document SessionDiagnostic 2020-12-02 22:34:16 -06:00
Camelid d89703684b Use shorter 'rustbot label' command
'rustbot modify labels: ...' -> 'rustbot label ...'
2020-12-01 13:56:48 -05:00
Joshua Nelson f6f9e0957c 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 5661848ab9 Address feedback 2020-11-30 18:06:43 -05:00
Ben Striegel 680e35a172 Add notes about running the UI test suite 2020-11-30 18:06:43 -05:00
Joshua Nelson a64e819af8 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 43fa1342f0 Document what 'sysroot' means 2020-11-29 20:02:55 -05:00
Joshua Nelson 844ca6f14d Don't imply that the name of the fork always needs to be changed 2020-11-29 10:42:20 -05:00
Joshua Nelson 1f25130a83 Add information about common git issues 2020-11-29 10:42:20 -05:00
Hirochika Matsumoto 98fdbf9406 Fix a typo 2020-11-28 14:09:03 -05:00
Camelid 5dce3301d4 Link to feature-stabilization docs 2020-11-26 20:43:36 -05:00
Camelid ff24e31a36 Move instructions for adding a feature gate to "Feature Gates" 2020-11-26 20:43:36 -05:00
Camelid ea6df8f903 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 c63305c6e8 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 ced315b860 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 5643607b1b don't use cache while running PR builds 2020-11-23 18:42:24 -05:00
Camelid 2fa114e07d 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 49069a0233 add small explanation of why fuel can be useful for debugging 2020-11-22 08:43:00 -05:00
cjkenn ed89d6f643 add mir-opt section for optimization fuel 2020-11-22 08:43:00 -05:00
Tobias 043e6b798b updated link for Citizen Code of Conduct (#959)
* remove the code of conduct; instead link to https://www.rust-lang.org/conduct.html
2020-11-16 12:38:14 -05:00
hosseind88 b2a34704a6 add string interning wikipedia link (#960) 2020-11-15 12:14:06 -05:00
Camelid 661ba74612 Provide a brief example of a data-flow analysis 2020-11-12 11:53:00 -05:00
Camelid 3e4c0c70f2 Explain the purpose of the bottom value 2020-11-12 11:53:00 -05:00
Camelid 6a4c0ee05f Add a section on data-flow convergence 2020-11-12 11:53:00 -05:00
Alexis Bourget 4b00bfb892 Links to htmldocck/@has/matches for searchability 2020-11-11 19:02:37 -05:00
Olivier FAURE 7497da24ca Update src/compiler-debugging.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-11 10:39:15 -05:00
Olivier FAURE 4da49360a6 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
Joshua Nelson 95a3cfa327 Add some more examples of using the compiler 2020-11-10 20:02:56 -05:00
Casey Rodarmor d7bb0ad45d 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 79d3ceb2fa Fix install command 2020-11-09 09:07:41 +02:00
Casey Rodarmor ac0b94deff 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 3f33422aab 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 3de0132a0d Use `provide_both` link instead of `provide(_extern)` 2020-11-06 19:18:15 -06:00