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
Roman
Joshua Nelson
Jakob Degen
Santiago Pastorino
follower
Shahar Or (mightyiam)
Youngsuk_Kim
Dániel Buga
Camelid
Camelid
Macdonald Umoren
Dylan MacKenzie
LeSeulArtichaut
Monadic Cat
Tshepang Lekhonkhobe
Gus Wynn
Joshua Nelson
Rich Kadel
Aman Arora
Ivan Tham
Who? Me?!
mark
Guillaume Gomez
Gurwinder Singh
Yuki Okushi
Aleksey Kladov
Lzu Tao
Matthew Jasper
Takayuki Nakata
Jake Goulding
David Wood
Federico Ponzi
Felix S Klock II
Ivan Veselov
Matt Kraai
Nadrieril
Eric Huss