about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
AgeCommit message (Collapse)AuthorLines
2022-01-05Address review comments in #1286.Nicholas Nethercote-10/+4
2022-01-05Streamline "Getting Started" some more.Nicholas Nethercote-182/+58
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.
2021-12-28Update link to moved section (#1282)Noah Lev-1/+1
The section was removed in #1030 and re-added in a different place in 2d42cf7.
2021-12-27Fix link in contributing.md (#1280)Ben Reeves-2/+2
2021-12-24Streamline "Getting Started" (#1279)Nicholas Nethercote-138/+89
* 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-20remove rustfix item in test intro (#1277)Wang Qilin-3/+0
2021-12-15Move date-check comment to fix Markdown syntaxNoah Lev-2/+2
The inline code wasn't being rendered correctly.
2021-12-15Update humor docs for special-casing ferris emojiMaxwell Elliot Heiber-0/+1
update for: https://github.com/rust-lang/rust/pull/91476/files
2021-12-13Fix some broken links (#1274)Badel2-2/+2
2021-12-09Update rustdoc internalsJacob Hoffman-Andrews-10/+121
Use current paths when discussing source files. Update cheat sheet section with download-rustc. Add "use cases" section.
2021-12-09Update HIR chapter to use `HirId` instead of `NodeId`Noah Lev-12/+7
`NodeId`s are no longer used in the HIR. See #50928 for more information.
2021-12-09Fix some broken linksNoah Lev-3/+3
2021-12-09Update src/getting-started.mdLucas Kent-1/+1
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-12-09Improve documentation on r?Lucas Kent-8/+23
2021-12-03Update LLVM coverage mapping format version supported by rustc (#1267)Rich Kadel-11/+9
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-11-27Improve 'Running tests manually' sectionLucas Kent-2/+9
2021-11-24Fix some linksYuki Okushi-5/+4
2021-11-24Update for review comments.Eric Huss-4/+9
2021-11-24Document rustfix-only-machine-applicableEric Huss-0/+5
2021-11-24Apply suggestions from pierwillEric Huss-3/+3
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-11-24Document more compiletest headers.Eric Huss-0/+48
2021-11-24make it compile with 1.56.0 no warningSimon Perriard-1/+1
2021-11-24make it compile with 1.56.0Simon Perriard-2/+2
2021-11-24make it compile with 1.56.0Simon Perriard-1/+1
2021-11-18Describe drop elaboration (#1240)Dylan MacKenzie-0/+196
2021-11-16Fix an invalid link on Diagnostic Items (#1261)Ken Matsui-1/+1
2021-11-16Fix broken links related to `rustc_borrowck` (#1259)Yuki Okushi-22/+22
* Fix broken links in region_inference.md * Fix broken links in lifetime_parameters.md
2021-11-16Unify `x.py` usage (#1258)Ken Matsui-56/+56
2021-11-15Spelling fixesLucas Kent-15/+15
2021-11-14Fix compare-mode documentationLucas Kent-2/+11
2021-11-09Fix broken link in "Bootstrapping"Noah Lev-2/+2
The italics added in #1239 broke the implicitly-resolved link.
2021-11-07Fix typo: [upv.rs_mentioned] -> [upvars_mentioned]chubei-1/+1
2021-11-06Add note to emphasize replacing TARGET_TRIPLE (#1250)asquared31415-1/+6
2021-11-04Remove some legacy test suites.Eric Huss-4/+3
2021-11-04tiny capitalization fixDmitry Savintsev-1/+1
2021-11-04Fix dateNoah Lev-1/+1
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-11-04Update some date-check commentsNoah Lev-4/+3
I removed one of them because it doesn't seem necessary.
2021-11-04Ensure date-check cron job is using latest stable RustNoah Lev-0/+4
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-02enhance subtree docs, link to clippy docsCaleb Cartwright-19/+23
2021-11-02Edit introduction to bootstrappingpierwill-54/+61
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-10-29Some minor adjustments to the diagnostic documentationxFrednet-3/+9
2021-10-28Edit "About this guide" for semantic line feedspierwill-29/+31
This is work toward #1241.
2021-10-29Fix `rustc_mir` related links (#1228)Janggun Lee-115/+122
Co-authored-by: Yuki Okushi <jtitor@2k36.org> Co-authored-by: nhamovitz <18648574+nhamovitz@users.noreply.github.com>
2021-10-27Add documentation for LLVM CFI supportRamon de C Valle-5/+10
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-21Update author fieldNoah Lev-1/+1
2021-10-21Switch date-check to Rust 2021Noah Lev-1/+1
No migrations were necessary.
2021-10-22Describe how to trigger perf runs (#1237)Rémy Rakic-1/+4
2021-10-18Remove docs on Assemble step (#1233)Joshua Nelson-19/+4
2021-10-12Update some docs from 2021-10 date triage (#1230)Yusuke Abe-2/+2
2021-10-10Recommend `rustfmt --edition=2021`Noah Lev-2/+2