Commit Graph

85 Commits

Author SHA1 Message Date
Tshepang Mbambo 6d5b3db86f
various fixes/improvements to Contributing chapter (#1723) 2023-07-08 11:52:53 +09:00
sslime336 d3034ae828 Change `./x.py` into `./x` 2023-06-30 23:11:14 +02:00
Eric Huss dda77e082f Fix some links 2023-06-29 06:43:19 +02:00
Tshepang Mbambo 6337ed17fb
fix markup (#1670) 2023-04-10 23:23:05 +09: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 0ccf85aa5b Fix link; remove duplicate link 2023-04-09 22:38:15 +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
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
Eric Huss 8a94e36e0d
Update labels overview (#1639) 2023-03-21 18:07:36 +09:00
Thom Chiovoloni b1b6d693cd Rename `config.toml.example` to `config.example.toml` 2023-03-13 04:42:00 +02:00
Tshepang Mbambo ce834a2763
improve capacity note (#1634) 2023-03-06 22:08:37 +09:00
apiraino 82e50a669a
Add detail to contributing guide (#1628) 2023-03-03 20:14:53 +09:00
Michele df7970bf0d Typo 2023-02-16 07:26:00 +02:00
Michele 4a86a8dd74 Typo 2023-02-16 07:24:32 +02:00
Tshepang Mbambo 0e18184ce3
bumpt date-check examples to current month (#1566) 2023-01-27 07:51:28 +09:00
Joshua Nelson e6fd600417 Replace `$TARGET` with `host`
This avoids having to manually modify the configuration in the docs.
2022-12-31 18:23:52 -06:00
Tshepang Mbambo 9f3efe646d share same link 2022-12-08 19:02:08 -08:00
Yuki Okushi b145e1e1fa fix: Fix broken links
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-12-09 03:13:38 +02:00
Ralf Jung a7cd86425d
clarify subtree tool policy (#1518) 2022-12-03 09:32:00 +09:00
Eric Huss 7f426da358 Update for highfive transition. 2022-10-27 06:07:59 +02:00
Luqman Aden 0a2f713d86
miri is no longer a submodule but a subtree. (#1488) 2022-10-23 08:17:08 +09:00
Eric Huss 6b0a155162
Update for removal of RLS (#1450) 2022-09-02 23:03:15 +09:00
Tshepang Mbambo 2557089a44
make date-check more lightweight (#1394)
* make date-check lightweight

This avoids having to write the date twice when updating date-check.

Before "As of <-- 2022-07 --> July 2022"
After "As of July 2022"

* please clippy

* update date-check docs

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#pullrequestreview-1042163557

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#pullrequestreview-1042167261

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#issuecomment-1189105017

* this breaks markdown

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018268

This led to a more robust regex, though making the tool more picky.
It also found a wrong date format that was missed.

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018419

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018816

* accept review suggestion

This was reverted by mistake

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934019395

* use a more simple fn

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018981

Much more clean

* nit

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* avoid a failed regex

Also, test new shape

* adjust to new regex (which uses named groups)

New regex was introduced by 456008cc35

Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-08-02 13:50:32 -07:00
Amos Wenger bcc1166bf6 rust-analyzer is now a subtree
It used to be a submodule.

cf. https://github.com/rust-lang/rust/pull/99603
2022-07-25 11:40:28 +02:00
Amos Wenger bac43d0fdb Link to rendered book directly
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-19 15:58:55 +02:00
Amos Wenger 5c8febd8cb Fix link to clippy sync docs 2022-07-19 15:58:55 +02:00
Yuki Okushi dca7b1b9c1 Remove a mention to Steve on r? example
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-18 07:31:14 +02:00
Tshepang Mbambo ade9352771 use relative links
Used the following command, followed by some manual tweaking:

  sd 'https://rustc-dev-guide.rust-lang.org/(.+).html' '$1.md' (fd)
2022-07-17 02:32:44 +02:00
Joshua Nelson f92263e45b Update the build instructions for the standard library
Since https://github.com/rust-lang/rust/pull/95503, `library/std` means
"build just std and its dependencies"; to get the old behavior that built
`proc_macro` and `test`, you need `x build library`.

- Update `library/std` to `library`
- Remove the `-i` suggestions; `incremental = true` is already the default for most profiles, in
  which case `-i` does nothing. If you don't have incremental enabled, I still think suggesting `-i`
  is bad idea, because it's easy to forget once, at which point you'll end up rebuilding the whole
  compiler / standard library.
- Remove a few repetitive sections and don't discuss incremental in such detail
  Incremental works well enough that it should "just work" for most people;
  I don't think it needs multiple paragraphs of explanation so early in the guide.
- Clarify that `test library/std` *only* tests libstd in a few places
2022-07-11 07:22:24 +02:00
Yuki Okushi 0b2c9db969
Update some links and docs (#1340) 2022-05-17 07:54:45 +09:00
Yuki Okushi e827b0aaa1 Update some date refs 2022-04-20 13:09:19 -07:00
Ivor Wanders 341abec62a Clarify that r? works in comments. 2022-01-20 18:01:07 -08:00
Georgiy Komarov 60bc9abf72
Spelling: Rename `rust` to `Rust` (#1288) 2022-01-18 11:09:37 -03:00
Ben Reeves f6a190e709
Fix link in contributing.md (#1280) 2021-12-27 10:28:15 -06:00
Lucas Kent 3df5cc9fe5 Improve documentation on r? 2021-12-09 09:09:36 -06:00
Ken Matsui 24132faa13
Unify `x.py` usage (#1258) 2021-11-16 07:44:50 +09:00
Caleb Cartwright 292072d8e2 enhance subtree docs, link to clippy docs 2021-11-02 20:09:23 -05:00
Noah Lev b5b3c0aa04
Update some docs from 2021-10 date triage (#1224) 2021-10-05 17:24:24 -03:00
Jesús Hernández 48d01f867d
Remove requests or suggestions about rebase and fixup contradictory to rust-highfive bot comment (#1111) 2021-06-25 01:50:50 +09:00
Gus Wynn 072657e0a5 Add a section on keeping things up to date in the git section 2021-06-09 14:43:20 -04:00
Ralf Jung f6f83e2fae improve section introduction 2021-05-26 06:24:44 -04:00
Ralf Jung 99e60b3302 not all tools require waiting for a nightly release before they can be fixed 2021-05-26 06:24:44 -04:00
Caleb Cartwright 50de7f0682
update rustfmt references to reflect change from submod to subtree (#1129)
* update rustfmt references to reflect change to subtree

* clarify broken toolstate hypothetical scenario
2021-05-20 15:02:20 +02:00
Ralf Jung 5b63bc2fb7
add 'waiting-for-review' incantation to main contrib page (#1124) 2021-05-05 13:53:42 +02:00
Santiago Pastorino ff363172f9
I-nominated are nominated for discussion (#1080)
* I-nominated are nominated for discussion

* Generalize meeting expression

Co-authored-by: Camelid <camelidcamel@gmail.com>

Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-11 19:05:02 +01:00