mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
1,885 Commits 3 Branches 0 Tags 114 MiB
Commit Graph

1885 Commits

Author SHA1 Message Date
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
Tobias 950e4a4a25
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 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
Joshua Nelson 0a1da4f8a4 Add some more examples of using the compiler 2020-11-10 20:02:56 -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