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
1,672 Commits 3 Branches 0 Tags 114 MiB
Commit Graph

1672 Commits

Author SHA1 Message Date
Nicholas Nethercote e3512c8cd8 Streamline "Getting Started" some more. 
This is a follow-up to #1279.

The "Getting Started" chapter is, TBH, pretty bad when it comes to the
stuff about building and testing. It has far too much detail and lots of
repetition, which would be overwhelming to a newcomer.

This commit removes most of it, leaving behind just quick mentions of
the most common `x.py` commands: `check`, `build`, `test`, `fmt`, with
links to the appropriate chapters for details. There were a few
interesting details that weren't covered elsewhere, so I moved those
into other chapters.
 2022-01-05 23:26:43 -06:00
Noah Lev ce4ae4004c Update link to moved section (#1282) 
The section was removed in #1030 and re-added in a different place in
2d42cf7.
 2021-12-28 22:17:49 -06:00
Ben Reeves 440503e38d Fix link in contributing.md (#1280) 2021-12-27 10:28:15 -06:00
Nicholas Nethercote 2c2ebc2fae Streamline "Getting Started" (#1279) 
* Move `x.py` intro section before first use, and shorten it.

* Improve `x.py setup` docs.

In "Getting Started", strip it back to the bare minimum. Some of this is
moved into the later section.

In the later section, add notable details like config.toml.example how
and `profile` works. Also make the config.toml example more concise.

* Move details about the repository.

Less detail in "Getting Started", more in the later sections.

* Move details about the prereqs.

Less detail in "Getting Started", more in the later sections.
 2021-12-24 12:52:31 -03:00
Wang Qilin 1349a379b8 remove rustfix item in test intro (#1277) 2021-12-20 21:53:57 +09:00
Noah Lev 924c1fa136 Move date-check comment to fix Markdown syntax 
The inline code wasn't being rendered correctly.
 2021-12-15 11:59:46 -08:00
Maxwell Elliot Heiber 46d0c2c3a8 Update humor docs for special-casing ferris emoji 
update for: https://github.com/rust-lang/rust/pull/91476/files
 2021-12-15 09:49:37 -06:00
Badel2 f639a94b4d Fix some broken links (#1274) 2021-12-13 15:16:30 +09:00
Jacob Hoffman-Andrews ddccb87b0d Update rustdoc internals 
Use current paths when discussing source files.
Update cheat sheet section with download-rustc.
Add "use cases" section.
 2021-12-09 16:05:48 -06:00
Noah Lev 51146cd309 Update HIR chapter to use `HirId` instead of `NodeId` 
`NodeId`s are no longer used in the HIR. See #50928 for more information.
 2021-12-09 09:11:48 -06:00
Noah Lev 7c8d7c57a4 Fix some broken links 2021-12-09 09:11:48 -06:00
Lucas Kent 99ced2e883 Update src/getting-started.md 
Co-authored-by: Joshua Nelson <github@jyn.dev>
 2021-12-09 09:09:36 -06:00
Lucas Kent 08bc5de96a Improve documentation on r? 2021-12-09 09:09:36 -06:00
Rich Kadel 2531a18d3b Update LLVM coverage mapping format version supported by rustc (#1267) 
rust-lang/rust#91207 updates the coverage mapping format to Version 5 or
6, depending on the built-in version of LLVM (12 or 13, respectively).

This change updates the dev guide to match the recent changes.
 2021-12-03 09:26:47 -08:00
Lucas Kent 9074afb8da Improve 'Running tests manually' section 2021-11-27 03:45:39 -05:00
Yuki Okushi a7abb26bfe Fix some links 2021-11-24 10:23:07 -05:00
Eric Huss 499f9b9fc9 Update for review comments. 2021-11-24 10:22:37 -05:00
Eric Huss 4aff2ba309 Document rustfix-only-machine-applicable 2021-11-24 10:22:37 -05:00
Eric Huss 9bde256126 Apply suggestions from pierwill 
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
 2021-11-24 10:22:37 -05:00
Eric Huss c042df7cae Document more compiletest headers. 2021-11-24 10:22:37 -05:00
Simon Perriard 8240b96f33 make it compile with 1.56.0 no warning 2021-11-24 09:00:37 -05:00
Simon Perriard f7192cb802 make it compile with 1.56.0 2021-11-24 09:00:37 -05:00
Simon Perriard 80eae9a303 make it compile with 1.56.0 2021-11-24 09:00:37 -05:00
Dylan MacKenzie 6643adf704 Describe drop elaboration (#1240) 2021-11-18 13:31:13 -05:00
Ken Matsui d4f300263e Fix an invalid link on Diagnostic Items (#1261) 2021-11-16 10:45:40 -03:00
Yuki Okushi 8047e19802 Fix broken links related to `rustc_borrowck` (#1259) 
* Fix broken links in region_inference.md

* Fix broken links in lifetime_parameters.md
 2021-11-16 10:43:17 -03:00
Ken Matsui e1babf580d Unify `x.py` usage (#1258) 2021-11-16 07:44:50 +09:00
Lucas Kent 363f6ce09c Spelling fixes 2021-11-15 08:23:01 -06:00
Lucas Kent 7b93c858f0 Fix compare-mode documentation 2021-11-14 17:01:35 -06:00
Noah Lev e0ddc301da Fix broken link in "Bootstrapping" 
The italics added in #1239 broke the implicitly-resolved link.
 2021-11-09 21:46:27 -06:00
chubei 7335f28334 Fix typo: [upv.rs_mentioned] -> [upvars_mentioned] 2021-11-07 07:48:47 -06:00
asquared31415 42e31a049e Add note to emphasize replacing TARGET_TRIPLE (#1250) 2021-11-06 18:32:55 +09:00
Eric Huss b4570015e5 Remove some legacy test suites. 2021-11-04 14:18:39 -05:00
Dmitry Savintsev 07dcb9e148 tiny capitalization fix 2021-11-04 14:15:06 -05:00
Noah Lev 98fe056d6c Fix date 
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
 2021-11-04 09:33:03 -07:00
Noah Lev b1f655d972 Update some date-check comments 
I removed one of them because it doesn't seem necessary.
 2021-11-04 09:33:03 -07:00
Noah Lev 8f61c9e7e9 Ensure date-check cron job is using latest stable Rust 
This should prevent future failures like this one [1].

[1]: https://github.com/rust-lang/rustc-dev-guide/runs/4067460927?check_suite_focus=true
 2021-11-04 09:33:03 -07:00
Caleb Cartwright b26499d1ff enhance subtree docs, link to clippy docs 2021-11-02 20:09:23 -05:00
pierwill b547c04d8e Edit introduction to bootstrapping 
Use paragraphs instead of bullet-points.
Edits throughout for clarity.
Use semantic line breaks in edited sections.

Co-authored-by: Joshua Nelson <github@jyn.dev>
 2021-11-02 15:06:56 -05:00
xFrednet c0c8c133c7 Some minor adjustments to the diagnostic documentation 2021-10-29 21:51:05 -05:00
pierwill f85c21465f Edit "About this guide" for semantic line feeds 
This is work toward #1241.
 2021-10-28 15:30:08 -05:00
Janggun Lee d03c7b8626 Fix `rustc_mir` related links (#1228) 
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: nhamovitz <18648574+nhamovitz@users.noreply.github.com>
 2021-10-29 00:58:26 +09:00
Ramon de C Valle 0d3af84fc0 Add documentation for LLVM CFI support 
This commit adds initial documentation for LLVM Control Flow Integrity
(CFI) support to the Rust compiler (see rust-lang/rust#89652 and
rust-lang/rust#89653).
 2021-10-27 08:55:16 -05:00
Noah Lev 4c4d9b5357 Update author field 2021-10-21 15:13:09 -05:00
Noah Lev 9334db680b Switch date-check to Rust 2021 
No migrations were necessary.
 2021-10-21 15:13:09 -05:00
Rémy Rakic 2cd36a4f65 Describe how to trigger perf runs (#1237) 2021-10-22 01:00:27 +09:00
Joshua Nelson 4dcc29161b Remove docs on Assemble step (#1233) 2021-10-18 02:17:19 +09:00
Yusuke Abe 48e6d474cc Update some docs from 2021-10 date triage (#1230) 2021-10-12 08:52:21 +09:00
Noah Lev 632f2b7484 Recommend `rustfmt --edition=2021` 2021-10-10 08:28:12 -05:00
Tomasz Miąsko 62955f53ac Update sanitizer documentation 2021-10-08 15:49:53 -05:00