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
Who? Me?!
mark
Gus Wynn
Julian Wollersberger
Aleksey Kladov
Santiago Pastorino
LeSeulArtichaut
Tshepang Lekhonkhobe
Camelid
Yuki Okushi
Camelid
Roman
Joshua Nelson
Jakob Degen
follower
Shahar Or (mightyiam)
Youngsuk_Kim
Dániel Buga
Macdonald Umoren
Dylan MacKenzie
Monadic Cat
Joshua Nelson
Rich Kadel
Aman Arora
Ivan Tham