0ff2326425
Fix extra slash
2023-04-16 13:30:24 +02:00
6337ed17fb
fix markup ( #1670 )
2023-04-10 23:23:05 +09:00
516194c5e8
Link to governance page
...
It has links to the specific channel/stream for each team.
2023-04-09 22:38:15 +02:00
8bf09013c0
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
177ca5e602
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
2d2ef1329a
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
0ccf85aa5b
Fix link; remove duplicate link
2023-04-09 22:38:15 +02:00
3780fbf5e4
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
c87993ba74
Clarify cfg(bootstrap) docs
2023-04-09 21:38:54 +02:00
26315eb365
document that it's rare for books to break
2023-04-09 21:20:55 +02:00
d483584b37
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
4d14b76152
fix incorrect miri mentions in "External Repos" chapter
2023-04-09 21:20:55 +02:00
40823ca392
Improve the landing page for contributing to the libstd docs ( #1666 )
2023-04-09 12:10:27 +09:00
cf4daae9a6
Various improvements to `check_line_lengths.sh` ( #1667 )
2023-04-09 12:08:46 +09:00
c869139156
Document how to ignore specific files in a diff ( #1668 )
2023-04-09 12:07:16 +09:00
0520099156
fix line length
2023-04-05 19:29:18 -05:00
b141161991
mention `git clone --depth`
2023-04-05 19:29:18 -05:00
fca8af6c15
add a few more TOC sections
2023-04-03 06:42:31 -05:00
3cd6d38426
Remove duplicate section on new features in CONTRIBUTING.md
2023-04-03 06:42:31 -05:00
8fc85f17ef
Link to bug-fix-procedure.md from the contribution procedure section
2023-04-03 06:42:31 -05:00
2ff743c00b
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
3790dd62b9
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
33c6ea1e8c
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
d436bf134e
Make REUSE ignore section heading as a copyright statement ( #1659 )
2023-04-03 20:09:34 +09:00
a071dc8c54
Update some links and information for cargo-bisect-rustc ( #1657 )
2023-04-02 15:15:55 +09:00
513a1e4299
update rustc_driver examples ( #1655 )
2023-04-01 09:35:35 -04:00
5eca47362a
bootsrapping stages overview list
2023-03-23 15:36:00 +02:00
8a94e36e0d
Update labels overview ( #1639 )
2023-03-21 18:07:36 +09:00
3b6a1bdb2c
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
9bdc3996c3
Add SIP solution for macOS users ( #1636 )
2023-03-21 17:50:39 +09:00
7cef03afaf
Reword to include 'distractions'
2023-03-16 18:40:40 -07:00
acfe07ccbf
Mention debug assertions label
2023-03-16 18:40:40 -07:00
a65b9c7b0c
Mention debug assertions
2023-03-16 18:40:40 -07:00
b17ff13083
Address review comments
2023-03-16 18:40:40 -07:00
34d85e1af8
mir-opt*-level*, not mir-opt
2023-03-16 18:40:40 -07:00
435af1971e
Address review comments
2023-03-16 18:40:40 -07:00
939720e1c6
Add chapter on fuzzing
2023-03-16 18:40:40 -07:00
7153b94fc1
Fix "Crate disambiguator" in libs-and-metadata.md
2023-03-16 11:11:46 +02:00
60402a753a
alert when date gets stale (by using date-check annotation)
2023-03-14 05:50:20 +02:00
8307567617
fix date-check annotation some more
2023-03-14 05:50:20 +02:00
77d01ca1f5
fix date-check annotation
2023-03-14 05:50:20 +02:00
87afef07e7
typo
2023-03-14 05:50:20 +02:00
b51fa3c654
Update rustdoc-internals.md
2023-03-14 05:50:20 +02:00
b1b6d693cd
Rename `config.toml.example` to `config.example.toml`
2023-03-13 04:42:00 +02:00
f9d24b3a5b
fix typo `SubstRef` to `SubstsRef`
2023-03-12 11:40:45 +02:00
e7fdb91611
improve accuracy
2023-03-10 09:04:21 +02:00
477309b6bb
tracing log along diff crates
2023-03-10 09:04:21 +02:00
8a87736cf1
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
c1d92ca068
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
ce834a2763
improve capacity note ( #1634 )
2023-03-06 22:08:37 +09:00
7e50a6ab47
Remove mention to lexer/parser refactoring
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:41:21 +02:00
d1d6ce85e6
Update date reference about infer context variables
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:39:11 +02:00
4597bb4226
Update explnation about `Body.basic_blocks`
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:25:20 +02:00
82e50a669a
Add detail to contributing guide ( #1628 )
2023-03-03 20:14:53 +09:00
62f03c2085
Making the sentence more clear ( #1624 )
2023-03-03 20:13:46 +09:00
b684e3532f
Fixed typing error ( #1623 )
2023-03-03 20:13:18 +09:00
2d0681e13f
update error code docs to reflect recent changes ( #1625 )
2023-03-03 20:12:51 +09:00
b06dab8408
Fixed typing errors ( #1622 )
2023-02-27 07:30:52 +09:00
9d769136ee
this remains true ( #1620 )
2023-02-21 23:12:14 +09:00
a7d960359a
diagnostics: small fixes/improvements ( #1618 )
2023-02-21 22:57:34 +09:00
d01441ded0
typo ( #1616 )
2023-02-21 22:57:16 +09:00
ea01bf508c
typo ( #1617 )
2023-02-21 22:56:16 +09:00
110275f990
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
095f27d62a
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
1efd0adb82
bootstrap now creates a usable toolchain when building stage0 std
2023-02-19 13:43:56 +01:00
99b6b92dde
llvm 13 is now not supported ( #1612 )
2023-02-18 22:20:46 +09:00
84b9f4d99a
Vetting deps datecheck ( #1614 )
2023-02-18 22:20:08 +09:00
5173d1fb28
accept review suggestion
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-02-18 14:10:03 +02:00
727941feae
fmt
2023-02-18 14:10:03 +02:00
b328f82882
add Dev Desktops note
2023-02-18 14:10:03 +02:00
8715e8f6e8
fix and clarify llvm bugfix policy ( #1611 )
2023-02-18 20:46:21 +09:00
6f536e44bc
impl review suggestion
...
See https://github.com/rust-lang/rustc-dev-guide/pull/1605#discussion_r1110388310
2023-02-18 05:04:44 +02:00
64f1af18f5
lower-case "Compiler" in headings, for consistency (and looks)
2023-02-18 05:04:44 +02:00
1a721616c9
Explain what the rest of the backend agnostic page is about
2023-02-18 03:54:02 +02:00
1f4d6ac25e
accept review suggestion
...
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2023-02-17 13:38:10 -08:00
4e8110ceb2
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
ed87804535
rustc_codegen_ssa feels permanent enough not to need date-check
2023-02-17 13:38:10 -08:00
c80a26fc4d
make use of the symlink, to ease things ( #1608 )
2023-02-17 14:37:01 -06:00
fdacc773e0
remove stray text ( #1604 )
2023-02-16 19:33:05 -08:00
df7970bf0d
Typo
2023-02-16 07:26:00 +02:00
4a86a8dd74
Typo
2023-02-16 07:24:32 +02:00
74afdfc2f3
Add link to vscode settings in Rust repo ( #1591 )
2023-02-15 15:46:19 -03:00
d0ee17f100
avoid code duplication by including files in docs ( #1598 )
2023-02-15 11:41:35 -03:00
77aaf99897
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
c9e4cb704c
typo ( #1600 )
...
Fixes #1599
2023-02-15 11:02:38 -03:00
82257c2705
use actual names ( #1594 )
2023-02-14 15:44:23 +09:00
5eb8171f0b
Fix a typo ( #1597 )
2023-02-14 15:43:48 +09:00
2ab6fbca7c
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
df5aee0e60
Improve git submodule help ( #1587 )
2023-02-09 19:08:26 +09:00
33ea559131
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
ed5b175ef3
Replace settings.json with x.py setup note ( #1588 )
2023-02-08 14:26:58 -06:00
0591410a01
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
2d1e71ac8b
update bootstrap guide ( #1583 )
...
Signed-off-by: ozkanonur <work@onurozkan.dev>
2023-02-04 16:53:38 -06:00
5c65222d4c
Use host symlink for custom rustup toolchain
2023-02-04 01:01:48 +02:00
d579acb697
Fix broken relative links
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02:00
bf4cdde66b
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
860162abfe
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
e0074c18f0
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
d30be86ea6
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
d8c298da43
Update explnation about benchmarks
...
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-02-03 06:23:25 +02: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