Commit graph

1470 commits

Author SHA1 Message Date
Camelid
e61acde6b5 Add missing period 2021-01-21 14:26:25 -05:00
Joshua Nelson
1e695f2e0c Remove "Skipping LLVM build" section
`download-ci-llvm` is available and enabled by default for all tier 1
platforms, so there is no need to change it. Using system LLVM over CI
llvm is still supported, but is not recommended. Building LLVM from
source is still supported.

This also notes that you need to explicitly disable downloading LLVM
when updating the submodule.
2021-01-20 13:45:05 -05:00
Iñaki Garay
d38f93b7d2 Add mdbook-toc, markers, and documentation (#1028)
* Add mdbook-toc to travis, book.toml  and documentation

* Add toc markers

* Whitespace cleanup and some punctuation

* Addressed comments
2021-01-20 14:33:11 -03:00
Joshua Nelson
10f6bbc957 Link to feature_err in stability section (#1022) 2021-01-19 11:47:45 -08:00
Martin Geisler
940b3b1b5f Fix typo (#1027) 2021-01-17 11:50:04 -03:00
Joshua Nelson
3c2fdf4751 Note that --check now allows using any stage 2021-01-17 05:51:00 +02:00
ashosive
c37d7ef838 improved the readablity of a line 2021-01-16 12:04:07 -05:00
saki-osive
7aa31baa1d Fixed a grammatical error in hardawre requirements section 2021-01-16 10:03:23 -05:00
saki-osive
01bc71443c Corrected MIR file path and fixed a typo (#1020) 2021-01-14 14:10:08 -08:00
Yuki Okushi
1ac8ff22d8 Add a note about UI test entry limitation (#1019) 2021-01-12 07:55:13 +09:00
Iñaki Garay
6d05039413 Add context to dated information (#1013)
* Fixes #924 Add context to dated information

* Fixes #924 Addressed comments and some uses of 'currently'

* Update src/contributing.md

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

* Update src/salsa.md

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

* Fixes #924 Addressed comments

* Fixes #924 Fixed line lengths.

Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-10 19:23:22 -03:00
Camelid
5e3512a4c6 Update 'Workspace structure' section (#1017)
* Update description of `src/`
* Note that `library/` also contains the Rust runtime
2021-01-10 16:19:39 -05:00
Camelid
84c3c96d59 Point to HirId instead of NodeId 2021-01-09 21:05:10 -05:00
Camelid
012d6da489 Fix typo (#1016)
"currenty"!
2021-01-09 17:18:57 -08:00
Ryan Levick
ccac27e387 Break up long line 2021-01-05 16:13:58 -05:00
Ryan Levick
78fdaddcad Remove backticks and comment about possible bug 2021-01-05 16:13:58 -05:00
Ryan Levick
af659a6a91 Update src/compiler-debugging.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-05 16:13:58 -05:00
Ryan Levick
24457793ee Make instructions for configuring compiler for debug more explicit 2021-01-05 16:13:58 -05:00
Camelid
3a3e83e933 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
34379a14ad Fix "Potential incomplete link" error on compiler-debugging.md 2021-01-04 20:12:37 -05:00
Eric Huss
188bf64219 Update mdbook 2021-01-04 11:16:42 -05:00
Ryan Levick
ec42a83b54 Add link to rust-analyzer docs on getting started page 2021-01-04 10:09:49 -05:00
Sebastian Widua
ed1ea46be8 Fix some typos 2021-01-04 10:02:33 -05:00
Camelid
95292a6066 Tweak wording around provider purity 2021-01-03 22:31:09 -05:00
Laurențiu Nicola
bf4e7b347d Fix typo (reflex -> reflect) 2021-01-02 09:25:03 -05:00
Joshua Nelson
287434551a Clarify that check uses a different stage than build (#999) 2021-01-01 20:59:23 +00:00
Yuki Okushi
bcee60a6e3 Fix broken link for BoundRegion (#998) 2020-12-31 01:13:49 +01:00
Camelid
1189701516 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
4b53788216 Fix broken link in the contributing guide (#996) 2020-12-29 21:08:55 +01:00
Iñaki Garay
1e2c721503 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
f53399f06f 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
603f6bd62b [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
39df3d6ef2 Document error-pattern header (#989)
* Document `error-pattern` header

* Address some reviews
2020-12-12 16:06:30 +01:00
Yuki Okushi
74887a057b Fix some link failures and typos 2020-12-11 16:00:15 -05:00
Nixon Enraght-Moony
7cd87eb4cd All links to rustdoc-internals.md 2020-12-10 14:51:04 -05:00
Camelid
2e4650a6dd 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
85771c7af9 Adds a dev guide section on Rust Coverage 2020-12-07 14:22:45 -05:00
Siddharth
599a755bb6 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
51936d51e8 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
7cf284df45 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
cb2ea72e78 fix a couple links 2020-12-03 00:06:19 -05:00
mark
5da3f64992 exclude play.rlo from linkchecks 2020-12-03 00:06:19 -05:00
jumbatm
9d576c9ef1 Use shorter [][]-style link to not pass 100 chars. 2020-12-02 22:34:16 -06:00
jumbatm
b2eb38e362 Apply suggestions from review.
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-12-02 22:34:16 -06:00
jumbatm
ca6075eb90 Document SessionDiagnostic 2020-12-02 22:34:16 -06:00
Camelid
c5545f8dd9 Use shorter 'rustbot label' command
'rustbot modify labels: ...' -> 'rustbot label ...'
2020-12-01 13:56:48 -05:00
Joshua Nelson
0cf6b13c54 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
7aadeecb5e Address feedback 2020-11-30 18:06:43 -05:00
Ben Striegel
3ae060dbfc Add notes about running the UI test suite 2020-11-30 18:06:43 -05:00
Joshua Nelson
76ac4633fe 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