a4ea4aa4a1
Fix extra slash
2023-04-16 13:30:24 +02:00
414d4c8ce2
fix markup ( #1670 )
2023-04-10 23:23:05 +09:00
d2ec8cd362
Link to governance page
...
It has links to the specific channel/stream for each team.
2023-04-09 22:38:15 +02:00
df1d869b36
Apply suggestions from code review
...
Thank you JohnTitor for finding these!
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-04-09 22:38:15 +02:00
65541fee89
Add a "What should I work on?" section
...
This is the first question I get from nearly all contributors. So far
I've been giving links to individual issues, but they quickly go out of
date or get fixed, and then I have more work to do to help people find
an issue. Add some suggestions for work people can find themselves,
without having to first consult an expert.
This also moves the "Cloning and Building" stub to the bottom of the
page.
2023-04-09 22:38:15 +02:00
e32c45adea
Make the "Asking Questions" section more useful
...
- Update outdated chat platforms
- Link to the community page
- Suggest `git shortlog` for finding experts
2023-04-09 22:38:15 +02:00
a5f0310ba4
Fix link; remove duplicate link
2023-04-09 22:38:15 +02:00
b6e5e27f3a
Move "Getting Started" to the first page
...
This page is better suited for people landing immediately from
CONTRIBUTING.md, or who haven't heard of the guide before. "About This
Guide" is still useful, but doesn't need to be the very first page.
2023-04-09 22:38:15 +02:00
bea76af07d
Clarify cfg(bootstrap) docs
2023-04-09 21:38:54 +02:00
ff78970088
document that it's rare for books to break
2023-04-09 21:20:55 +02:00
558a4f3d06
Remove detailed toolstate section
...
This is already covered in detail on Forge: https://forge.rust-lang.org/infra/toolstate.html
and linked in the previous paragraph.
2023-04-09 21:20:55 +02:00
54a87876bd
fix incorrect miri mentions in "External Repos" chapter
2023-04-09 21:20:55 +02:00
e379577fd0
Improve the landing page for contributing to the libstd docs ( #1666 )
2023-04-09 12:10:27 +09:00
c6cd62cf77
Various improvements to `check_line_lengths.sh` ( #1667 )
2023-04-09 12:08:46 +09:00
088c7fec78
Document how to ignore specific files in a diff ( #1668 )
2023-04-09 12:07:16 +09:00
297817bf1f
fix line length
2023-04-05 19:29:18 -05:00
42b4a3b105
mention `git clone --depth`
2023-04-05 19:29:18 -05:00
1fd8ddbdc2
add a few more TOC sections
2023-04-03 06:42:31 -05:00
945da7bd13
Remove duplicate section on new features in CONTRIBUTING.md
2023-04-03 06:42:31 -05:00
161b9b3beb
Link to bug-fix-procedure.md from the contribution procedure section
2023-04-03 06:42:31 -05:00
92102e0e8c
Rearrange the "getting started" and contributing.md sections
...
There was a lot of information duplicated between the two, and it wasn't
clear which one to look. This commit changes `contributing.md` to be
strictly for contribution procedures, and moves "what should I work on"
sections to "Getting Started".
This also consolidates the links in `about-this-guide.md` rather than
spreading them between about-this-guide, getting-started, and
contributing.
I suggest using https://rustc-dev-guide.org/git.html#moving-large-sections-of-code to review this commit.
2023-04-03 06:42:31 -05:00
cdd2e49a7a
Outline the external repositories section
...
This is advanced info that most contributors won't need to know; and for
experienced contributors, it means the info is at the top of the page
instead of needing to scroll.
2023-04-03 06:42:31 -05:00
774a20130a
Move some info from "Getting Started" to "How to build and run"
...
"Getting Started" is already *very* long; this shrinks it a bit, and
puts similar info closer together.
2023-04-03 06:42:31 -05:00
030739585a
Make REUSE ignore section heading as a copyright statement ( #1659 )
2023-04-03 20:09:34 +09:00
0cb6011623
Update some links and information for cargo-bisect-rustc ( #1657 )
2023-04-02 15:15:55 +09:00
7cb957b26f
update rustc_driver examples ( #1655 )
2023-04-01 09:35:35 -04:00
266ca693c0
bootsrapping stages overview list
2023-03-23 15:36:00 +02:00
ccef9cb8e1
Update labels overview ( #1639 )
2023-03-21 18:07:36 +09:00
ed855b1a00
first mention of type, and add a link ( #1643 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-03-21 17:55:42 +09:00
e6289be8dc
Add SIP solution for macOS users ( #1636 )
2023-03-21 17:50:39 +09:00
69dbbd548d
Reword to include 'distractions'
2023-03-16 18:40:40 -07:00
0a4cfa8e4b
Mention debug assertions label
2023-03-16 18:40:40 -07:00
2848aadbff
Mention debug assertions
2023-03-16 18:40:40 -07:00
f49ec954c5
Address review comments
2023-03-16 18:40:40 -07:00
d09a940816
mir-opt*-level*, not mir-opt
2023-03-16 18:40:40 -07:00
5de7dd6e4f
Address review comments
2023-03-16 18:40:40 -07:00
5531ed7c5e
Add chapter on fuzzing
2023-03-16 18:40:40 -07:00
f946bd407f
Fix "Crate disambiguator" in libs-and-metadata.md
2023-03-16 11:11:46 +02:00
82a5c6d47b
alert when date gets stale (by using date-check annotation)
2023-03-14 05:50:20 +02:00
1ffcb23bbc
fix date-check annotation some more
2023-03-14 05:50:20 +02:00
fa092136c0
fix date-check annotation
2023-03-14 05:50:20 +02:00
ea585370c8
typo
2023-03-14 05:50:20 +02:00
ba285c2370
Update rustdoc-internals.md
2023-03-14 05:50:20 +02:00
31991ba0cb
Rename `config.toml.example` to `config.example.toml`
2023-03-13 04:42:00 +02:00
c5ec776f41
fix typo `SubstRef` to `SubstsRef`
2023-03-12 11:40:45 +02:00
060b7a17dc
improve accuracy
2023-03-10 09:04:21 +02:00
1b7cd1e2bf
tracing log along diff crates
2023-03-10 09:04:21 +02:00
88a1bdd470
Fix Rust Analyzer settings location
...
This file was moved in https://github.com/rust-lang/rust/pull/108618
2023-03-08 00:21:21 +02:00
70e8b3e396
Reflect the changes in rust-lang/rust#67000 ( #1632 )
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-06 14:22:07 -03:00
cee03b4dc3
improve capacity note ( #1634 )
2023-03-06 22:08:37 +09:00
b46fe5900b
Remove mention to lexer/parser refactoring
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:41:21 +02:00
77e9a17a1d
Update date reference about infer context variables
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:39:11 +02:00
d8c874e31b
Update explnation about `Body.basic_blocks`
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:25:20 +02:00
6b2d30b2e5
Add detail to contributing guide ( #1628 )
2023-03-03 20:14:53 +09:00
a5d3282c90
Making the sentence more clear ( #1624 )
2023-03-03 20:13:46 +09:00
30ea647281
Fixed typing error ( #1623 )
2023-03-03 20:13:18 +09:00
25b0c633d5
update error code docs to reflect recent changes ( #1625 )
2023-03-03 20:12:51 +09:00
53e87016e1
Fixed typing errors ( #1622 )
2023-02-27 07:30:52 +09:00
052fe68fb2
this remains true ( #1620 )
2023-02-21 23:12:14 +09:00
1d826b01ef
diagnostics: small fixes/improvements ( #1618 )
2023-02-21 22:57:34 +09:00
ec33573db8
typo ( #1616 )
2023-02-21 22:57:16 +09:00
c7256e75c0
typo ( #1617 )
2023-02-21 22:56:16 +09:00
74a6d8d10a
keep "grey area" lint summary green ( #1619 )
...
This replaces link to a removed lint with a link to discussion of lints
of its type.
2023-02-20 19:08:35 -06:00
d3bee3c76d
new solver: write canonicalization chapter ( #1595 )
...
* write canonicalization chapter first half
* w
* review
* very good section
* whatever
* review
* ok
2023-02-20 14:45:25 +00:00
54fe64b775
bootstrap now creates a usable toolchain when building stage0 std
2023-02-19 13:43:56 +01:00
45eb9121e0
llvm 13 is now not supported ( #1612 )
2023-02-18 22:20:46 +09:00
c1de1a3127
Vetting deps datecheck ( #1614 )
2023-02-18 22:20:08 +09:00
6db1c189d7
accept review suggestion
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-02-18 14:10:03 +02:00
0086a2d437
fmt
2023-02-18 14:10:03 +02:00
092afc35aa
add Dev Desktops note
2023-02-18 14:10:03 +02:00
bd0f0b77b8
fix and clarify llvm bugfix policy ( #1611 )
2023-02-18 20:46:21 +09:00
a326b2525f
impl review suggestion
...
See https://github.com/rust-lang/rustc-dev-guide/pull/1605#discussion_r1110388310
2023-02-18 05:04:44 +02:00
fcd74f99a3
lower-case "Compiler" in headings, for consistency (and looks)
2023-02-18 05:04:44 +02:00
279f92f50a
Explain what the rest of the backend agnostic page is about
2023-02-18 03:54:02 +02:00
a5046f57db
accept review suggestion
...
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2023-02-17 13:38:10 -08:00
8d9c533ac3
address review comment
...
See
- https://github.com/rust-lang/rustc-dev-guide/pull/1606#discussion_r1109298849
- https://github.com/rust-lang/rustc-dev-guide/pull/1606#discussion_r1109298280
2023-02-17 13:38:10 -08:00
fc16473321
rustc_codegen_ssa feels permanent enough not to need date-check
2023-02-17 13:38:10 -08:00
4ccbe9182c
make use of the symlink, to ease things ( #1608 )
2023-02-17 14:37:01 -06:00
19f6cc82a5
remove stray text ( #1604 )
2023-02-16 19:33:05 -08:00
4308463e70
Typo
2023-02-16 07:26:00 +02:00
51aaeee90d
Typo
2023-02-16 07:24:32 +02:00
41680031f8
Add link to vscode settings in Rust repo ( #1591 )
2023-02-15 15:46:19 -03:00
03dd097bb0
avoid code duplication by including files in docs ( #1598 )
2023-02-15 11:41:35 -03:00
1827e0c1b3
Add sample CodeLLDB launch.json ( #1482 )
...
* Add sample CodeLLDB launch.json
There is a section with [instructions for setting up source analyzer in VSCode](https://rustc-dev-guide.rust-lang.org/building/suggested.html#configuring-rust-analyzer-for-rustc ), but
nothing for setting up debugging with CodeLLDB. This adds a sample configuration
that may not be ideal, but appears to work for me.
To source highlight the snippet, uses JavaScript instead of JSON so that comments
do not show up as errors highlighted in red (VSCode allows comments).
* Update src/compiler-debugging.md
Co-authored-by: jyn <github@jyn.dev>
* Update src/compiler-debugging.md
Co-authored-by: jyn <github@jyn.dev>
---------
Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
Co-authored-by: jyn <github@jyn.dev>
2023-02-15 11:31:02 -03:00
aba825cf33
typo ( #1600 )
...
Fixes #1599
2023-02-15 11:02:38 -03:00
55c5b384b6
use actual names ( #1594 )
2023-02-14 15:44:23 +09:00
9f02d33a1c
Fix a typo ( #1597 )
2023-02-14 15:43:48 +09:00
b4689c9511
Add Neovim configuration information ( #1545 )
...
* Add Neovim configuration information
The JSON provided for VSCode works with coc and nlsp-settings.
This is verified by
9d8bdb9290/README.md215b537cfb/schemas/_generated/rust_analyzer.json
2023-02-13 23:16:01 -06:00
2b94321e3d
Improve git submodule help ( #1587 )
2023-02-09 19:08:26 +09:00
342f72310d
update examples for rustc 1.69.0-nightly (e1eaa2d5d 2023-02-06) ( #1590 )
...
Closes https://github.com/rust-lang/rustc-dev-guide/issues/1581
2023-02-09 18:56:06 +09:00
b4c465275c
Replace settings.json with x.py setup note ( #1588 )
2023-02-08 14:26:58 -06:00
5471f42f11
Fixed small grammar mistake in monomorph.md ( #1585 )
...
Fixes https://github.com/rust-lang/rustc-dev-guide/issues/1584
2023-02-05 17:28:48 +09:00
347b3633f1
update bootstrap guide ( #1583 )
...
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-02-04 16:53:38 -06:00
69ef8a3924
Use host symlink for custom rustup toolchain
2023-02-04 01:01:48 +02:00
0e4e3ab221
Fix broken relative links
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
56c7d9f97c
Address the change in https://github.com/rust-lang/rust/pull/99715
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
6ea7b0db51
Address the change in https://github.com/rust-lang/rust/pull/106718
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
6213fc1cf5
Address the change in https://github.com/rust-lang/rust/pull/97287
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
f13eeec25a
Address the change in https://github.com/rust-lang/rust/pull/107256
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
f663d1aa06
Update explnation about benchmarks
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
313e8e913c
Add param_env and wording
2023-02-02 10:23:24 +02:00
ca4b002450
Expand section basedd on review comments
2023-02-02 10:23:24 +02:00
083a9a9d09
Add section on comparing types
2023-02-02 10:23:24 +02:00
118246c17e
Update rustfmt path
...
As per https://github.com/rust-lang/rust/pull/107297#discussion_r1092764740 , the change broke the rust-analyzer config. Hence, changing the docs to match the new path
2023-02-01 18:59:30 -06:00
343194d258
fix wrong heading level ( #1573 )
2023-02-01 07:29:15 +09:00
f0dbe6cec7
fix incorrect position of topic
...
Right now "Clarification of build command's stdout" topic
shows up under the "Environment Variables" which is not correct.
This commit aims to fix this problem.
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-01-31 22:57:27 +02:00
375adf22dc
extend bootstrap related documentations
...
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-01-31 12:42:30 -06:00
5edc03f6ad
New infcx usage ( #1571 )
...
Fixes https://github.com/rust-lang/rustc-dev-guide/issues/1543
2023-01-31 00:08:16 +09:00
7353fd14ee
Apply suggestions from code review
...
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-01-29 20:58:11 +02:00
914b409125
Update ast-validation.md
2023-01-29 20:58:11 +02:00
ccce1437bc
update datecheck
2023-01-27 15:03:01 -08:00
7a5772a172
review
2023-01-27 15:03:01 -08:00
ba035fb554
line length
2023-01-27 15:03:01 -08:00
020898a81c
Update src/solve/canonicalization.md
...
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-01-27 15:03:01 -08:00
17d68d8412
review
2023-01-27 15:03:01 -08:00
1e2f272560
Update src/solve/canonicalization.md
...
Co-authored-by: Boxy <supbscripter@gmail.com>
2023-01-27 15:03:01 -08:00
f7caa2f553
fix line lengths
2023-01-27 15:03:01 -08:00
9899cf3c43
add section for the new trait solver
2023-01-27 15:03:01 -08:00
ac46c61184
version 5 is now not supported ( #1568 )
2023-01-27 19:09:37 +09:00
c0342ec589
there are still no locale bundles ( #1567 )
2023-01-27 07:52:25 +09:00
710cc3eb66
bumpt date-check examples to current month ( #1566 )
2023-01-27 07:51:28 +09:00
e8b989eb3b
Update hir.md
...
Fix method name and the link, as it's outdated.
2023-01-25 17:29:12 +02:00
e38fa37202
fix review suggestion
2023-01-21 16:12:58 +02:00
8b24a1e9bd
accept review suggestion
...
Co-authored-by: lcnr <rust@lcnr.de>
2023-01-21 16:12:58 +02:00
05d22ebd50
rustc_typeck exists no more
2023-01-21 16:12:58 +02:00
c7064daba1
Correct tests misplacement ( #1564 )
...
Since the tests move, this was not correct anymore.
2023-01-20 11:18:15 -03:00
4583b43b6b
Update resolution.md ( #1561 )
2023-01-18 07:46:14 +09:00
d003669ae5
Update asm.md ( #1560 )
2023-01-17 21:44:19 +09:00
c58e6d14df
fix examples for rustc 1.68.0-nightly (935dc0721 2022-12-19) ( #1556 ) ( #1557 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Closes https://github.com/rust-lang/rustc-dev-guide/issues/1556
2023-01-15 05:34:23 +09:00
589841c29d
Update incremental-compilation-in-detail.md ( #1553 )
...
Co-authored-by: Michael Woerister <michaelwoerister@users.noreply.github.com>
2023-01-14 12:37:03 +09:00
c154a90ec5
Link to the youtube recording of my talk, not the summary ( #1554 )
2023-01-13 07:46:15 +09:00
d4ec98736e
Change `src/test` to `tests` ( #1547 )
2023-01-13 07:31:47 +09:00
03902fe1f0
add full name for ICE ( #1552 )
...
Co-authored-by: Yuki Okushi <huyuumi.dev+love@gmail.com>
2023-01-11 22:25:53 +09:00
2d23cff5fc
Fix incorrect links ( #1549 )
2023-01-10 22:00:49 +09:00
e574dadba0
fix rebase link
2023-01-10 08:17:59 +02:00
48ef16204c
Add a section for how to review code more easily ( #1538 )
...
- How to hide whitespace
- Fetching PRs without having to add a new remote or copy-paste the URL of the author's fork
- How to review large blocks that have moved
- Suggest `git range-diff`. This section is still mostly incomplete; fixing an exact command that will work seems kinda tricky and I don't currently have time for it.
2023-01-02 15:35:09 -08:00
3b35c4e040
fix typo
...
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-12-31 23:20:47 -06:00
3093967547
Give help for when you update a submodule by accident
2022-12-31 23:20:47 -06:00
a1418a804c
Update sentence about LLVM to match the new defaults
2022-12-31 23:20:21 -06:00
91d2393626
Move information about dependencies to the rust-lang/rust readme
...
This avoids having to maintain the information in two places.
2022-12-31 23:20:21 -06:00
966d6e97a7
Move "create a config.toml" after the section explaning x.py
2022-12-31 23:20:21 -06:00
b36e2ff71d
Remove unnecessary detail in building chapter
...
Most of these details were not helpful or necessary for building the compiler for the first time.
This section comes very early in the guide and is meant to be a tutorial, so being concise is very important.
2022-12-31 23:20:21 -06:00
84eea0d580
Remove initial section on submodules
...
It's not necessary and it takes up valuable space at the very start of the guide.
2022-12-31 23:20:21 -06:00
bd26e3aae5
Replace `$TARGET` with `host`
...
This avoids having to manually modify the configuration in the docs.
2022-12-31 18:23:52 -06:00
7f9af30e5f
Use `origin` consistently and add an example of rebasing over the wrong remote
2022-12-29 11:39:24 -06:00
d318386762
Add more rebasing help
2022-12-29 11:39:24 -06:00
9a67713d99
Fix rustc_borrowck crate name typo ( #1535 )
2022-12-25 21:11:21 +09:00
faf9268f07
Apply feedback
2022-12-18 00:41:27 +02:00
43cd55066d
Add -Ztrack-diagnostics information
2022-12-18 00:41:27 +02:00
44e95ec592
Add documentation for LLVM KCFI support ( #1529 )
...
This commit adds initial documentation for LLVM Kernel Control Flow
Integrity (KCFI) support to the Rust compiler (see rust-lang/rust#105109
and rust-lang/rust#89653 ).
2022-12-14 12:20:53 +01:00
Ohad Ravid
Tshepang Mbambo
Joshua Nelson
jyn
y21
Pietro Albini
Eric Huss
Shahar Dawn Or
Yukang
Langston Barrett
Hoblovski
Michael Howell
Thom Chiovoloni
Yutaro Ohno
bohan
clubby789
Yuki Okushi
apiraino
Mika
Ezra Shaw
lcnr
The 8472
Noah Lev
Michele
AE1020
Christopher Smyth
Hiroki Fujino
Ciel
Onur
Nixon Enraght-Moony
nils
Zephaniah Ong
Denis Belik
Yang Pan
Albert Larsan
gftea
Albert Larsan
Mu00
oskgo
Joshua Nelson
Dan Mezhiborsky
mejrs
Ramon de C Valle