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

1675 Commits

Author SHA1 Message Date
Noah Lev a10c5befc1
Clean up section about FCPs (#1287) 
* I've never heard the term "pFCP" used before, so spell it out as
  "proposed final comment period"

* Fix some unclear things (like implying that you need `r+` rights to
  start an FCP)

* Improve the chapter's title, and make it consistent with its TOC entry

* Make some other assorted minor cleanups and improvements
 2022-01-18 11:09:16 -03:00
Nicholas Nethercote 18b93ae2ee Address more review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote acc6718c51 Address review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote a992723654 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 875464457c
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 f6a190e709
Fix link in contributing.md (#1280) 2021-12-27 10:28:15 -06:00
Nicholas Nethercote a11e5f4e15
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 9bf0028b55
remove rustfix item in test intro (#1277) 2021-12-20 21:53:57 +09:00
Noah Lev 7340eb8704 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 35dce028e7 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 5dd756bceb
Fix some broken links (#1274) 2021-12-13 15:16:30 +09:00
Jacob Hoffman-Andrews f9db2f4478 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 b6cf9a7e88 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 6c1f5c780b Fix some broken links 2021-12-09 09:11:48 -06:00
Lucas Kent 0c0e4f2e44 Update src/getting-started.md 
Co-authored-by: Joshua Nelson <github@jyn.dev>
 2021-12-09 09:09:36 -06:00
Lucas Kent 3df5cc9fe5 Improve documentation on r? 2021-12-09 09:09:36 -06:00
Rich Kadel a374e7d8bb
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 2cee5a9be8 Improve 'Running tests manually' section 2021-11-27 03:45:39 -05:00
Yuki Okushi c4776cb94a Fix some links 2021-11-24 10:23:07 -05:00
Eric Huss 8a817bc6ca Update for review comments. 2021-11-24 10:22:37 -05:00
Eric Huss aaf6ccc951 Document rustfix-only-machine-applicable 2021-11-24 10:22:37 -05:00
Eric Huss 9660c153fe Apply suggestions from pierwill 
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
 2021-11-24 10:22:37 -05:00
Eric Huss 285b3e4410 Document more compiletest headers. 2021-11-24 10:22:37 -05:00
Simon Perriard 94e9e679eb make it compile with 1.56.0 no warning 2021-11-24 09:00:37 -05:00
Simon Perriard 1f0c4f08f1 make it compile with 1.56.0 2021-11-24 09:00:37 -05:00
Simon Perriard 6a27fc22f1 make it compile with 1.56.0 2021-11-24 09:00:37 -05:00
Dylan MacKenzie a2fc963502
Describe drop elaboration (#1240) 2021-11-18 13:31:13 -05:00
Ken Matsui 5fbfe9363d
Fix an invalid link on Diagnostic Items (#1261) 2021-11-16 10:45:40 -03:00
Yuki Okushi 766f9d7b10
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 24132faa13
Unify `x.py` usage (#1258) 2021-11-16 07:44:50 +09:00
Lucas Kent 0fc1fa9f1e Spelling fixes 2021-11-15 08:23:01 -06:00
Lucas Kent f1297f5560 Fix compare-mode documentation 2021-11-14 17:01:35 -06:00
Noah Lev 6b9c8ae1a8 Fix broken link in "Bootstrapping" 
The italics added in #1239 broke the implicitly-resolved link.
 2021-11-09 21:46:27 -06:00
chubei 196ef69aa6 Fix typo: [upv.rs_mentioned] -> [upvars_mentioned] 2021-11-07 07:48:47 -06:00
asquared31415 ffcc6297c6
Add note to emphasize replacing TARGET_TRIPLE (#1250) 2021-11-06 18:32:55 +09:00
Eric Huss 8a8452cfcc Remove some legacy test suites. 2021-11-04 14:18:39 -05:00
Dmitry Savintsev a034fad804 tiny capitalization fix 2021-11-04 14:15:06 -05:00
Noah Lev 2ad51b6d75 Fix date 
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
 2021-11-04 09:33:03 -07:00
Noah Lev f146da3734 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 dac568c95c 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 292072d8e2 enhance subtree docs, link to clippy docs 2021-11-02 20:09:23 -05:00
pierwill 0f69d33e16 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 70966e597f Some minor adjustments to the diagnostic documentation 2021-10-29 21:51:05 -05:00
pierwill f3fb373be9 Edit "About this guide" for semantic line feeds 
This is work toward #1241.
 2021-10-28 15:30:08 -05:00
Janggun Lee ddaebd85aa
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 68dbb4501d 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 b06008731a Update author field 2021-10-21 15:13:09 -05:00
Noah Lev f68aff5d18 Switch date-check to Rust 2021 
No migrations were necessary.
 2021-10-21 15:13:09 -05:00
Rémy Rakic 87968b466f
Describe how to trigger perf runs (#1237) 2021-10-22 01:00:27 +09:00
Joshua Nelson 4ff071741a
Remove docs on Assemble step (#1233) 2021-10-18 02:17:19 +09:00