295234161c
Fix broken links
2021-02-28 11:01:07 -05:00
47722b22e9
Document how to enable CI LLVM without using `x.py setup`
2021-02-26 15:38:01 -05:00
15c1f01c2f
Remove some unrelated changes
2021-02-26 15:38:01 -05:00
44f4197fa5
Fix typos
2021-02-26 15:38:01 -05:00
d6f81b211f
Restore instructions for using system LLVM
...
They were removed in #1030 , but are still useful.
2021-02-26 15:38:01 -05:00
4895d26d5e
Update some out-of-date information
2021-02-26 15:38:01 -05:00
7fde8950cf
Fixes typo in getting started guide
2021-02-24 21:20:36 -05:00
9539f6c271
Fix formatting of more date references ( #1067 )
2021-02-22 18:22:23 +09:00
b4b1fb0058
Fix broken links in query.md ( #1068 )
2021-02-21 09:51:34 +01:00
7f5a39d318
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
f7049a868c
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
4f0142ce11
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
50e53ccffa
Point to main branch on llvm-project's links
2021-02-19 20:25:36 -05:00
c6cf4c04da
Fix typo ( #1063 )
2021-02-18 19:37:43 +01:00
87b317f966
Update running.md
2021-02-17 17:13:07 -05:00
1ab6279cea
Add Oxide paper to bibliography
2021-02-15 10:14:03 -05:00
4f16f7cc1d
Fix typo
2021-02-07 22:12:28 -05:00
b0ff83f007
Fix typo in Bug Fix Procedure ( #1050 )
2021-02-07 11:15:54 -05:00
768f07b196
Add chapter on libs and metadata. ( #1044 )
2021-02-04 11:34:52 -05:00
6e02970f7f
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
2e19c8ecc0
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
f6e4a5f851
Update test suite descriptions. ( #1042 )
2021-01-30 20:12:01 +09:00
21745b2014
put `x.py` in ticks
2021-01-30 10:59:57 +02:00
470d5afe98
Update links to `librustc_llvm` and `rustllvm`
2021-01-24 08:18:34 -05:00
584ccc7608
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
7547e6af9a
Add missing period
2021-01-21 14:26:25 -05:00
53a45a9a19
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
7a80b01e01
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
d8d5bbcfe3
Link to `feature_err` in stability section ( #1022 )
2021-01-19 11:47:45 -08:00
b2d6a16e58
Fix typo ( #1027 )
2021-01-17 11:50:04 -03:00
403521f1b9
Note that `--check` now allows using any stage
2021-01-17 05:51:00 +02:00
4bb7ee493f
improved the readablity of a line
2021-01-16 12:04:07 -05:00
f7e62ecccb
Fixed a grammatical error in hardawre requirements section
2021-01-16 10:03:23 -05:00
eeb696d8a4
Corrected MIR file path and fixed a typo ( #1020 )
2021-01-14 14:10:08 -08:00
261ec50fa9
Add a note about UI test entry limitation ( #1019 )
2021-01-12 07:55:13 +09:00
cd437dc04f
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
296a37bf7b
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
afaa42043c
Point to `HirId` instead of `NodeId`
2021-01-09 21:05:10 -05:00
c16ce78347
Fix typo ( #1016 )
...
"currenty"!
2021-01-09 17:18:57 -08:00
1db26c008c
Break up long line
2021-01-05 16:13:58 -05:00
d01012ada8
Remove backticks and comment about possible bug
2021-01-05 16:13:58 -05:00
8a8bb49afa
Update src/compiler-debugging.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-05 16:13:58 -05:00
27174ca131
Make instructions for configuring compiler for debug more explicit
2021-01-05 16:13:58 -05:00
8bb02718e9
Remove old sentence that should have been removed
...
It was mistakenly not removed in #997 .
2021-01-04 22:43:03 -05:00
37a1ca9416
Fix "Potential incomplete link" error on compiler-debugging.md
2021-01-04 20:12:37 -05:00
5ca0f2dc26
Add link to rust-analyzer docs on getting started page
2021-01-04 10:09:49 -05:00
1b4d37b32b
Fix some typos
2021-01-04 10:02:33 -05:00
a0cdbb5675
Tweak wording around provider purity
2021-01-03 22:31:09 -05:00
d225a12cab
Fix typo (reflex -> reflect)
2021-01-02 09:25:03 -05:00
c74f970ae3
Clarify that `check` uses a different stage than `build` ( #999 )
2021-01-01 20:59:23 +00:00
8a8749228b
Fix broken link for `BoundRegion` ( #998 )
2020-12-31 01:13:49 +01:00
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
659281e739
Fix broken link in the contributing guide ( #996 )
2020-12-29 21:08:55 +01:00
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
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
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
cb0b7b64ee
Document `error-pattern` header ( #989 )
...
* Document `error-pattern` header
* Address some reviews
2020-12-12 16:06:30 +01:00
4e871ea1db
Fix some link failures and typos
2020-12-11 16:00:15 -05:00
a801509b43
All links to rustdoc-internals.md
2020-12-10 14:51:04 -05:00
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
a7c82e3ba9
Adds a dev guide section on Rust Coverage
2020-12-07 14:22:45 -05:00
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
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
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
b3fc04e298
fix a couple links
2020-12-03 00:06:19 -05:00
e98d87a670
Use shorter [][]-style link to not pass 100 chars.
2020-12-02 22:34:16 -06:00
dc31ca1ca8
Apply suggestions from review.
...
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-12-02 22:34:16 -06:00
0e7f5c08b1
Document SessionDiagnostic
2020-12-02 22:34:16 -06:00
d89703684b
Use shorter 'rustbot label' command
...
'rustbot modify labels: ...' -> 'rustbot label ...'
2020-12-01 13:56:48 -05:00
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
5661848ab9
Address feedback
2020-11-30 18:06:43 -05:00
680e35a172
Add notes about running the UI test suite
2020-11-30 18:06:43 -05:00
43fa1342f0
Document what 'sysroot' means
2020-11-29 20:02:55 -05:00
844ca6f14d
Don't imply that the name of the fork always needs to be changed
2020-11-29 10:42:20 -05:00
1f25130a83
Add information about common git issues
2020-11-29 10:42:20 -05:00
98fdbf9406
Fix a typo
2020-11-28 14:09:03 -05:00
5dce3301d4
Link to feature-stabilization docs
2020-11-26 20:43:36 -05:00
ff24e31a36
Move instructions for adding a feature gate to "Feature Gates"
2020-11-26 20:43:36 -05:00
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
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
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
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
49069a0233
add small explanation of why fuel can be useful for debugging
2020-11-22 08:43:00 -05:00
ed89d6f643
add mir-opt section for optimization fuel
2020-11-22 08:43:00 -05:00
b2a34704a6
add string interning wikipedia link ( #960 )
2020-11-15 12:14:06 -05:00
661ba74612
Provide a brief example of a data-flow analysis
2020-11-12 11:53:00 -05:00
3e4c0c70f2
Explain the purpose of the bottom value
2020-11-12 11:53:00 -05:00
6a4c0ee05f
Add a section on data-flow convergence
2020-11-12 11:53:00 -05:00
4b00bfb892
Links to htmldocck/@has/matches for searchability
2020-11-11 19:02:37 -05:00
7497da24ca
Update src/compiler-debugging.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-11 10:39:15 -05:00
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
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
79d3ceb2fa
Fix install command
2020-11-09 09:07:41 +02:00
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
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
3de0132a0d
Use `provide_both` link instead of `provide(_extern)`
2020-11-06 19:18:15 -06:00
17c77b296e
Use new-style mdBook internal links in glossary
2020-10-28 18:33:30 -04:00
5b6f343c87
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
bbcf9282ac
Fix broken tags in glossary
2020-10-28 18:33:30 -04:00
c2606a6d54
Small improvements ( #936 )
...
* Fix typo errros -> errors
* an -> a
* hir -> hir()
2020-10-27 19:34:28 +01:00
bec1897ef7
Add "ctxt" and `TyCtxt` to the glossary ( #937 )
2020-10-27 19:30:20 +01:00
e58307a28e
Clean up `compiletest` chapter ( #935 )
2020-10-26 11:58:00 +09:00
e55ee68ed0
Improve prerequisites section for Windows ( #934 )
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-26 08:15:21 +09:00
f0cd34e615
Explain lint renaming/removing
2020-10-22 20:41:09 -04:00
61feec113f
Add reference PRs for `r?` and `r+` comments ( #928 )
2020-10-21 23:53:32 +02:00
a6279510e2
Replace links to `buildbot2.r-l.o` with `bors.r-l.o`
2020-10-21 17:34:07 -04:00
ee849ff66e
Revert "Remove outdated build rustdoc --stage 1"
...
This reverts commit cd35d2b594
2020-10-19 23:17:17 -04:00
e4a7be5779
Remove outdated build rustdoc --stage 1
...
It builds with stage 1 by default.
2020-10-19 22:23:59 -04:00
269158b77e
Fix typo errros -> errors
2020-10-19 14:11:19 -04:00
d859c9924e
Explain why exhaustiveness is necessary for soundness
2020-10-16 18:26:10 -04:00
5ddfd9bfe9
Explain pattern exhaustiveness checking
2020-10-16 18:26:10 -04:00
2b1e754e83
Fix a link on git.md
2020-10-15 23:11:33 -04:00
5f06872226
Added description of word Scrutinee to the glossary ( #921 )
2020-10-13 01:57:18 +09:00
66649d9c81
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-10 12:12:44 -04:00
eee78ac90f
Talk about git submodules
2020-10-10 12:12:44 -04:00
d056730692
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
1ae9303960
Update more occurrences of system llvm link
2020-10-08 11:47:32 -04:00
ac6fb7efa1
Fix broken "system LLVM" link
2020-10-08 11:47:32 -04:00
db41bec0c9
Fix typos ( #916 )
...
Fixed two typos.
2020-10-08 16:19:56 +09:00
9ccc69f152
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
5fabea540a
Document `Assemble`
2020-10-04 11:59:58 -04:00
fcc93a7043
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
3b4462f582
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
42173ef770
address lingering reviewer comments
2020-10-04 10:14:22 -04:00
08d244e06c
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-04 10:14:22 -04:00
58255429d8
add note
2020-10-04 10:14:22 -04:00
c3a67e32dc
add suggested workflow to setup nightly rustup for rustc
2020-10-04 10:14:22 -04:00
9a46f17fab
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
476dd40f63
Document the usage of cargo-llvm-lines and -Ztimings.
2020-10-04 10:12:47 -04:00
d1651dbd5e
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
773b3c3e95
hir_map -> hir()
2020-10-03 19:38:38 -05:00
efb9029fc8
Fix time periods for Triage WG procedure
2020-10-03 19:25:05 -05:00
c63a20ccbf
Update src/getting-started.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
d3f37158ac
Update src/getting-started.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
ff894213a7
Add a paragraph about reviewers and review latency in Getting Started chapter
2020-10-03 19:25:05 -05:00
b431d8211c
Use HTTPS whenever possible in bibliography links ( #909 )
...
Also updated a few links that redirected.
2020-10-03 22:56:29 +02:00
b61231e905
Fix the report link
2020-10-03 16:12:04 -04:00
d9a98418f7
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
62ae93b3a3
add the last missing code highlight to t-compiler in the docs
2020-10-02 12:37:27 +02:00
1c59aa9409
Fix typo
2020-09-30 22:39:25 +02:00
7f590fa025
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
fb23f10071
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
7fdae85e96
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
915fabf4cc
--verbose is useful when not compiling and when compiling ( #901 )
2020-09-29 17:18:00 +02:00
506f2e77c1
Use implicit reference links for shorter lines
...
(As suggested by jyn514.)
2020-09-27 10:37:22 -04:00
e2a1deb657
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
1e77d7f743
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
edc31ef0bc
Add docs for x.py setup
2020-09-27 04:24:18 +02:00
3ac6fc75ef
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
2ad2cb7c97
correct output path in Writing Documentation
2020-09-26 08:45:48 -04:00
18c7583466
update link to 'BorrowKind' to be implicit in markdown
2020-09-25 22:55:49 -04:00
49611100bf
add link to 'BorrowKind' in closure.md
2020-09-25 22:55:49 -04:00
06fdc4321e
update description of 'ByRef' borrows of closures
2020-09-25 22:55:49 -04:00
a0958b664c
minor punctuation/grammar error fix
2020-09-25 22:55:49 -04:00
b7970e6c5e
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
727a536ba9
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
7609eb11ee
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
ca00e2eefe
`ConstEvalResult` is now `EvalToConstValueResult` ( #885 )
...
Also fixed typo.
2020-09-22 22:52:05 +02:00
9c5e356ed5
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
27ff56d829
Fix typo in table of contents
2020-09-17 11:35:14 -04:00
0a80107e34
Revert "Mention that places are sometimes called "lvalues""
...
This reverts commit bf5e1c451d
2020-09-17 11:35:14 -04:00
e645304ce9
Mention that places are sometimes called "lvalues"
2020-09-17 11:35:14 -04:00
fd525a93d6
More improvements
2020-09-17 11:35:14 -04:00
231e3d9c83
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
7bda848e3c
debug-logging=true instead of debug-assertions=yes
2020-09-16 21:56:05 -04:00
42be58a751
Add link for `AnalysisDomain::NAME`
2020-09-16 00:21:55 -04:00
ca60ec06df
Describe how to generate graphviz diagrams for dataflow
2020-09-16 00:21:55 -04:00
9f4e7038fa
Remove EN1
2020-09-15 18:13:33 -04:00
a7d0f3f2dd
Complete text about salsa base inputs
2020-09-15 18:13:33 -04:00
6cf849f63b
Add Salsa In More Depth lecture
2020-09-15 18:13:33 -04:00
0d2b8eb1c4
Fix typo
...
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-09-14 17:42:19 -05:00
e6a94b2355
Make the HIR chapter point to the new chapter on IDs
2020-09-14 17:42:19 -05:00
c7ec4769ab
Apply suggestions from code review
...
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-14 17:42:19 -05:00
fe19fc65f2
Add a chapter on all the identifiers used through `rustc`
2020-09-14 17:42:19 -05:00
1fffd48313
Update `Visitor` and `Cursor` examples
2020-09-13 15:58:02 -04:00
ddc23efa5f
Line edits
2020-09-13 15:58:02 -04:00
0cc3a9f8f3
Add missing link to `Engine`
2020-09-13 15:58:02 -04:00
3db7809e77
Initial draft of MIR dataflow framework docs
2020-09-13 15:58:02 -04:00
3b5a774a61
correct attribute used here
2020-09-12 18:41:06 -04:00
7e42258f16
Address nits
2020-09-12 13:12:14 -05:00
01c34848a3
Note that the default is 2015
2020-09-12 13:12:14 -05:00
71853f5a5c
Document edition flag for UI tests
2020-09-12 13:12:14 -05:00
eb39e07c58
Fix typo
2020-09-12 12:07:04 -04:00
5ff253c02a
Hide `@rustdoc` implementation details
2020-09-12 12:07:04 -04:00
ab47942c65
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
ade9b19f51
Update src/rustbot.md
2020-09-12 12:07:04 -04:00
9f396a3f1e
Update src/rustbot.md
2020-09-12 12:07:04 -04:00
317a5b33a4
Update src/contributing.md
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-12 12:07:04 -04:00
28ca77209b
Update src/contributing.md
2020-09-12 12:07:04 -04:00
a9264c50d6
Add a chapter on useful `@rustbot` commands
2020-09-12 12:07:04 -04:00
2ac4ba41ef
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
4a8945792e
Fix typo
...
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-11 13:42:39 +02:00
57794fe4dc
Apply suggestions from code review
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-11 13:42:39 +02:00
d26f268757
Clean up 'Contributing to Rust - Pull Requests'
2020-09-11 13:42:39 +02:00
81f52ce0db
Fix other library commands
2020-09-10 23:56:41 -04:00
86e02cda81
Fix incorrect docs about stages
...
`build library/core` builds the compiler, not just the standard library.
2020-09-10 23:56:41 -04:00
f0d769ea49
Add back information about Googling
...
Also cleaned up some other things.
2020-09-09 22:58:18 -04:00
53a9cde26c
Add back comma
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 22:58:18 -04:00
38d726f367
Add more info about Rustdoc
2020-09-09 22:58:18 -04:00
dd3b2059b6
Update "Helpful Links" section
2020-09-09 22:58:18 -04:00
185f43c746
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
350ee4b260
Minor cleanup for "How to build and run"
2020-09-09 20:58:30 -04:00
ca3b0a5571
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
f3b5db1057
Fix nit
2020-09-09 21:39:55 +02:00
dc0cff54bb
Update src/building/new-target.md
2020-09-09 21:39:55 +02:00
059ad38ddf
Document how to promote a target from cross-compiled to hosted
2020-09-09 21:39:55 +02:00
3d0543b644
Update src/queries/profiling.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 12:30:56 -04:00
2d1322d62e
Update def_id.rs location
2020-09-09 12:30:56 -04:00
8638351e9d
Fix typo, hellow -> hello
2020-09-09 12:30:56 -04:00
6d3eb2bc75
Add ./ to run x.py
2020-09-09 12:30:56 -04:00
6dd6d868e5
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
808774289f
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
8623da3dab
Add information about default stages for x.py
2020-09-09 11:05:26 -04:00
794b32feac
Fix typo
2020-09-09 16:58:05 +02:00
45f6000c37
Document speculative crate loading ( #859 )
2020-09-09 10:19:01 +03:00
60f15f096e
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
1b40f033d2
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
cc121cd4c5
Document CGU partioning in case of generic and inline functions
2020-09-07 10:07:40 -04:00
68407cbe37
Update src/building/how-to-build-and-run.md
2020-09-07 08:55:08 -04:00
5fac3dca3d
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
33efb2a2ab
Rename src/rustc to compiler/rustc
2020-09-06 16:21:08 +02:00
4ce4873606
update docs to refer to the move
2020-09-03 19:25:02 -04:00
1519df6945
Fix dep-graph-caller-callee test location
2020-09-03 16:21:30 +02:00
7b4ab23cc7
Adds documentation to cover spanview output
...
Documents the feature introduced in #76074 .
2020-09-02 12:39:47 +02:00
4411cf2001
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
f6b1f9d49d
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
b3e17b1b1f
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-31 05:12:13 +02:00
54ffd393c9
fix typos
2020-08-31 05:12:13 +02:00
b361ef92ac
fix line lengths
2020-08-31 05:12:13 +02:00
89f0b60ccc
fix links and names after compiler mv to compiler/
2020-08-31 05:12:13 +02:00
cd2f461d9c
nits
2020-08-26 08:07:52 -04:00
51da18c90d
Apply review suggestion
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-26 13:13:14 +02:00
014d434f46
Clarify section on MIR construction
2020-08-26 13:13:14 +02:00
a49fce9a12
Add new section to have a local HTTP server easily ( #833 )
2020-08-23 14:36:45 +02:00
9b803e1dfe
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
908d4ff483
Remove duplicate MIR chapter entry ( #830 )
2020-08-19 11:46:02 +00:00
776e14a3f0
Document how to use build task for x.py check ( #828 )
2020-08-17 23:10:29 +09:00
8effbe65b6
Link ref to edge concept in graph theory
2020-08-17 09:00:47 -04:00
369ec46a1b
Remove unneeded hashmarks ( #826 )
...
Co-authored-by: Joshua Nelson <jyn514@gmail.com>
2020-08-17 04:51:37 +09:00
0ecf777a50
Address revuew comments
2020-08-16 14:14:35 -05:00
281526c5a2
Document serialization in rustc
2020-08-16 14:14:35 -05:00
463489182d
Some small fixes ( #823 )
...
* Fix some typos
* Update from `typeck_tables_of` to `typeck`
* Fix comment
2020-08-11 19:36:48 -04:00
5462868f4b
Use angle brackets to turn URL into a link
2020-08-04 09:50:19 -04:00
68daabb4bf
Fix typo
2020-08-04 09:50:19 -04:00
1fd664124d
Fix a broken link
2020-08-04 09:50:19 -04:00
f24f0b15e0
Enable a link
2020-08-04 09:50:19 -04:00
574f709928
Some small fixes
2020-08-03 11:07:57 -05:00
cb87579a2f
Fix typo
2020-08-03 11:07:57 -05:00
e7b3cd7f6a
Fix: crates -> a list of crates
2020-08-03 11:07:57 -05:00
ff9814cc3c
Avoid "whitelist"
...
Fixed according to 62cf767a4a
2020-08-03 11:07:57 -05:00
9522f3e934
Prefer `::` than `.`
2020-08-02 23:16:01 -05:00
65770bcd1f
Fix link/wording for `parse_nt`
2020-08-02 23:16:01 -05:00
14c2f80da2
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
a8eab86aa0
some updates after std libs move
2020-08-02 19:44:04 -05:00
c693f66a8e
Typo
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
8e76708b6c
mention the overview chapter
2020-08-02 19:44:04 -05:00
12bf5b4747
Link to overview ch instead of internals
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-08-02 19:44:04 -05:00
e10dbb8586
missing link
2020-08-02 19:44:04 -05:00
a9024bd3b2
add a bit more discussion of big picture
2020-08-02 19:44:04 -05:00
a1ef8389eb
fix typo
2020-08-02 19:44:04 -05:00
63a0c1f3da
line length
2020-08-02 19:44:04 -05:00
3852cb1592
rewrite/update compiler source code chapter
2020-08-02 19:44:04 -05:00
f31532d3b2
Mention `HAIR` to clarify
2020-08-02 08:39:33 -05:00
8a3e706aca
Rename `HAIR` to `THIR`
2020-08-02 08:39:33 -05:00
9c351189e9
Adjust mentions about CI to GitHub Actions
2020-08-02 08:38:26 -05:00
68a2b034c5
Rename `src/libstd` to `library/std` etc. ( #815 )
2020-07-30 22:47:22 +09:00
38aef99f68
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
879ca582de
Update docs to match the new x.py defaults ( #813 )
2020-07-29 04:20:00 +09:00
593facff2a
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
a99182921c
Fix MIR to LLVM IR sentence ( #811 )
2020-07-28 05:03:37 +09:00
50706fc2a2
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
bc72178000
Fix links for cranelift ( #809 )
2020-07-22 19:32:21 +09:00
ed2e2b1d3f
Fixes menu for rustdoc page ( #804 )
2020-07-18 19:18:06 +09:00
9085f687dd
Clean-up minor issues ( #802 )
2020-07-18 00:00:34 +09:00
aca4e6b2a4
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
973ced6951
Change `rustc::*` to `rustc_middle::*` ( #798 )
2020-07-16 11:13:49 +09:00
a93d729018
Resync config.toml and suggest better settings
2020-07-14 15:03:16 -05:00
bda916e75d
Fix typos
2020-07-14 14:26:41 -05:00
1e14491218
Fix distortions of "representation"
2020-07-14 14:26:41 -05:00
a03162ec35
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
e2389e57d8
Fix the difference of title in appendix A ( #793 )
2020-07-14 10:06:22 +09:00
87554a233a
Earlier clarification of pFCP abbreviation ( #791 )
2020-07-12 10:29:17 +09:00
a744c0ae04
Fix typo: review -> reviewer
2020-07-11 09:30:19 -05:00
e17cf59c30
inluding -> including
2020-07-10 16:47:54 -05:00
e89e5fecc5
Canonicalize part 1 name ( #788 )
2020-07-05 08:19:10 +09:00
6889dcc7d5
Suggest selectively disabling optimizations
2020-07-04 18:06:41 -05:00
20e080bf38
Update bug report links.
2020-07-04 13:09:55 -05:00
85b8077831
Fix link for armhf-gnu Dockerfile
2020-07-04 13:06:27 -05:00
401d0bf12b
Update docs on using Docker images.
2020-07-04 12:44:57 -05:00
45fb510957
Fix jump marker of debruijn index ( #783 )
2020-07-04 00:31:52 +09:00
434631397b
Minor updates to stage docs. ( #781 )
2020-07-04 00:28:44 +09:00
f86c34e7d7
add stub inline asm chapter ( #773 )
2020-07-03 07:37:29 +09:00
0fd8abe5bf
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
27b9565b71
fix links
2020-07-01 22:07:52 -05:00
92cbc030cd
Escape other non-link
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
d3c6f899cb
Fix non-link
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-01 22:07:52 -05:00
6bc1c18282
fix links
2020-07-01 22:07:52 -05:00
638073deb1
fix links
2020-07-01 22:07:52 -05:00
6796449f88
line length
2020-07-01 22:07:52 -05:00
60b8d21d5c
move CONTRIBUTING.md to rustc-dev-guide
2020-07-01 22:07:52 -05:00
431c3a3be2
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
3d657229ad
fix file name
2020-06-30 16:04:28 -05:00
342c4b7ba9
Move Getting Started to a "prefix chapter"
2020-06-30 16:04:10 -05:00
3e6097db7e
Move Errors and Lints to Analysis
2020-06-30 16:03:50 -05:00
38d14755b3
Rename resolvers following the latest rustc change ( #776 )
2020-06-30 16:22:38 +02:00
d18ab7154a
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
089dd18f03
Fix line lengths
2020-06-28 12:15:23 -05:00
e4d6bfe303
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
38e0461def
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
e362fdc8c7
Add 'recovery' to the gloassary
2020-06-27 11:05:32 -05:00
7884fdfdb0
Fix formatting
2020-06-24 21:38:54 -05:00
32c4f1aa61
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
541f88e8dd
Move x.py commands to overview
2020-06-23 17:40:16 -05:00
bf38f1b6f8
Split up rustdoc page
2020-06-23 17:40:16 -05:00
ee73a81989
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
cb950b77e8
Small spelling fix.
2020-06-23 12:44:15 -05:00
93c21dd722
address review comments
2020-06-23 12:42:06 -05:00
59e5e68074
Add prerequisite page
2020-06-23 12:42:06 -05:00
20d3370db9
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
98a67dc23b
Fix links for now.
2020-06-23 00:35:54 -05:00
c398a14f33
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
8011445536
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
92fafef00a
new tykind::error convention ( #715 )
2020-06-19 07:55:58 +02:00
8017824161
fix line length
2020-06-18 12:16:00 -05:00
b5864347d0
address a bunch of review comments
2020-06-18 12:16:00 -05:00
d94394322b
LeSeulArtichaut wording/typo fixes
...
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
d4056d0820
address review comments
2020-06-18 12:16:00 -05:00
b24d9eb1fa
Apply suggestions from code review
...
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18 12:16:00 -05:00
28ccf26223
Better wording
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
4250a4030a
Slightly reorganize to first present the slow command then the fast commands
2020-06-18 12:16:00 -05:00
d829ce6f9b
add a note about disk space
2020-06-18 12:16:00 -05:00
0acd363057
python 3 also
2020-06-18 12:16:00 -05:00
b7e8d5f398
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
c6766dfb7c
add forge
2020-06-18 12:16:00 -05:00
e492cf389b
Apply suggestions from code review
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
5e2d3c35ed
add note on submodules
2020-06-18 12:16:00 -05:00
3bedf5c442
add a bit more
2020-06-18 12:16:00 -05:00
a9a82c4420
fix link
2020-06-18 12:16:00 -05:00
1f0f15f380
mention incremental disk space
2020-06-18 12:16:00 -05:00
6e482fb047
a couple more small changes
2020-06-18 12:16:00 -05:00
96a7a9a49c
some minor updates
2020-06-18 12:16:00 -05:00
7942336575
write about processes
2020-06-18 12:16:00 -05:00
655b6ba886
address some review comments
2020-06-18 12:16:00 -05:00
78e224ca52
Typo fixes
...
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18 12:16:00 -05:00
4cbb4c384e
start a getting started guide
2020-06-18 12:16:00 -05:00
7c51350dfc
Add a link to the forge procedure on adding new options. ( #754 )
2020-06-18 10:33:15 +02:00
b5be6012f6
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
7e3da5c2ee
Document rustdoc behavior
...
- `RUSTDOC_LOG`
- `// aux-build:filename.rs`
- `// build-aux-docs`
2020-06-17 09:24:41 -05:00
6d921020b6
Add some more detail on compiletest normalization.
2020-06-16 23:14:05 -05:00
4c48d4c0eb
tag/niche terminology ( #747 )
2020-06-11 12:38:42 +02:00
a50d9c590a
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
78b302c3a9
Include "Lint" in the title of the diagnostics chapter ( #742 )
2020-06-10 15:19:59 -03:00
a7a83e664d
complete the ICE-breaker => notification group rename
2020-06-09 18:03:33 -05:00
df8ee5af1f
add the ARM notification group ( #740 )
2020-06-09 23:58:22 +02:00
d152893e86
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
df23757b09
Document needs-* compiletest directives
2020-06-08 12:33:35 -05:00
98d000fb3c
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
e74b4ab3a4
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
f9c6c1b117
braces
2020-06-05 10:34:56 -05:00
c9f49c6581
words
2020-06-05 10:33:15 -05:00
138c73f545
Fix link ( #734 )
2020-06-05 17:10:01 +02:00
c4590c0644
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
6b85d54752
Update lint declaration example ( #713 )
2020-05-30 08:49:25 +09:00
01f01823ed
Document more //ignore-X test headers
2020-05-29 13:27:03 -05:00
d56a31f73c
Document remote testing
2020-05-29 13:27:03 -05:00
2b3522a840
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
1036ac82ed
Update src/tests/adding.md
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-28 19:57:59 -05:00
154e750ec5
add documentation of UI test error annotation substring support
2020-05-28 19:57:59 -05:00
f086b737ef
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
3bb5fc53b5
Clarify lint vs fixed diagnostic.
2020-05-27 20:33:46 -05:00
000f04e2f9
Updates from review.
2020-05-27 20:33:46 -05:00
9befa0d9cc
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
5ae9e9191e
Add some guidelines on diagnostics.
2020-05-27 20:33:46 -05:00
cf38ea60b2
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
bc9d1d0d76
Fix typo
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-27 15:17:33 -05:00
fc379a898f
Add definition of `niche` to the glossary
2020-05-27 15:17:33 -05:00
865e5542ad
Move CLI to part 3.
2020-05-27 12:35:13 -05:00
3d077bb26e
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
8f7abbdf41
Add some guidelines on the CLI.
2020-05-27 12:35:13 -05:00
e4c502318f
It looks like the high-level-overview was renamed ( #721 )
2020-05-28 00:04:56 +09:00
a3287df2ad
Add section for debugging rustc type layouts ( #720 )
2020-05-27 14:17:39 +02:00
523e300c04
Rename `upvars` query to `upvars_mentioned`
2020-05-26 11:05:21 -05:00
85d815d11d
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
c777d434f5
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
9272d05ea7
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
78cf9b2ba1
typo fix ( #706 )
2020-05-19 11:30:27 +09:00
05aee3ef6c
Add missing closing paren ( #705 )
2020-05-16 21:19:52 -04:00
bd6a1ae84d
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
37322a7f26
glossary: make soundness definition more readable
2020-05-11 23:52:00 +02:00
dc7ffdecc3
fix links ( #702 )
2020-05-11 16:51:33 -03:00
c740ef0a26
glossary: intro feels like not adding much ( #699 )
2020-05-11 07:57:46 +02:00
dcf75a8e60
Fix typo
2020-05-08 12:02:56 -05:00
d7f14b5093
Typo
...
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
692e2799ce
add some section headers
2020-05-08 09:42:27 -05:00
67ab79a722
move discussion of eager expansion to the end
2020-05-08 09:42:27 -05:00
09c665aa12
Use full path of span
...
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
f4824c83c3
Typos
...
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-05-08 09:42:27 -05:00
09a6c18ccb
fix some links
2020-05-08 09:42:27 -05:00
79c7718b63
fix line length
2020-05-08 09:42:27 -05:00
5f5e48f5bd
SPRINKLE ALL THE THINGS
2020-05-08 09:42:27 -05:00
5ab21a1318
sprinkle around a bunch of links
2020-05-08 09:42:27 -05:00
6fee71e345
expand notes on expansion heirarchies
2020-05-08 09:42:27 -05:00
c53e21fdb9
add a bit more info about eager exp
2020-05-08 09:42:27 -05:00
1471e109c2
expand some notes about expansion :P
2020-05-08 09:42:27 -05:00
07b7e2c65b
reorganize the macro expansion chapter
2020-05-08 09:42:27 -05:00
4e3759adb8
add note about macros in parser chapter
2020-05-08 09:42:27 -05:00
0bb8093581
reorder some chapters
2020-05-08 09:42:27 -05:00
1e41004cbf
add a bit to syntax intro
2020-05-08 09:42:27 -05:00
325d0a00f4
add a bit to part 3 intro
2020-05-08 09:42:27 -05:00
5ade22c7fc
get rid of old todo
2020-05-08 09:42:27 -05:00
1d92a6a465
finish going through discussion
2020-05-08 09:42:27 -05:00
543f5eaa93
more notetaking
2020-05-08 09:42:27 -05:00
e5dff9e753
start working through discussion
2020-05-08 09:42:27 -05:00
2b43588de7
some cleanup in the macros chapter
2020-05-08 09:42:27 -05:00
3a5328d4f7
Reference complete examples
2020-05-07 17:30:27 -05:00
1ac14631e8
Line length
2020-05-07 17:30:27 -05:00
d0702a0b3b
Example of getting diagnostics
2020-05-07 17:30:27 -05:00
ebd97c81b5
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
40bb43d2d1
typo
...
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-06 17:03:52 -05:00
10c6b7a749
add a bit more on parallel compilation
2020-05-06 17:03:52 -05:00
e5dbc6f534
Fix example for winnowing
2020-05-02 21:23:21 -05:00
5aad3d043d
improve info regarding incremental a little
2020-05-01 09:18:42 -05:00
c518e9d49d
I confirmed this
2020-05-01 09:17:27 -05:00
c035c846ec
tidy
2020-04-30 21:25:29 -05:00
68aa2de832
Update src/queries/incremental-compilation.md
...
Removed `at`.
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-30 21:25:29 -05:00
16229dd3af
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
2b6a77ea0a
Minute formatting fix
2020-04-30 21:25:17 -05:00
a056d24ef6
It's just ICE-breaker ( #685 )
2020-04-28 21:19:37 +02:00
abd9ddb16b
Remove extra the
2020-04-27 15:45:00 -05:00
1bb6b0937f
Fix sub-diagnostic typo
2020-04-27 15:45:00 -05:00
ed380c3b77
remove info about diag ice breakers; doesn't exist yet ( #682 )
2020-04-25 16:23:59 -03:00
024e7f366d
Address review comments.
...
Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-04-25 06:57:48 -05:00
0895f6eca0
Fix links.
2020-04-25 06:57:48 -05:00
37ffada957
Address review comments.
2020-04-25 06:57:48 -05:00
4b1b22464f
Fix links and CI error.
2020-04-25 06:57:48 -05:00
7d843fcd4f
Remove details about chalk and point to Chalk Book instead.
2020-04-25 06:57:48 -05:00
1b0f87c8dc
treat-err-as-bug=n means panic on nth error
2020-04-24 13:48:01 -05:00
07c46e7dcf
Replace `rustc` with `rustc_middle` ( #680 )
2020-04-20 15:16:27 +02:00
7f78165cb5
Typo
2020-04-19 13:08:39 -05:00
4266d9d902
review comments: move text to more relevant section
2020-04-19 13:08:39 -05:00
d738fed623
Add diagnostics ICE-breakers page
2020-04-19 13:08:39 -05:00
9cf06ca801
Fix typo ( #678 )
2020-04-19 17:54:45 +02:00
ede5d97881
Apply suggestions from Zoxc
2020-04-18 20:58:14 -05:00
d4c57c9269
Apply feedback.
2020-04-18 20:58:14 -05:00
2f9724f4a3
Add documentation about incr. comp. query attributes and the projection query pattern.
2020-04-18 20:58:14 -05:00
5cf8fea638
Fix some whitespace ( #677 )
2020-04-19 01:40:16 +09:00
262237683d
Apply suggestions from code review
...
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
2020-04-18 11:11:33 -05:00
38927a594e
add link to intrinsic
2020-04-18 11:11:33 -05:00
6b521a2504
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
034cb09659
line length
2020-04-18 11:11:33 -05:00
25227a8314
[overview.md] add lexer updates, parser updates
...
includes feedback from matklad (lexer) and centril (parser)
2020-04-18 11:11:33 -05:00
276d2b6268
[overview.md] add initial parser documentation
2020-04-18 11:11:33 -05:00
a1f86d6af8
fix links
2020-04-18 11:11:33 -05:00
bf6c05c005
add intrinsics to glossary
2020-04-18 11:11:33 -05:00
cd8801485f
minor wording change on bootstrapping
2020-04-18 11:11:33 -05:00
160e142616
update mono entry points
2020-04-18 11:11:33 -05:00
a12e9e31a3
[overview.md] add documentation of lexer support for Unicode encoding
2020-04-18 11:11:33 -05:00
18d695aa13
correct entry points for codegen
2020-04-18 11:11:33 -05:00
5cc816afd2
some cleanup
2020-04-18 11:11:33 -05:00
8600655969
add entry points for type check and type inference
...
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
3bf10201ac
add a para on interning and arenas
2020-04-18 11:11:33 -05:00
85533c23ff
[overview.md] add parser entry point links
2020-04-18 11:11:33 -05:00
27e440e369
fix lexer entry point
2020-04-18 11:11:33 -05:00
79eec5bc6c
Improve wording
...
Co-Authored-By: Santiago Pastorino <spastorino@gmail.com>
2020-04-18 11:11:33 -05:00
ba961af42f
add an entry point
2020-04-18 11:11:33 -05:00
ff3f073ad3
remove a todo
2020-04-18 11:11:33 -05:00
14eb19f2b9
fix links
2020-04-18 11:11:33 -05:00
256a690b7c
line lengths
2020-04-18 11:11:33 -05:00
b496d8de63
add a few todos
2020-04-18 11:11:33 -05:00
29765d08d8
write a bit about bootstrapping
2020-04-18 11:11:33 -05:00
5c27142364
add a note on tcx name
2020-04-18 11:11:33 -05:00
dd2fa1b863
break long sentence
2020-04-18 11:11:33 -05:00
b7c0121552
Improve description of MIR
...
Co-Authored-By: Centril <twingoow@gmail.com>
2020-04-18 11:11:33 -05:00
edcf8ab931
correct the note about HAIR
2020-04-18 11:11:33 -05:00
1424834cd1
mention token stream as an IR
2020-04-18 11:11:33 -05:00
cc49d816bc
mention the hair
2020-04-18 11:11:33 -05:00
a37e554d42
Add some entry points
...
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
fdb20d6801
fix old rustc-dev-guide links
2020-04-18 11:11:33 -05:00
5f43e74c25
Update src/overview.md
...
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
72a378bcfc
Update src/overview.md
...
Co-Authored-By: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-04-18 11:11:33 -05:00
0ed7c0a7f3
[overview.md] Add command line argument parsing, lexer stages, and parser outline
2020-04-18 11:11:33 -05:00
1775a945aa
Apply Centril suggestions
...
Co-Authored-By: Centril <twingoow@gmail.com>
2020-04-18 11:11:33 -05:00
91ae0ab7e0
correct a few links
2020-04-18 11:11:33 -05:00
4272a80c38
add overview
2020-04-18 11:11:33 -05:00
3b6defe682
Start with the basics ( #675 )
...
* The very first step should be to clone the repository
* Make the command copy-able
By having the plain command users can select and copy the text and paste
it, without needing to fiddle around to remove extra characters.
Now that the previous command switched directories it is not necessary
to be called out here again either.
* Update src/building/how-to-build-and-run.md
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-04-17 21:16:56 +09:00
61f246ef7c
codegen tests: add link to LLVM FileCheck docs ( #673 )
2020-04-12 02:34:25 +09:00
620878ba6b
Add section describing source file checksums in debug info
2020-04-08 15:50:31 -05:00
4c9670a6c2
fix a link ( #672 )
2020-04-08 08:52:05 +02:00
50910ad220
mark-i-m review edits
2020-04-07 12:11:56 -05:00
8021d3e707
consistent section title casing
2020-04-07 12:11:56 -05:00
1ab6693c00
update about-this-guide.md with new Guide sections
2020-04-07 12:11:56 -05:00
10a4d76ecd
Reorganize the guide ( #651 )
...
* start on guide reorg
* backend intro
* part 2, 3, 4 intros
* some missing files
* Fix typos
Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
* add links from intro
* rename compiler source chapter and add placeholder for overview
* rename parts, mv rustc_driver to part 3, make syntax chapter
* update part intros
* add syntax ch intro
* address review comments
* Better overview chapter placeholder
Co-Authored-By: Chris Simpkins <git.simpkins@gmail.com>
* fix link
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
2020-04-06 13:23:34 -03:00
e2ea943091
Remove duplicate trait reference entry from glossary, fix alphabetical sorting
2020-04-06 10:41:28 -05:00
277da2317e
Rework commit message
2020-04-05 12:49:29 -05:00
4c24f41e0a
Note that the invocation now are aliases
2020-04-05 12:49:29 -05:00
0cd5910a37
Change ICE-breaker ping to use the aliases
...
Related to rust-lang/rust#69949
2020-04-05 12:49:29 -05:00
fa8048117c
Wrap link in borrow_check.md to satify line length checks
2020-04-05 12:46:22 -05:00
ef8048d986
Add ids to all glossary items, make existing glossary links point to glossary, add links for def id in query.md
2020-04-05 12:46:22 -05:00
858b0440a9
remove stupid-stats, and some references to removed API
2020-04-04 13:36:17 -05:00
a05591ab58
add pre-requisite for calling into compiler API ( #663 )
2020-04-04 09:37:39 +02:00
Yuki Okushi
Camelid
Daniel Santos
Hirochika Matsumoto
r00ster
dmezh
bstrie
pierwill
Yusuke Tanaka
Eric Huss
Joshua Nelson
Henry Boisdequin
LeSeulArtichaut
Iñaki Garay
Martin Geisler
ashosive
saki-osive
saki-osive
Ryan Levick
Ryan Levick
Sebastian Widua
Laurențiu Nicola
Wesley Wiser
Nixon Enraght-Moony
Rich Kadel
Siddharth
mark
jumbatm
Ben Striegel
Gabriel de Perthuis
cjkenn
hosseind88
Alexis Bourget
Olivier FAURE
Casey Rodarmor
Joshua Nitschke
Santiago Pastorino
Nadrieril
Joshua Nelson
Ivan Tham
1c3t3a
Justus K
mautamu
Cass
Who? Me?!
Gus Wynn
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
Ralf Jung
Niko Matsakis
Tomasz Miąsko
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
Jan-Erik Rediger
Arlo Siemsen