mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
2,075 Commits 3 Branches 0 Tags 114 MiB
Commit Graph

2075 Commits

Author SHA1 Message Date
Tshepang Mbambo 6337ed17fb
fix markup (#1670) 2023-04-10 23:23:05 +09:00
Joshua Nelson 516194c5e8 Link to governance page 
It has links to the specific channel/stream for each team.
 2023-04-09 22:38:15 +02:00
jyn 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
jyn 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
jyn 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
jyn 0ccf85aa5b Fix link; remove duplicate link 2023-04-09 22:38:15 +02:00
jyn 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
jyn c87993ba74 Clarify cfg(bootstrap) docs 2023-04-09 21:38:54 +02:00
jyn 26315eb365 document that it's rare for books to break 2023-04-09 21:20:55 +02:00
jyn 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
jyn 4d14b76152 fix incorrect miri mentions in "External Repos" chapter 2023-04-09 21:20:55 +02:00
jyn 40823ca392
Improve the landing page for contributing to the libstd docs (#1666) 2023-04-09 12:10:27 +09:00
jyn cf4daae9a6
Various improvements to `check_line_lengths.sh` (#1667) 2023-04-09 12:08:46 +09:00
jyn c869139156
Document how to ignore specific files in a diff (#1668) 2023-04-09 12:07:16 +09:00
y21 0520099156 fix line length 2023-04-05 19:29:18 -05:00
y21 b141161991 mention `git clone --depth` 2023-04-05 19:29:18 -05:00
Joshua Nelson fca8af6c15 add a few more TOC sections 2023-04-03 06:42:31 -05:00
Joshua Nelson 3cd6d38426 Remove duplicate section on new features in CONTRIBUTING.md 2023-04-03 06:42:31 -05:00
Joshua Nelson 8fc85f17ef Link to bug-fix-procedure.md from the contribution procedure section 2023-04-03 06:42:31 -05:00
Joshua Nelson 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
Joshua Nelson 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
Joshua Nelson 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
Pietro Albini d436bf134e
Make REUSE ignore section heading as a copyright statement (#1659) 2023-04-03 20:09:34 +09:00
Eric Huss a071dc8c54
Update some links and information for cargo-bisect-rustc (#1657) 2023-04-02 15:15:55 +09:00
Tshepang Mbambo 513a1e4299
update rustc_driver examples (#1655) 2023-04-01 09:35:35 -04:00
Nathan Hammond d08baa166b
Add locale_resources (#1651) 2023-03-26 12:55:53 -05:00
jyn b4e778a5f6
Don't require $GITHUB_TOKEN to build locally (#1652) 2023-03-27 00:28:07 +09:00
Shahar Dawn Or 5eca47362a bootsrapping stages overview list 2023-03-23 15:36:00 +02:00
Eric Huss 8a94e36e0d
Update labels overview (#1639) 2023-03-21 18:07:36 +09:00
Tshepang Mbambo 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
Yukang 9bdc3996c3
Add SIP solution for macOS users (#1636) 2023-03-21 17:50:39 +09:00
Langston Barrett 7cef03afaf Reword to include 'distractions' 2023-03-16 18:40:40 -07:00
Langston Barrett acfe07ccbf Mention debug assertions label 2023-03-16 18:40:40 -07:00
Langston Barrett a65b9c7b0c Mention debug assertions 2023-03-16 18:40:40 -07:00
Langston Barrett b17ff13083 Address review comments 2023-03-16 18:40:40 -07:00
Langston Barrett 34d85e1af8 mir-opt*-level*, not mir-opt 2023-03-16 18:40:40 -07:00
Langston Barrett 435af1971e Address review comments 2023-03-16 18:40:40 -07:00
Langston Barrett 939720e1c6 Add chapter on fuzzing 2023-03-16 18:40:40 -07:00
Hoblovski 7153b94fc1 Fix "Crate disambiguator" in libs-and-metadata.md 2023-03-16 11:11:46 +02:00
Tshepang Mbambo 60402a753a alert when date gets stale (by using date-check annotation) 2023-03-14 05:50:20 +02:00
Tshepang Mbambo 8307567617 fix date-check annotation some more 2023-03-14 05:50:20 +02:00
Tshepang Mbambo 77d01ca1f5 fix date-check annotation 2023-03-14 05:50:20 +02:00
Tshepang Mbambo 87afef07e7 typo 2023-03-14 05:50:20 +02:00
Michael Howell b51fa3c654 Update rustdoc-internals.md 2023-03-14 05:50:20 +02:00
Thom Chiovoloni b1b6d693cd Rename `config.toml.example` to `config.example.toml` 2023-03-13 04:42:00 +02:00
Yutaro Ohno f9d24b3a5b fix typo `SubstRef` to `SubstsRef` 2023-03-12 11:40:45 +02:00
Tshepang Mbambo e7fdb91611 improve accuracy 2023-03-10 09:04:21 +02:00
bohan 477309b6bb tracing log along diff crates 2023-03-10 09:04:21 +02:00
clubby789 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
Yuki Okushi 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