Commit Graph

2155 Commits

Author SHA1 Message Date
Ivor Wanders 885d329928
Consolidate crates.io convention section (#1326) 2022-04-11 22:51:22 +09:00
Ujjawal fbda644df8
Update examples with 1.61.0-nightly (latest version) (#1330)
Co-authored-by: Ujjawal Kumar <u.kumar@ukumar-ltmit1s.internal.salesforce.com>
2022-04-11 22:48:30 +09:00
Noah Lev 664d3c70c0
r-a: Use `python3 x.py` instead of `./x.py` (#1335) 2022-04-09 17:31:23 +09:00
Hongbo f5f6b4f2be
Update miri.md: correct a minor typo (#1334) 2022-04-06 07:47:46 +09:00
xFrednet 127abaa937 Add example how lints can be feature gated 2022-04-04 13:16:08 -07:00
lcnr 155126b1d2
update section for type system constants (#1329)
* update section for type system constants

* Update src/constants.md
2022-03-22 14:34:21 +01:00
skippy10110 0e4b961a9c update winget install instructions to ensure proper packages are installed (-e for --exact, and full package names to ensure arbitrary packages from the msstore source aren't installed)
fixes #1324
2022-03-14 08:40:37 -07:00
Guillaume Gomez 4b8d939889 Add missing rustdoc tests explanations 2022-03-09 12:45:59 -08:00
Chayim Refael Friedman eb90c9c25a Fix incorrectly escaped backtick 2022-03-02 12:18:48 -08:00
James Cole 32f2a5b4e7
Add architecture suggestion for Apple silicon (#1320) 2022-03-01 10:45:24 -06:00
Eric Huss 7d8eb87604
cargo timings has been stabilized (#1319)
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2022-02-27 22:26:00 -06:00
Eric Huss 24e474c276
Add known-bug header. (#1311) 2022-02-24 22:40:58 -06:00
Téo Bouvard 9e2cdee5b3
Fix typo (#1315) 2022-02-24 11:27:21 -08:00
Samuel Moelius e798dc49d7
Typo (#1313) 2022-02-22 18:22:28 -06:00
Eric Huss d335c9c2bb instrument-coverage has been stabilized. 2022-02-20 13:59:23 -08:00
Eric Huss eefbde504f symbol-mangling-version has been stabilized 2022-02-20 13:59:23 -08:00
pierwill 5483b27923
Fix `Ty` link (#1308) 2022-02-20 12:14:58 -08:00
pierwill 68c7649409
Edit glossary (#1302)
Add back-ticks to a few terms that appear in code.

Clarify that `tcx` is a standard.
2022-02-17 14:09:04 -08:00
Noah Lev 1fa751d36e
Fix heading levels in the query chapter (#1305)
This should fix the incorrect TOC rendering in #1303.
2022-02-17 13:48:36 -08:00
pierwill 2c9be18076 Fix link 2022-02-17 13:30:24 -08:00
pierwill cb3fb942e3
Edit "Queries" chapter (#1301)
Makes various edits for clarity, style, readability, and formatting.

Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-02-17 15:12:43 -06:00
pierwill 5e38eb64bf
Link to The Rust Performance Book (#1300) 2022-02-17 17:46:20 -03:00
Raoul Strackx 62f58394ba
Correction, building stage3 compiler (#1298) 2022-02-11 08:42:50 -05:00
Yuki Okushi d1822b9998
Triage some date references (#1293) 2022-02-10 17:34:23 -03:00
Manish Goregaokar dc47b51114
mention test folders for cfg(bootstrap) (#1294) 2022-02-05 15:03:17 +09:00
Felix S. Klock II 8763adb62c git.md: Expanded a note to try to stress what you need to do if you're playing
games with submodules.

(I overlooked this when cherry-picking an LLVM commit today, and wasted some
time wondering why I wasn't seeing any effect in my resulting `rustc` build...)
2022-01-26 14:01:40 -08:00
Ivor Wanders 341abec62a Clarify that r? works in comments. 2022-01-20 18:01:07 -08:00
Eric Huss 78dd6a4684
Reorganize and expand the testing chapters. (#1281)
* Reorganize and expand the testing chapters.

* Update tests chapters for review comments.

* Fix typo.
2022-01-18 14:44:26 -03:00
Amanieu d'Antras 4d46bd0c95
Add inline assembly internals (#1266) 2022-01-18 11:12:06 -03:00
Georgiy Komarov 60bc9abf72
Spelling: Rename `rust` to `Rust` (#1288) 2022-01-18 11:09:37 -03:00
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