6e4f0cbe1b
Add suggested settings note for coc ( #1144 )
2021-06-13 01:17:06 +09:00
8608047fb2
move 7/8 to prose
2021-06-09 14:43:20 -04:00
072657e0a5
Add a section on keeping things up to date in the git section
2021-06-09 14:43:20 -04:00
c8da5bfd1c
Fix some links ( #1137 )
...
* Fix some links
* Address review comment
2021-06-04 09:08:56 +02:00
78204563e2
explain Miri engine vs Miri-the-tool
2021-05-30 02:18:51 +02:00
70e979a519
Add more information about no_hash query modifier. ( #1133 )
2021-05-28 17:23:27 +02:00
f6f83e2fae
improve section introduction
2021-05-26 06:24:44 -04:00
99e60b3302
not all tools require waiting for a nightly release before they can be fixed
2021-05-26 06:24:44 -04:00
12f9ede977
Describe the difference of rustc_lint vs rustc_lint_defs.
2021-05-25 21:37:21 -04:00
50de7f0682
update rustfmt references to reflect change from submod to subtree ( #1129 )
...
* update rustfmt references to reflect change to subtree
* clarify broken toolstate hypothetical scenario
2021-05-20 15:02:20 +02:00
8faa1646f5
Remove `--stage 1` argument from `doc` invocations ( #1125 )
2021-05-18 19:10:39 +02:00
c989a4db5b
Update coverage docs ( #1122 )
2021-05-13 19:19:43 -07:00
f58dfe98ad
Document -Zunpretty=thir-tree ( #1128 )
...
* document -Zunpretty=thir-tree
* Update position/wording
2021-05-13 20:51:43 +02:00
1e6c7fbda4
Unified CPU Requirements ( #1126 )
2021-05-10 13:38:24 +09:00
5b63bc2fb7
add 'waiting-for-review' incantation to main contrib page ( #1124 )
2021-05-05 13:53:42 +02:00
e72b43a649
Suggest using `git range-diff` ( #1092 )
...
I have found it to be very helpful when rebasing.
2021-04-27 12:35:37 -07:00
ccc286ba87
Add sample nix shell
...
This also suggests using `x.py setup` instead of copying config.toml.
2021-04-27 08:52:22 -04:00
9b0135d306
more RA config suggestions ( #1114 )
2021-04-26 18:34:50 -04:00
2f5927a77e
Add Polymorphisation paper ( #1093 )
2021-04-24 10:53:30 +09:00
8cf042c6f5
Mention unpretty=mir-cfg for debugging MIR
2021-04-23 16:25:11 -04:00
a9bd2bbf31
Improve formatting and update info in "method lookup" section
2021-04-09 18:12:21 -04:00
31e44f4116
Change wording a bit: `module` => `crate`
...
It seems more correct
2021-04-09 10:34:26 -04:00
2c2f61ae19
fix typo ( #1107 )
2021-04-09 12:30:04 +02:00
83b81fdd69
fix typo
2021-04-08 17:29:13 -04:00
871a54568f
Mention CI build of LLVM in build instruction
2021-04-03 22:28:35 -04:00
d1e2f3bf50
Fix rustdocs test command typo ( #1103 )
2021-04-04 01:41:35 +09:00
8d6459ffff
Update the "LLVM updates" section
2021-04-02 05:57:57 -04:00
dfe398bd5a
Fix a link about Rustdoc internals
2021-04-02 05:25:14 -04:00
32c6d27b4b
Add quickstart for adding a new optimization ( #1094 )
2021-04-01 19:24:44 +02:00
dda441c42e
Add back example of {{cwd}} ( #1099 )
...
I force-pushed this in the last commit and accidentally deleted the
github suggestion.
2021-04-01 04:04:46 +09:00
a05852eec0
Document test input normalization
2021-03-31 14:51:19 -04:00
0687daac28
Add notes about nightly rustc version for the rustc-driver examples
2021-03-28 13:33:56 -04:00
9a676ee3a4
Fix rust compiler meeting info ( #1087 )
...
* Remove dead link
* Make general text a bit better
* Fix Zulip link
* Improve description of what the compiler meeting is about
2021-03-19 19:11:43 -04:00
67ebd4b55d
Remove extra the ( #1088 )
2021-03-11 13:36:25 -08:00
e72bf56a45
Fix double-word typos ( #1084 )
...
Inspired by #1079 . I used this command to find these typos:
rg --multiline --pcre2 '\b([a-zA-Z]+) \1\b' src -tmd
There were a couple false positives of the form "that that" meaning
"that it" or "that this".
2021-03-12 03:29:19 +09:00
ff363172f9
I-nominated are nominated for discussion ( #1080 )
...
* I-nominated are nominated for discussion
* Generalize meeting expression
Co-authored-by: Camelid <camelidcamel@gmail.com>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-11 19:05:02 +01:00
0526ce3339
Complete unfinished statement
2021-03-11 13:01:44 -05:00
bfe8e98253
Update lins
2021-03-10 12:00:27 -05:00
872ba49f48
Apply suggestions from code review
...
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-10 12:00:27 -05:00
4c8fdcf511
Add stub about the THIR
2021-03-10 12:00:27 -05:00
912aa00c3b
Adjust a bit better P- label text
2021-03-10 11:35:23 -05:00
f83c57bee6
Fix typos ( #1079 )
2021-03-10 23:56:51 +09:00
0b1bdbb183
Update cmake version in prerequisites.md ( #1077 )
...
LLVM requires at least cmake 3.13.4.
https://www.llvm.org/docs/CMake.html
2021-03-09 20:00:12 +01:00
ddadc67423
Fix typo: suceed -> succeed
2021-03-09 12:37:10 -05:00
91f8f334f4
Add article on using WPA to profile rustc memory usage on Windows ( #1074 )
...
Document how to use WPA to profile rustc and what the normal workflow
should be for investigating bootstrap memory usage issues.
Co-authored-by: Ryan Levick <ryan.levick@gmail.com>
2021-03-09 04:42:56 +09:00
8bb61fe105
Use more accurate estimate of generated LLVM IR with llvm-lines
...
The `--emit=llvm-ir` emits an optimized LLVM IR. For optimized builds it will be
highly inaccurate estimate of the amount IR generated initially. While the
inaccuracy can be somewhat reduce after disabling the optimization, that in turn
has other unintended consequences, since opt-level controls the emission of
lifetime markers, sharing of generics between crates, instantiation of inline
functions, etc.
Use `-Csave-temps` and `no-opt` bitcode as a basis for more accurate estimate of
initial work handed of to the LLVM.
2021-03-07 10:57:13 -05:00
c431f8c29a
Cleanup rustdoc chapters a bit
...
* Rename "The walking tour of rustdoc" to "Rustdoc overview",
which I think is a more accurate name
* Use same name in sidebar TOC as in chapter text
* Make links between the two chapters prominent
* Convert a few `.html` links to `.md`
Probably we should just merge the chapters, but leaving that for later.
2021-02-28 16:35:20 -05:00
3cdb245b43
Fix broken links
2021-02-28 11:01:07 -05:00
1f68820307
Document how to enable CI LLVM without using `x.py setup`
2021-02-26 15:38:01 -05:00
761f92f390
Remove some unrelated changes
2021-02-26 15:38:01 -05:00
b932cf20cf
Fix typos
2021-02-26 15:38:01 -05:00
ca851c6b70
Restore instructions for using system LLVM
...
They were removed in #1030 , but are still useful.
2021-02-26 15:38:01 -05:00
07b5693a90
Update some out-of-date information
2021-02-26 15:38:01 -05:00
033a1ea771
Fixes typo in getting started guide
2021-02-24 21:20:36 -05:00
9214d4a8c3
Fix formatting of more date references ( #1067 )
2021-02-22 18:22:23 +09:00
c0e7305d33
Fix broken links in query.md ( #1068 )
2021-02-21 09:51:34 +01:00
c4c0f33a1d
Update docs from date triage for 2021-02 ( #1048 )
...
The biggest change was updating the list of rustdoc passes. Several new
ones have been added since that documentation was written, so I added
those, and I also sorted the list so it is roughly alphabetical (except
for the part for the `strip-*` passes, which I left in the same order
since one of the list items has two passes so there's no "correct"
order).
2021-02-20 19:27:24 -08:00
5297659bb1
Fix date-check comment formatting ( #1066 )
...
I realized that the format I had been previously using for date-checks
(as of January 2021 <!-- date: 2021-01 -->)
left a space before the closing parenthesis in the rendered output,
which looks weird.
I could fix this by removing the space between `2021` and `<!-- ...`,
but that looks weird in the source. So I ended up deciding on changing
it to
(as of <!-- date: 2021-01 --> January 2021)
2021-02-20 19:24:01 -08:00
f5eea60da7
Make "URL" show up ( #1065 )
...
* Make "URL" show up
* Use `<URL>`
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-02-20 13:58:22 +01:00
fba44ed2fa
Point to main branch on llvm-project's links
2021-02-19 20:25:36 -05:00
42a531c1eb
Fix typo ( #1063 )
2021-02-18 19:37:43 +01:00
5b2ef08416
Update running.md
2021-02-17 17:13:07 -05:00
3708c8227a
Add Oxide paper to bibliography
2021-02-15 10:14:03 -05:00
f525bc8071
Fix typo
2021-02-07 22:12:28 -05:00
219813a75c
Fix typo in Bug Fix Procedure ( #1050 )
2021-02-07 11:15:54 -05:00
95c3930c67
Add chapter on libs and metadata. ( #1044 )
2021-02-04 11:34:52 -05:00
5e57035110
Add lots of date-check annotations
...
Also added dates for things that previously said "as of now" or "as of
this writing" and cleaned up a couple of things along the way.
2021-02-03 19:29:07 -05:00
bd008cc786
Document how to stabilize a library feature ( #1036 )
...
* Move 'force-unstable-if-unmarked' to the bootstrapping chapter
* Document how to stabilize a library feature
Note that features can't be stabilized until they go through FCP and
that FCP happens on the tracking issue, not the PR.
* Fix wrong glob
By default `**` behaves the same as two `*` side by side, i.e. it only
globs file paths, not directories. `shopt -s globstar` needs to be set
for it to mean a directory. I didn't notice this before now because
`globstar` is set by default in interactive mode, but not otherwise.
2021-02-01 19:31:00 +01:00
85c995de1b
Update test suite descriptions. ( #1042 )
2021-01-30 20:12:01 +09:00
de386fd48a
put `x.py` in ticks
2021-01-30 10:59:57 +02:00
93a25a9fb7
Update links to `librustc_llvm` and `rustllvm`
2021-01-24 08:18:34 -05:00
697dba3bb7
Add link to promotion.md ( #1033 )
...
* Add link to promotion.md
* Improve link text
Co-authored-by: Camelid <camelidcamel@gmail.com>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-01-22 11:49:52 +01:00
d88726cd19
Add missing period
2021-01-21 14:26:25 -05:00
4e48f42e05
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
bee2fd52ce
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
bd8e94a001
Link to `feature_err` in stability section ( #1022 )
2021-01-19 11:47:45 -08:00
a090b28d8e
Fix typo ( #1027 )
2021-01-17 11:50:04 -03:00
176bbba4bf
Note that `--check` now allows using any stage
2021-01-17 05:51:00 +02:00
93fcae6322
improved the readablity of a line
2021-01-16 12:04:07 -05:00
c87ef62351
Fixed a grammatical error in hardawre requirements section
2021-01-16 10:03:23 -05:00
7ea20079df
Corrected MIR file path and fixed a typo ( #1020 )
2021-01-14 14:10:08 -08:00
3e731b7934
Add a note about UI test entry limitation ( #1019 )
2021-01-12 07:55:13 +09:00
0a5bb7f5e6
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
e7ac2ff724
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
d87e197f26
Point to `HirId` instead of `NodeId`
2021-01-09 21:05:10 -05:00
ba9259eaaf
Fix typo ( #1016 )
...
"currenty"!
2021-01-09 17:18:57 -08:00
ed721052a6
Break up long line
2021-01-05 16:13:58 -05:00
a62429b367
Remove backticks and comment about possible bug
2021-01-05 16:13:58 -05:00
df8df90fe9
Update src/compiler-debugging.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-05 16:13:58 -05:00
468faaea87
Make instructions for configuring compiler for debug more explicit
2021-01-05 16:13:58 -05:00
92e47a0559
Remove old sentence that should have been removed
...
It was mistakenly not removed in #997 .
2021-01-04 22:43:03 -05:00
49f1ed8d77
Fix "Potential incomplete link" error on compiler-debugging.md
2021-01-04 20:12:37 -05:00
11b83ebb5a
Add link to rust-analyzer docs on getting started page
2021-01-04 10:09:49 -05:00
a0819a6d98
Fix some typos
2021-01-04 10:02:33 -05:00
de3bdce4b8
Tweak wording around provider purity
2021-01-03 22:31:09 -05:00
64c4632faf
Fix typo (reflex -> reflect)
2021-01-02 09:25:03 -05:00
541976f658
Clarify that `check` uses a different stage than `build` ( #999 )
2021-01-01 20:59:23 +00:00
148742b6ce
Fix broken link for `BoundRegion` ( #998 )
2020-12-31 01:13:49 +01:00
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
e7da4fd769
Fix broken link in the contributing guide ( #996 )
2020-12-29 21:08:55 +01:00
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
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
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
3eb86119dc
Document `error-pattern` header ( #989 )
...
* Document `error-pattern` header
* Address some reviews
2020-12-12 16:06:30 +01:00
1838d293f7
Fix some link failures and typos
2020-12-11 16:00:15 -05:00
a6a9c67616
All links to rustdoc-internals.md
2020-12-10 14:51:04 -05:00
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
9f612dace6
Adds a dev guide section on Rust Coverage
2020-12-07 14:22:45 -05:00
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
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
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
af2aa997d0
fix a couple links
2020-12-03 00:06:19 -05:00
459e414b3a
Use shorter [][]-style link to not pass 100 chars.
2020-12-02 22:34:16 -06:00
3658303988
Apply suggestions from review.
...
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-12-02 22:34:16 -06:00
f7d7e48874
Document SessionDiagnostic
2020-12-02 22:34:16 -06:00
29c66a3f02
Use shorter 'rustbot label' command
...
'rustbot modify labels: ...' -> 'rustbot label ...'
2020-12-01 13:56:48 -05:00
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
dc72220925
Address feedback
2020-11-30 18:06:43 -05:00
fb6176d2a2
Add notes about running the UI test suite
2020-11-30 18:06:43 -05:00
59de3a0c58
Document what 'sysroot' means
2020-11-29 20:02:55 -05:00
eb8fefbea0
Don't imply that the name of the fork always needs to be changed
2020-11-29 10:42:20 -05:00
4663f85bd0
Add information about common git issues
2020-11-29 10:42:20 -05:00
ad67023401
Fix a typo
2020-11-28 14:09:03 -05:00
f9b3946411
Link to feature-stabilization docs
2020-11-26 20:43:36 -05:00
23b04794db
Move instructions for adding a feature gate to "Feature Gates"
2020-11-26 20:43:36 -05:00
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
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
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
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
da0701b979
add small explanation of why fuel can be useful for debugging
2020-11-22 08:43:00 -05:00
8f5a1440ae
add mir-opt section for optimization fuel
2020-11-22 08:43:00 -05:00
2777deecfa
add string interning wikipedia link ( #960 )
2020-11-15 12:14:06 -05:00
25016aeb3b
Provide a brief example of a data-flow analysis
2020-11-12 11:53:00 -05:00
79b3788fd7
Explain the purpose of the bottom value
2020-11-12 11:53:00 -05:00
9e346c9d17
Add a section on data-flow convergence
2020-11-12 11:53:00 -05:00
f36f645daf
Links to htmldocck/@has/matches for searchability
2020-11-11 19:02:37 -05:00
10869964a7
Update src/compiler-debugging.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-11 10:39:15 -05:00
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
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
4e9e17fba4
Fix install command
2020-11-09 09:07:41 +02:00
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
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
1b43503411
Use `provide_both` link instead of `provide(_extern)`
2020-11-06 19:18:15 -06:00
cc841a185f
Use new-style mdBook internal links in glossary
2020-10-28 18:33:30 -04:00
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
5d6a0cdf69
Fix broken tags in glossary
2020-10-28 18:33:30 -04:00
5b3fd170fc
Small improvements ( #936 )
...
* Fix typo errros -> errors
* an -> a
* hir -> hir()
2020-10-27 19:34:28 +01:00
de4ca80796
Add "ctxt" and `TyCtxt` to the glossary ( #937 )
2020-10-27 19:30:20 +01:00
30c298dd7c
Clean up `compiletest` chapter ( #935 )
2020-10-26 11:58:00 +09:00
53a7fd3ad3
Improve prerequisites section for Windows ( #934 )
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-26 08:15:21 +09:00
b1af2f0c07
Explain lint renaming/removing
2020-10-22 20:41:09 -04:00
47893bacd8
Add reference PRs for `r?` and `r+` comments ( #928 )
2020-10-21 23:53:32 +02:00
97eebb9adb
Replace links to `buildbot2.r-l.o` with `bors.r-l.o`
2020-10-21 17:34:07 -04:00
bd82b75020
Revert "Remove outdated build rustdoc --stage 1"
...
This reverts commit cd35d2b594
2020-10-19 23:17:17 -04:00
cd35d2b594
Remove outdated build rustdoc --stage 1
...
It builds with stage 1 by default.
2020-10-19 22:23:59 -04:00
783c5849c4
Fix typo errros -> errors
2020-10-19 14:11:19 -04:00
b04860c078
Explain why exhaustiveness is necessary for soundness
2020-10-16 18:26:10 -04:00
ada57a32f2
Explain pattern exhaustiveness checking
2020-10-16 18:26:10 -04:00
7f9c36b6a9
Fix a link on git.md
2020-10-15 23:11:33 -04:00
f34dd04a39
Added description of word Scrutinee to the glossary ( #921 )
2020-10-13 01:57:18 +09:00
50f1e77e4a
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-10 12:12:44 -04:00
3f9812cfaa
Talk about git submodules
2020-10-10 12:12:44 -04:00
d1e314f53e
Recommend debug-logging instead of debug
...
This makes the compiler faster to running without sacrificing too much
performance. It still shows logging so contributors aren't confused by
`debug!` doing nothing.
2020-10-08 16:15:06 -05:00
95b1f2b08e
Update more occurrences of system llvm link
2020-10-08 11:47:32 -04:00
e912d1904b
Fix broken "system LLVM" link
2020-10-08 11:47:32 -04:00
2e8a3e8f6d
Fix typos ( #916 )
...
Fixed two typos.
2020-10-08 16:19:56 +09:00
b8cc0a5355
Add section describing git hook functionality
...
This is a companion to [this PR](https://github.com/rust-lang/rust/pull/76356 ), which deals with including functionality for automatically running `tidy --bless` on each commit.
Undo editor auto-formatting and clarify git hook renaming
a word
Phrasing
Apply suggestions from code review
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-07 22:30:24 -04:00
d4581a56ae
Document `Assemble`
2020-10-04 11:59:58 -04:00
10878783ce
Explain stages in terms of the compiler currently running (take N+1) ( #857 )
...
* Explain stages in terms of the compiler currently running
- Address some confusing points
+ stage N+1 -> stage N artifacts
+ Use more likely examples of an ABI break
+ stage N -> stage N compiler
- Mention why rustc occasionally uses `cfg(bootstrap)`
- Note that stage1 is built using two different versions
- Add lots of examples
+ `test src/test/ui` and `test compiler/rustc` run different compilers 😢
+ Separate examples of what to do from examples of what not to do
- 'ship stage 1 artifacts' -> 'ship stage 2 compiler'
This is hopefully less confusing.
* build -> x.py build
* Add section on build artifacts
* Improve wording
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
* uplifted -> assembled
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 16:25:02 +02:00
5b895d7040
Link to .md files, rather than .html
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 10:14:22 -04:00
3f853d5a30
address lingering reviewer comments
2020-10-04 10:14:22 -04:00
e5bf706189
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-04 10:14:22 -04:00
1753f0f10d
add note
2020-10-04 10:14:22 -04:00
9175746a7e
add suggested workflow to setup nightly rustup for rustc
2020-10-04 10:14:22 -04:00
f7870395f5
Did more measurements on what exactly affects llvm-lines:
...
optimize, codegen-units and mir-opt do, but debug-assertions doesn't.
2020-10-04 10:12:47 -04:00
7adeb090fc
Document the usage of cargo-llvm-lines and -Ztimings.
2020-10-04 10:12:47 -04:00
95650a8cbb
Document new way to not build LLVM
...
Implemented in https://github.com/rust-lang/rust/pull/76349
2020-10-03 20:39:32 -04:00
c583e8b982
hir_map -> hir()
2020-10-03 19:38:38 -05:00
47ce12a4c8
Fix time periods for Triage WG procedure
2020-10-03 19:25:05 -05:00
f833b8bcdf
Update src/getting-started.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
080b0c8aad
Update src/getting-started.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
3d6d0e04ed
Add a paragraph about reviewers and review latency in Getting Started chapter
2020-10-03 19:25:05 -05:00
6a5b29b31e
Use HTTPS whenever possible in bibliography links ( #909 )
...
Also updated a few links that redirected.
2020-10-03 22:56:29 +02:00
156423221c
Fix the report link
2020-10-03 16:12:04 -04:00
6159dde37a
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
fdd5946d58
add the last missing code highlight to t-compiler in the docs
2020-10-02 12:37:27 +02:00
a8b7e92c12
Fix typo
2020-09-30 22:39:25 +02:00
c26ab70782
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
be11a5201d
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
328bd35e7d
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
5ee9d96c07
--verbose is useful when not compiling and when compiling ( #901 )
2020-09-29 17:18:00 +02:00
6b5c62c6f8
Use implicit reference links for shorter lines
...
(As suggested by jyn514.)
2020-09-27 10:37:22 -04:00
e281cf57a6
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
35b702bf36
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
5f39b8131f
Add docs for x.py setup
2020-09-27 04:24:18 +02:00
ea7ee3a503
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
2020-09-26 11:52:14 -04:00
c320337018
correct output path in Writing Documentation
2020-09-26 08:45:48 -04:00
e34496fb61
update link to 'BorrowKind' to be implicit in markdown
2020-09-25 22:55:49 -04:00
80537ec118
add link to 'BorrowKind' in closure.md
2020-09-25 22:55:49 -04:00
4a9c3579f3
update description of 'ByRef' borrows of closures
2020-09-25 22:55:49 -04:00
0adf8a36c8
minor punctuation/grammar error fix
2020-09-25 22:55:49 -04:00
d35a4c4bcb
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
30d03d013f
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
22b096ba2f
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
2a09b06365
`ConstEvalResult` is now `EvalToConstValueResult` ( #885 )
...
Also fixed typo.
2020-09-22 22:52:05 +02:00
447064120f
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
1a547f7568
Fix typo in table of contents
2020-09-17 11:35:14 -04:00
f6ba69175b
Revert "Mention that places are sometimes called "lvalues""
...
This reverts commit bf5e1c451d
2020-09-17 11:35:14 -04:00
c758b595b0
Mention that places are sometimes called "lvalues"
2020-09-17 11:35:14 -04:00
deb6710734
More improvements
2020-09-17 11:35:14 -04:00
7ca5568bae
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
ed59c2d47d
debug-logging=true instead of debug-assertions=yes
2020-09-16 21:56:05 -04:00
be58aab880
Add link for `AnalysisDomain::NAME`
2020-09-16 00:21:55 -04:00
a72fe531ce
Describe how to generate graphviz diagrams for dataflow
2020-09-16 00:21:55 -04:00
c911b40be5
Remove EN1
2020-09-15 18:13:33 -04:00
f19d3e64b4
Complete text about salsa base inputs
2020-09-15 18:13:33 -04:00
c99dc88eb8
Add Salsa In More Depth lecture
2020-09-15 18:13:33 -04:00
d4ae7b08a9
Fix typo
...
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-09-14 17:42:19 -05:00
557f8063d3
Make the HIR chapter point to the new chapter on IDs
2020-09-14 17:42:19 -05:00
a87ac24331
Apply suggestions from code review
...
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-14 17:42:19 -05:00
d91788c71d
Add a chapter on all the identifiers used through `rustc`
2020-09-14 17:42:19 -05:00
0520a58b42
Update `Visitor` and `Cursor` examples
2020-09-13 15:58:02 -04:00
92fdaa6c42
Line edits
2020-09-13 15:58:02 -04:00
e8003db79a
Add missing link to `Engine`
2020-09-13 15:58:02 -04:00
ed3d255153
Initial draft of MIR dataflow framework docs
2020-09-13 15:58:02 -04:00
2c733c97e8
correct attribute used here
2020-09-12 18:41:06 -04:00
434556f9e0
Address nits
2020-09-12 13:12:14 -05:00
d333d1e74f
Note that the default is 2015
2020-09-12 13:12:14 -05:00
e7b11c1d89
Document edition flag for UI tests
2020-09-12 13:12:14 -05:00
716adae5ac
Fix typo
2020-09-12 12:07:04 -04:00
e64ac0997e
Hide `@rustdoc` implementation details
2020-09-12 12:07:04 -04:00
ff958b3d4b
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
5fa00e0074
Update src/rustbot.md
2020-09-12 12:07:04 -04:00
3c749064d3
Update src/rustbot.md
2020-09-12 12:07:04 -04:00
1d9675c905
Update src/contributing.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-12 12:07:04 -04:00
58c2b85aa9
Update src/contributing.md
2020-09-12 12:07:04 -04:00
e616159576
Add a chapter on useful `@rustbot` commands
2020-09-12 12:07:04 -04:00
cccee1a93e
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
150b915338
Fix typo
...
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-11 13:42:39 +02:00
6366c1dbaa
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-11 13:42:39 +02:00
ee99dea822
Clean up 'Contributing to Rust - Pull Requests'
2020-09-11 13:42:39 +02:00
a85aed08e4
Fix other library commands
2020-09-10 23:56:41 -04:00
b3b8f0ad6c
Fix incorrect docs about stages
...
`build library/core` builds the compiler, not just the standard library.
2020-09-10 23:56:41 -04:00
0b58331de0
Add back information about Googling
...
Also cleaned up some other things.
2020-09-09 22:58:18 -04:00
3c353e4eec
Add back comma
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 22:58:18 -04:00
9e00fdfc93
Add more info about Rustdoc
2020-09-09 22:58:18 -04:00
d145fcdb4e
Update "Helpful Links" section
2020-09-09 22:58:18 -04:00
ab19c3eef8
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
a7ac2cbad6
Minor cleanup for "How to build and run"
2020-09-09 20:58:30 -04:00
91a4afbcc6
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
683cbdda74
Fix nit
2020-09-09 21:39:55 +02:00
987b5ef008
Update src/building/new-target.md
2020-09-09 21:39:55 +02:00
7d54418137
Document how to promote a target from cross-compiled to hosted
2020-09-09 21:39:55 +02:00
af3a92e843
Update src/queries/profiling.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 12:30:56 -04:00
91bfaa8e20
Update def_id.rs location
2020-09-09 12:30:56 -04:00
e1f750feda
Fix typo, hellow -> hello
2020-09-09 12:30:56 -04:00
35af35dd89
Add ./ to run x.py
2020-09-09 12:30:56 -04:00
ab5809b018
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
b29062cb76
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
daa7597067
Add information about default stages for x.py
2020-09-09 11:05:26 -04:00
13c18fccbe
Fix typo
2020-09-09 16:58:05 +02:00
75ad441702
Document speculative crate loading ( #859 )
2020-09-09 10:19:01 +03:00
677a95f264
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
fb88941f06
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
d8db731a4a
Document CGU partioning in case of generic and inline functions
2020-09-07 10:07:40 -04:00
d117002719
Update src/building/how-to-build-and-run.md
2020-09-07 08:55:08 -04:00
e69542d0ea
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
bb4695345e
Rename src/rustc to compiler/rustc
2020-09-06 16:21:08 +02:00
039e29f77c
update docs to refer to the move
2020-09-03 19:25:02 -04:00
af533030a2
Fix dep-graph-caller-callee test location
2020-09-03 16:21:30 +02:00
b737f79192
Adds documentation to cover spanview output
...
Documents the feature introduced in #76074 .
2020-09-02 12:39:47 +02:00
2924b6962d
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
9ab50113c2
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
45a1535007
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-31 05:12:13 +02:00
4cb43d8160
fix typos
2020-08-31 05:12:13 +02:00
b259473dd1
fix line lengths
2020-08-31 05:12:13 +02:00
9bb3872dc7
fix links and names after compiler mv to compiler/
2020-08-31 05:12:13 +02:00
76efc9b91f
nits
2020-08-26 08:07:52 -04:00
7e3fe0a961
Apply review suggestion
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-26 13:13:14 +02:00
92499eadd4
Clarify section on MIR construction
2020-08-26 13:13:14 +02:00
401abb9bdf
Add new section to have a local HTTP server easily ( #833 )
2020-08-23 14:36:45 +02:00
844361cb78
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
76d7b6ac70
Remove duplicate MIR chapter entry ( #830 )
2020-08-19 11:46:02 +00:00
75aa32f7b4
Document how to use build task for x.py check ( #828 )
2020-08-17 23:10:29 +09:00
6a59d0df34
Link ref to edge concept in graph theory
2020-08-17 09:00:47 -04:00
3dcd4e393f
Remove unneeded hashmarks ( #826 )
...
Co-authored-by: Joshua Nelson <jyn514@gmail.com>
2020-08-17 04:51:37 +09:00
f08527cc4b
Address revuew comments
2020-08-16 14:14:35 -05:00
6ff87f49ba
Document serialization in rustc
2020-08-16 14:14:35 -05:00
4657fbcda7
Some small fixes ( #823 )
...
* Fix some typos
* Update from `typeck_tables_of` to `typeck`
* Fix comment
2020-08-11 19:36:48 -04:00
cb51d0e1f0
Use angle brackets to turn URL into a link
2020-08-04 09:50:19 -04:00
f1cf48835d
Fix typo
2020-08-04 09:50:19 -04:00
eb0522c4ac
Fix a broken link
2020-08-04 09:50:19 -04:00
ec373ae12e
Enable a link
2020-08-04 09:50:19 -04:00
44f1ab3bcf
Some small fixes
2020-08-03 11:07:57 -05:00
04bd4ccd97
Fix typo
2020-08-03 11:07:57 -05:00
2cc652be17
Fix: crates -> a list of crates
2020-08-03 11:07:57 -05:00
4db8160fa3
Avoid "whitelist"
...
Fixed according to 62cf767a4a
2020-08-03 11:07:57 -05:00
4e41d060c1
Prefer `::` than `.`
2020-08-02 23:16:01 -05:00
e54d59ca74
Fix link/wording for `parse_nt`
2020-08-02 23:16:01 -05:00
cec6addcaf
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
f8dfca5001
some updates after std libs move
2020-08-02 19:44:04 -05:00
5756aa3ecf
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
6f98316930
mention the overview chapter
2020-08-02 19:44:04 -05:00
fc7b7a5723
Link to overview ch instead of internals
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
0dab310a1b
missing link
2020-08-02 19:44:04 -05:00
abd77148a4
add a bit more discussion of big picture
2020-08-02 19:44:04 -05:00
041e86cb95
fix typo
2020-08-02 19:44:04 -05:00
146635d7ff
line length
2020-08-02 19:44:04 -05:00
80c2dfd9d6
rewrite/update compiler source code chapter
2020-08-02 19:44:04 -05:00
61824dde4f
Mention `HAIR` to clarify
2020-08-02 08:39:33 -05:00
d89c8c9b12
Rename `HAIR` to `THIR`
2020-08-02 08:39:33 -05:00
c7a3bca829
Adjust mentions about CI to GitHub Actions
2020-08-02 08:38:26 -05:00
f8012dbf42
Rename `src/libstd` to `library/std` etc. ( #815 )
2020-07-30 22:47:22 +09:00
5bde3efd90
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
eeca3757b8
Update docs to match the new x.py defaults ( #813 )
2020-07-29 04:20:00 +09:00
e20ac5d64b
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
87a11a3045
Fix MIR to LLVM IR sentence ( #811 )
2020-07-28 05:03:37 +09:00
fd458b988c
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
aecb593979
Fix links for cranelift ( #809 )
2020-07-22 19:32:21 +09:00
63536944b0
Fixes menu for rustdoc page ( #804 )
2020-07-18 19:18:06 +09:00
26adefdb05
Clean-up minor issues ( #802 )
2020-07-18 00:00:34 +09:00
467d429597
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
e403d51932
Change `rustc::*` to `rustc_middle::*` ( #798 )
2020-07-16 11:13:49 +09:00
3078d380cf
Resync config.toml and suggest better settings
2020-07-14 15:03:16 -05:00
2c49ec2367
Fix typos
2020-07-14 14:26:41 -05:00
37ab8da24d
Fix distortions of "representation"
2020-07-14 14:26:41 -05:00
f196779cbe
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
d3e682e590
Fix the difference of title in appendix A ( #793 )
2020-07-14 10:06:22 +09:00
3394e1696a
Earlier clarification of pFCP abbreviation ( #791 )
2020-07-12 10:29:17 +09:00
745c831429
Fix typo: review -> reviewer
2020-07-11 09:30:19 -05:00
b04ff74782
inluding -> including
2020-07-10 16:47:54 -05:00
954802cc68
Canonicalize part 1 name ( #788 )
2020-07-05 08:19:10 +09:00
f3339032d6
Suggest selectively disabling optimizations
2020-07-04 18:06:41 -05:00
eb07beaf8e
Update bug report links.
2020-07-04 13:09:55 -05:00
87b9ecf2bb
Fix link for armhf-gnu Dockerfile
2020-07-04 13:06:27 -05:00
689eca469d
Update docs on using Docker images.
2020-07-04 12:44:57 -05:00
2c51b6f628
Fix jump marker of debruijn index ( #783 )
2020-07-04 00:31:52 +09:00
30518e3df2
Minor updates to stage docs. ( #781 )
2020-07-04 00:28:44 +09:00
7a42bf2c92
add stub inline asm chapter ( #773 )
2020-07-03 07:37:29 +09:00
bd1801c8b9
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
b85f30d013
fix links
2020-07-01 22:07:52 -05:00
00b67a55de
Escape other non-link
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
c2c219af6c
Fix non-link
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
e82626f802
fix links
2020-07-01 22:07:52 -05:00
dbaa12ec12
fix links
2020-07-01 22:07:52 -05:00
431df827e2
line length
2020-07-01 22:07:52 -05:00
b1198eff6b
move CONTRIBUTING.md to rustc-dev-guide
2020-07-01 22:07:52 -05:00
0006f19915
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
fe7856889a
fix file name
2020-06-30 16:04:28 -05:00
99745b9931
Move Getting Started to a "prefix chapter"
2020-06-30 16:04:10 -05:00
fd4c83f4ab
Move Errors and Lints to Analysis
2020-06-30 16:03:50 -05:00
19f7d2e77d
Rename resolvers following the latest rustc change ( #776 )
2020-06-30 16:22:38 +02:00
2c6f17671f
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
be8c8bb7bc
Fix line lengths
2020-06-28 12:15:23 -05:00
1c68f636cf
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
c1c66a82f2
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
b7095995aa
Add 'recovery' to the gloassary
2020-06-27 11:05:32 -05:00
e7db51faca
Fix formatting
2020-06-24 21:38:54 -05:00
093b9032de
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
2e104620d1
Move x.py commands to overview
2020-06-23 17:40:16 -05:00
4329b8e91a
Split up rustdoc page
2020-06-23 17:40:16 -05:00
b8065faa0f
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
917f7efa28
Small spelling fix.
2020-06-23 12:44:15 -05:00
ca5591815c
address review comments
2020-06-23 12:42:06 -05:00
f85ef8ec94
Add prerequisite page
2020-06-23 12:42:06 -05:00
21ee99e5af
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
d103f0d897
Fix links for now.
2020-06-23 00:35:54 -05:00
34df55db77
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
a10ba12047
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
45e540ca81
new tykind::error convention ( #715 )
2020-06-19 07:55:58 +02:00
6c580ad664
fix line length
2020-06-18 12:16:00 -05:00
f880b1b21a
address a bunch of review comments
2020-06-18 12:16:00 -05:00
d90acc8e37
LeSeulArtichaut wording/typo fixes
...
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
c99d5245be
address review comments
2020-06-18 12:16:00 -05:00
46099c094e
Apply suggestions from code review
...
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
814d27d760
Better wording
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
e1c7b6ce92
Slightly reorganize to first present the slow command then the fast commands
2020-06-18 12:16:00 -05:00
db004ad24f
add a note about disk space
2020-06-18 12:16:00 -05:00
e72e2c5613
python 3 also
2020-06-18 12:16:00 -05:00
aa9b3ecc22
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
69baf677ef
add forge
2020-06-18 12:16:00 -05:00
5ff627e2d5
Apply suggestions from code review
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
5784b6cb92
add note on submodules
2020-06-18 12:16:00 -05:00
e2620a8199
add a bit more
2020-06-18 12:16:00 -05:00
2abbee9b5c
fix link
2020-06-18 12:16:00 -05:00
b5e41a5e0c
mention incremental disk space
2020-06-18 12:16:00 -05:00
73d88a1385
a couple more small changes
2020-06-18 12:16:00 -05:00
d255b4a0cb
some minor updates
2020-06-18 12:16:00 -05:00
ba2d73db5f
write about processes
2020-06-18 12:16:00 -05:00
c5c498ca19
address some review comments
2020-06-18 12:16:00 -05:00
324eb69950
Typo fixes
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
8fbc9f5241
start a getting started guide
2020-06-18 12:16:00 -05:00
708acbc72b
Add a link to the forge procedure on adding new options. ( #754 )
2020-06-18 10:33:15 +02:00
163efc6fcd
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
178e3052b2
Document rustdoc behavior
...
- `RUSTDOC_LOG`
- `// aux-build:filename.rs`
- `// build-aux-docs`
2020-06-17 09:24:41 -05:00
4228f46777
Add some more detail on compiletest normalization.
2020-06-16 23:14:05 -05:00
5371f13236
tag/niche terminology ( #747 )
2020-06-11 12:38:42 +02:00
3b1866b1ea
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
e647444811
Include "Lint" in the title of the diagnostics chapter ( #742 )
2020-06-10 15:19:59 -03:00
1a229d6d60
complete the ICE-breaker => notification group rename
2020-06-09 18:03:33 -05:00
089b82651d
add the ARM notification group ( #740 )
2020-06-09 23:58:22 +02:00
e349f81b22
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
42520d3ca8
Document needs-* compiletest directives
2020-06-08 12:33:35 -05:00
caac584a9e
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
8a9a1f935f
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
8c8130ed2d
braces
2020-06-05 10:34:56 -05:00
8f2e466f3c
words
2020-06-05 10:33:15 -05:00
7119767f69
Fix link ( #734 )
2020-06-05 17:10:01 +02:00
2c2fb3f05f
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
b381598b3f
Update lint declaration example ( #713 )
2020-05-30 08:49:25 +09:00
8a5438b4b1
Document more //ignore-X test headers
2020-05-29 13:27:03 -05:00
a6bace14e4
Document remote testing
2020-05-29 13:27:03 -05:00
55c92daeb6
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
c9850bb7d2
Update src/tests/adding.md
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-28 19:57:59 -05:00
8ca0464e65
add documentation of UI test error annotation substring support
2020-05-28 19:57:59 -05:00
6a54bc6dab
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
d7067f19d2
Clarify lint vs fixed diagnostic.
2020-05-27 20:33:46 -05:00
4d94eb902e
Updates from review.
2020-05-27 20:33:46 -05:00
1e8a467bc2
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
39edbe59ed
Add some guidelines on diagnostics.
2020-05-27 20:33:46 -05:00
aca2a716ea
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
54d64bd8ac
Fix typo
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-27 15:17:33 -05:00
8bb723c673
Add definition of `niche` to the glossary
2020-05-27 15:17:33 -05:00
6e2b70c9df
Move CLI to part 3.
2020-05-27 12:35:13 -05:00
ba1a8dfd35
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
fe96650d1a
Add some guidelines on the CLI.
2020-05-27 12:35:13 -05:00
6d5e0740f5
It looks like the high-level-overview was renamed ( #721 )
2020-05-28 00:04:56 +09:00
4295e7b578
Add section for debugging rustc type layouts ( #720 )
2020-05-27 14:17:39 +02:00
f53fc666ea
Rename `upvars` query to `upvars_mentioned`
2020-05-26 11:05:21 -05:00
c2561c4351
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
d10f70b005
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
59c9fa7b3e
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
266ab6e3a9
typo fix ( #706 )
2020-05-19 11:30:27 +09:00
7fb45e52e9
Add missing closing paren ( #705 )
2020-05-16 21:19:52 -04:00
8e126df6fe
Update src/appendix/glossary.md
...
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-05-11 23:52:00 +02:00
d7649f4b44
glossary: make soundness definition more readable
2020-05-11 23:52:00 +02:00
95420468b9
fix links ( #702 )
2020-05-11 16:51:33 -03:00
1caba74063
glossary: intro feels like not adding much ( #699 )
2020-05-11 07:57:46 +02:00
c386ec3d1a
Fix typo
2020-05-08 12:02:56 -05:00
b6d140f789
Typo
...
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
d1bb132780
add some section headers
2020-05-08 09:42:27 -05:00
1f6d127a70
move discussion of eager expansion to the end
2020-05-08 09:42:27 -05:00
9c7befcdd8
Use full path of span
...
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
2d639a3696
Typos
...
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
7e916519ed
fix some links
2020-05-08 09:42:27 -05:00
5dedd70447
fix line length
2020-05-08 09:42:27 -05:00
bc9c0e6c35
SPRINKLE ALL THE THINGS
2020-05-08 09:42:27 -05:00
a1cf766577
sprinkle around a bunch of links
2020-05-08 09:42:27 -05:00
f05ff9c30d
expand notes on expansion heirarchies
2020-05-08 09:42:27 -05:00
ba8620f34a
add a bit more info about eager exp
2020-05-08 09:42:27 -05:00
e8f918c0ba
expand some notes about expansion :P
2020-05-08 09:42:27 -05:00
0980ebf2c6
reorganize the macro expansion chapter
2020-05-08 09:42:27 -05:00
3f23b32c63
add note about macros in parser chapter
2020-05-08 09:42:27 -05:00
d62ed17895
reorder some chapters
2020-05-08 09:42:27 -05:00
6ee323dce3
add a bit to syntax intro
2020-05-08 09:42:27 -05:00
5d0cdc814a
add a bit to part 3 intro
2020-05-08 09:42:27 -05:00
b8935a916b
get rid of old todo
2020-05-08 09:42:27 -05:00
984d5a8b4d
finish going through discussion
2020-05-08 09:42:27 -05:00
ff2f232772
more notetaking
2020-05-08 09:42:27 -05:00
8bbe1ff044
start working through discussion
2020-05-08 09:42:27 -05:00
ee0059a6e2
some cleanup in the macros chapter
2020-05-08 09:42:27 -05:00
0a3ac2d34f
Reference complete examples
2020-05-07 17:30:27 -05:00
718047c647
Line length
2020-05-07 17:30:27 -05:00
7f394a5579
Example of getting diagnostics
2020-05-07 17:30:27 -05:00
6f79c282d8
Added link to the `ty::Adt` ( #696 )
...
* Added link to the `ty::Adt`
* Formatting fixes
Thanks @JohnTitor
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-07 23:44:39 +09:00
e1736cc9d0
typo
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-06 17:03:52 -05:00
32f3330167
add a bit more on parallel compilation
2020-05-06 17:03:52 -05:00
a8bb0c17f3
Fix example for winnowing
2020-05-02 21:23:21 -05:00
98e94be044
improve info regarding incremental a little
2020-05-01 09:18:42 -05:00
03282ca486
I confirmed this
2020-05-01 09:17:27 -05:00
26e0ae52dd
tidy
2020-04-30 21:25:29 -05:00
1b9f80cc40
Update src/queries/incremental-compilation.md
...
Removed `at`.
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-30 21:25:29 -05:00
c0ad843003
Hide link behind a clickable text
...
It currently does not appear as a clickable link here https://rustc-dev-guide.rust-lang.org/queries/incremental-compilation.html
Additionally, this is a particularly long and nasty link.
2020-04-30 21:25:29 -05:00
0b32573dd7
Minute formatting fix
2020-04-30 21:25:17 -05:00
622be10b7b
It's just ICE-breaker ( #685 )
2020-04-28 21:19:37 +02:00
36a06c0f25
Remove extra the
2020-04-27 15:45:00 -05:00
159cb7e700
Fix sub-diagnostic typo
2020-04-27 15:45:00 -05:00
f57f25dc45
remove info about diag ice breakers; doesn't exist yet ( #682 )
2020-04-25 16:23:59 -03:00
bdf565dba6
Address review comments.
...
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-04-25 06:57:48 -05:00
9d9eb150de
Fix links.
2020-04-25 06:57:48 -05:00
d79227e453
Address review comments.
2020-04-25 06:57:48 -05:00
cbbe9b423f
Fix links and CI error.
2020-04-25 06:57:48 -05:00
d596ab2bee
Remove details about chalk and point to Chalk Book instead.
2020-04-25 06:57:48 -05:00
1398a6fe9d
treat-err-as-bug=n means panic on nth error
2020-04-24 13:48:01 -05:00
cbd8d437da
Replace `rustc` with `rustc_middle` ( #680 )
2020-04-20 15:16:27 +02:00
a450260a5f
Typo
2020-04-19 13:08:39 -05:00
0ecf993367
review comments: move text to more relevant section
2020-04-19 13:08:39 -05:00
5d0f59959b
Add diagnostics ICE-breakers page
2020-04-19 13:08:39 -05:00
0daa3f7053
Fix typo ( #678 )
2020-04-19 17:54:45 +02:00
695e58d5ec
Apply suggestions from Zoxc
2020-04-18 20:58:14 -05:00
2154b85ca4
Apply feedback.
2020-04-18 20:58:14 -05:00
4840ad250b
Add documentation about incr. comp. query attributes and the projection query pattern.
2020-04-18 20:58:14 -05:00
bc5445760e
Fix some whitespace ( #677 )
2020-04-19 01:40:16 +09:00
e927db936f
Apply suggestions from code review
...
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
2020-04-18 11:11:33 -05:00
96e912e6a6
add link to intrinsic
2020-04-18 11:11:33 -05:00
8046502e80
Remove various todos
...
With some items added to https://github.com/rust-lang/rustc-dev-guide/issues/674
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
2020-04-18 11:11:33 -05:00
a578fc11c5
line length
2020-04-18 11:11:33 -05:00
5090bb8d0f
[overview.md] add lexer updates, parser updates
...
includes feedback from matklad (lexer) and centril (parser)
2020-04-18 11:11:33 -05:00
4eadacdf29
[overview.md] add initial parser documentation
2020-04-18 11:11:33 -05:00
68a9c1f605
fix links
2020-04-18 11:11:33 -05:00
Jade
Gus Wynn
Yuki Okushi
Ralf Jung
Michael Woerister
Eric Huss
Caleb Cartwright
Justus K
Rich Kadel
Smittyvb
二手掉包工程师
Camelid
Joshua Nelson
Nixon Enraght-Moony
Waffle Lapkin
AngelicosPhosphoros
JohnTitor
Santiago Pastorino
Léo Lanteri Thauvin
Wesley Wiser
Chayim Refael Friedman
Tomasz Miąsko
Daniel Santos
Hirochika Matsumoto
r00ster
dmezh
bstrie
pierwill
Yusuke Tanaka
Henry Boisdequin
Iñaki Garay
Martin Geisler
ashosive
saki-osive
saki-osive
Ryan Levick
Ryan Levick
Sebastian Widua
Laurențiu Nicola
Wesley Wiser
Siddharth
mark
jumbatm
Ben Striegel
Gabriel de Perthuis
cjkenn
hosseind88
Alexis Bourget
Olivier FAURE
Casey Rodarmor
Joshua Nitschke
Nadrieril
Joshua Nelson
Ivan Tham
1c3t3a
mautamu
Cass
Who? Me?!
Julian Wollersberger
Aleksey Kladov
Tshepang Lekhonkhobe
Camelid
Roman
Jakob Degen
follower
Shahar Or (mightyiam)
Youngsuk_Kim
Dániel Buga
Macdonald Umoren
Dylan MacKenzie
Monadic Cat
Aman Arora
Guillaume Gomez
Gurwinder Singh
Lzu Tao
Matthew Jasper
Takayuki Nakata
Jake Goulding
David Wood
Federico Ponzi
Felix S Klock II
Ivan Veselov
Matt Kraai
pierwill
Aaron Hill
Drew Youngwerth
Florian Gilcher
Andy Russell
ThePuzzlemaker
Niko Matsakis
Bastian Kauschke
Tom Eccles
Chris Simpkins
Chris Simpkins
Michael Bryan
Adam Perry
Paul Daniel Faria
Jade McGough
George Fraser
Hanif Ariffin
Charles Lew
Esteban Küber
Michael Woerister