Commit graph

1675 commits

Author SHA1 Message Date
Noah Lev
b8cea7bfbf 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
6312d533f7 Address more review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote
7e1fed579d Address review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote
2413da5b47 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
5f6047b879 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
25d51ec375 Fix link in contributing.md (#1280) 2021-12-27 10:28:15 -06:00
Nicholas Nethercote
5e01fd4f2e 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
404a87fdaa remove rustfix item in test intro (#1277) 2021-12-20 21:53:57 +09:00
Noah Lev
8e224691c0 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
b67deeaf82 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
2faf199db5 Fix some broken links (#1274) 2021-12-13 15:16:30 +09:00
Jacob Hoffman-Andrews
26761ca47c 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
7b6163bb6a 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
01fbac4978 Fix some broken links 2021-12-09 09:11:48 -06:00
Lucas Kent
72b6973b3e Update src/getting-started.md
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-12-09 09:09:36 -06:00
Lucas Kent
6f67d9c763 Improve documentation on r? 2021-12-09 09:09:36 -06:00
Rich Kadel
d6f4a6b391 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
99e213a274 Improve 'Running tests manually' section 2021-11-27 03:45:39 -05:00
Yuki Okushi
fbe824dda0 Fix some links 2021-11-24 10:23:07 -05:00
Eric Huss
bb80ff17da Update for review comments. 2021-11-24 10:22:37 -05:00
Eric Huss
c5b2607316 Document rustfix-only-machine-applicable 2021-11-24 10:22:37 -05:00
Eric Huss
85a1f28ef3 Apply suggestions from pierwill
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-11-24 10:22:37 -05:00
Eric Huss
d9658734c5 Document more compiletest headers. 2021-11-24 10:22:37 -05:00
Simon Perriard
81d42b558b make it compile with 1.56.0 no warning 2021-11-24 09:00:37 -05:00
Simon Perriard
5c79aa782f make it compile with 1.56.0 2021-11-24 09:00:37 -05:00
Simon Perriard
d199d090b6 make it compile with 1.56.0 2021-11-24 09:00:37 -05:00
Dylan MacKenzie
90c949fd6d Describe drop elaboration (#1240) 2021-11-18 13:31:13 -05:00
Ken Matsui
28d0356ab2 Fix an invalid link on Diagnostic Items (#1261) 2021-11-16 10:45:40 -03:00
Yuki Okushi
433cbfde9b 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
1833366ad6 Unify x.py usage (#1258) 2021-11-16 07:44:50 +09:00
Lucas Kent
dc645fb25a Spelling fixes 2021-11-15 08:23:01 -06:00
Lucas Kent
159c893732 Fix compare-mode documentation 2021-11-14 17:01:35 -06:00
Noah Lev
dcb592a051 Fix broken link in "Bootstrapping"
The italics added in #1239 broke the implicitly-resolved link.
2021-11-09 21:46:27 -06:00
chubei
bc3e28ef2f Fix typo: [upv.rs_mentioned] -> [upvars_mentioned] 2021-11-07 07:48:47 -06:00
asquared31415
f334ea9494 Add note to emphasize replacing TARGET_TRIPLE (#1250) 2021-11-06 18:32:55 +09:00
Eric Huss
621b3a447f Remove some legacy test suites. 2021-11-04 14:18:39 -05:00
Dmitry Savintsev
3a6e42eda4 tiny capitalization fix 2021-11-04 14:15:06 -05:00
Noah Lev
57d831b27b Fix date
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-11-04 09:33:03 -07:00
Noah Lev
e679209aac 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
ff167cfd3b 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
24837dd684 enhance subtree docs, link to clippy docs 2021-11-02 20:09:23 -05:00
pierwill
3e470fcf63 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
9160d76d53 Some minor adjustments to the diagnostic documentation 2021-10-29 21:51:05 -05:00
pierwill
52a1d9b4f6 Edit "About this guide" for semantic line feeds
This is work toward #1241.
2021-10-28 15:30:08 -05:00
Janggun Lee
16ce294eb9 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
9b6d89841e 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
56748c3e4b Update author field 2021-10-21 15:13:09 -05:00
Noah Lev
30ed0914db Switch date-check to Rust 2021
No migrations were necessary.
2021-10-21 15:13:09 -05:00
Rémy Rakic
effa9e2a61 Describe how to trigger perf runs (#1237) 2021-10-22 01:00:27 +09:00
Joshua Nelson
3bd8a0ed52 Remove docs on Assemble step (#1233) 2021-10-18 02:17:19 +09:00