0eb86d9bfe
address review comment
...
https://github.com/rust-lang/rustc-dev-guide/pull/1392#discussion_r921560851
2022-07-15 13:24:50 +02:00
7a99011947
update date reference on MIR inliner
...
cc #1379
2022-07-15 13:24:50 +02:00
47e04448c7
remove outdated info on debugging
...
Closes #1391
Also, do some small fixes/improvements while at it.
2022-07-15 13:24:07 +02:00
4a96ed5165
small fixes to ty chapter ( #1390 )
2022-07-15 15:47:42 +09:00
f92263e45b
Update the build instructions for the standard library
...
Since https://github.com/rust-lang/rust/pull/95503 , `library/std` means
"build just std and its dependencies"; to get the old behavior that built
`proc_macro` and `test`, you need `x build library`.
- Update `library/std` to `library`
- Remove the `-i` suggestions; `incremental = true` is already the default for most profiles, in
which case `-i` does nothing. If you don't have incremental enabled, I still think suggesting `-i`
is bad idea, because it's easy to forget once, at which point you'll end up rebuilding the whole
compiler / standard library.
- Remove a few repetitive sections and don't discuss incremental in such detail
Incremental works well enough that it should "just work" for most people;
I don't think it needs multiple paragraphs of explanation so early in the guide.
- Clarify that `test library/std` *only* tests libstd in a few places
2022-07-11 07:22:24 +02:00
8accea6a9d
overview.md: Link to existing Macro Expansion and Name Resolution docs ( #1388 )
2022-07-08 12:55:38 -05:00
f1d10fbf4a
Revert "Add the config needed to get rust-analyzer working on src/bootstrap ( #1381 )"
...
This reverts commit d955bab63c
2022-07-07 07:10:35 +02:00
07efe00394
Use `x.py check` instead of `cargo check` for build scripts ( #1384 )
...
Cargo check isn't supported and gives an error that CFG_CHANNEL is missing.
It also generates a new target dir and recompiles dependencies.
Use x.py instead, which avoids both issues.
2022-07-06 18:36:22 -03:00
eb83839e90
Suggest a separate build directory for rust-analyzer ( #1378 )
2022-07-03 15:17:39 +09:00
ef73d033d6
Change the old filename, "src/stage0.txt" to "src/stage0.json" ( #1383 )
2022-07-03 15:10:25 +09:00
d955bab63c
Add the config needed to get rust-analyzer working on src/bootstrap ( #1381 )
2022-07-03 15:06:54 +09:00
a05e1fd401
Fix path to hir_id_validator.rs
...
It doesn't look like the old path ever existed.
2022-07-02 21:32:39 +02:00
f423a3ad95
leave formatOnSave to the user ( #1380 )
2022-07-02 00:35:13 +09:00
11b40654fd
diagnostics: structs with new slug syntax ( #1377 )
...
Update the documentation for diagnostic structs to use the new typed
identifier syntax for referring to slugs.
Signed-off-by: David Wood <david.wood@huawei.com>
2022-06-28 13:17:15 -03:00
03fafb5d85
Few readability fixes
2022-06-27 02:41:09 +02:00
4505f706b1
humorust: Forbid pineapple on pizza ( #1374 )
2022-06-26 21:02:21 +09:00
048d925f0a
not obvious what Ex is, so rather get rid ( #1372 )
2022-06-21 22:25:34 +09:00
a3d2f90481
small improves ( #1371 )
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-06-21 18:45:30 +09:00
12a613eddb
make clear that other versions can work ( #1373 )
2022-06-21 13:26:19 +09:00
bda3e0b23c
Fix small `src/diagnostics.md` typo ( #1370 )
2022-06-18 19:42:08 +09:00
cddd59fff8
Add an "is" and rearange "We next" to "Next, we" ( #1369 )
2022-06-18 12:31:49 +09:00
c4d5a69945
diagnostics: add translation documentation
...
- Add documentation on translation infrastructure and use of
`SessionSubdiagnostic`.
- Update diagnostic examples on other pages to be translatable since
this is preferred.
Signed-off-by: David Wood <david.wood@huawei.com>
2022-06-13 10:14:40 +02:00
56ec010080
diagnostics: line wrapping/heading changes
...
Minor stylistic changes to some of the diagnostic documentation: adding
line wrapping to the Markdown source and changing the capitalization of
the headings to be consistent with other pages.
Signed-off-by: David Wood <david.wood@huawei.com>
2022-06-13 10:14:40 +02:00
ee64179f12
later -> latter
2022-06-13 00:17:41 +02:00
375a9f06e3
Remove mention of -Zborrowck=mir with Polonius. ( #1367 )
2022-06-08 19:30:43 -03:00
e83cd73692
Remove nll compare mode. ( #1366 )
2022-06-08 14:21:15 -03:00
bc81f9918c
add section on user types ( #1359 )
...
* add section on user types
* line length
* review
* Update src/borrow_check/type_check.md
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-06-08 14:21:01 -03:00
6e4d6435db
Make build scripts and proc macros work with the suggested rust-analyzer config ( #1365 )
2022-06-08 08:06:32 +09:00
438364838a
improve rustc_interface examples a little ( #1362 )
2022-06-07 08:42:07 +09:00
4d43651c90
Clarify cargo fallback behavior for rustup link ( #1273 )
2022-06-07 08:37:50 +09:00
a206009f26
Update rustc-driver related examples
2022-05-30 13:57:16 +02:00
669262932a
Triage some date references related to traits
2022-05-27 21:40:59 -07:00
554c00e480
Cleanup rustdoc-internals
2022-05-24 17:15:35 -07:00
5e268730e0
Fix some wording on the "Incremental Compilation In Detail" page
2022-05-24 16:03:20 -07:00
0cd9842821
Add note about patching dependencies and warnings. ( #1354 )
2022-05-21 12:53:51 +09:00
12a2e08f72
make sentence more simple ( #1353 )
2022-05-20 21:37:01 +09:00
0b2c9db969
Update some links and docs ( #1340 )
2022-05-17 07:54:45 +09:00
b389adccc1
Replace a broken YouTube link ( #1295 )
2022-05-16 11:36:40 -03:00
06445e66c4
Edit the "Compiler Source Code" chapter ( #1307 )
...
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
Co-authored-by: pierwill <pierwill@users.noreply.github.com>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-05-16 21:02:11 +09:00
b24d550239
Add docs for logging of queries. ( #1350 )
2022-05-12 13:56:26 +09:00
77f7fa259f
Fix configuration names for vscode/r-a ( #1352 )
2022-05-12 13:56:14 +09:00
687f6036ca
Update docs for deprecated attribute ( #1338 )
2022-05-12 13:53:26 +09:00
0c02acdb6f
Update overview.md ( #1351 )
...
Fix minor typo
2022-05-10 09:45:31 -03:00
425fa202c8
Update date references on parallel-rustc ( #1348 )
2022-05-09 08:47:50 -05:00
e4ce969bea
mention `WithOptConstParam` ( #1346 )
2022-05-09 09:19:43 +09:00
a9d0e35c84
Fix format ( #1349 )
2022-05-09 09:17:51 +09:00
2de8cb5dab
correct type of SubstsRef ( #1347 )
2022-05-07 09:58:20 +09:00
acb1fcb780
Document ErrorGuaranteed ( #1316 )
...
* document ErrorGuaranteed
* Fix typos
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Clarify Niko comment
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2022-05-03 11:28:26 -03:00
9ec019011f
Edit "What the compiler does to your code" ( #1306 )
...
* Edit overview.md
* Fix lexer crate
* Edit wording
Co-authored-by: pierwill <pierwill@users.noreply.github.com>
2022-05-02 17:10:45 -03:00
e827b0aaa1
Update some date refs
2022-04-20 13:09:19 -07:00
043e60f4f1
Fix a small typo ( #1343 )
2022-04-20 18:57:49 +09:00
a8add664d4
Extend debugging llvm section ( #1290 )
2022-04-14 20:17:36 +09:00
c190ae37e1
Send people doing *library* stabilizations over to the std-dev-guide ( #1317 )
...
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2022-04-14 20:10:34 +09:00
aa31b10161
Fix typo serious->series ( #1336 )
2022-04-14 19:46:54 +09:00
e58b4c04cb
Minor type fix ( #1337 )
2022-04-14 19:44:36 +09:00
d9bfa3788c
sessiondiagnostic: translation ( #1333 )
2022-04-14 14:57:32 +09:00
eeb5a83c15
method-lookup.md improvements ( #1296 )
2022-04-11 23:29:48 +09:00
885d329928
Consolidate crates.io convention section ( #1326 )
2022-04-11 22:51:22 +09:00
664d3c70c0
r-a: Use `python3 x.py` instead of `./x.py` ( #1335 )
2022-04-09 17:31:23 +09:00
f5f6b4f2be
Update miri.md: correct a minor typo ( #1334 )
2022-04-06 07:47:46 +09:00
127abaa937
Add example how lints can be feature gated
2022-04-04 13:16:08 -07:00
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
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
4b8d939889
Add missing rustdoc tests explanations
2022-03-09 12:45:59 -08:00
eb90c9c25a
Fix incorrectly escaped backtick
2022-03-02 12:18:48 -08:00
32f2a5b4e7
Add architecture suggestion for Apple silicon ( #1320 )
2022-03-01 10:45:24 -06:00
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
24e474c276
Add known-bug header. ( #1311 )
2022-02-24 22:40:58 -06:00
9e2cdee5b3
Fix typo ( #1315 )
2022-02-24 11:27:21 -08:00
e798dc49d7
Typo ( #1313 )
2022-02-22 18:22:28 -06:00
d335c9c2bb
instrument-coverage has been stabilized.
2022-02-20 13:59:23 -08:00
eefbde504f
symbol-mangling-version has been stabilized
2022-02-20 13:59:23 -08:00
5483b27923
Fix `Ty` link ( #1308 )
2022-02-20 12:14:58 -08:00
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
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
2c9be18076
Fix link
2022-02-17 13:30:24 -08:00
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
5e38eb64bf
Link to The Rust Performance Book ( #1300 )
2022-02-17 17:46:20 -03:00
62f58394ba
Correction, building stage3 compiler ( #1298 )
2022-02-11 08:42:50 -05:00
d1822b9998
Triage some date references ( #1293 )
2022-02-10 17:34:23 -03:00
dc47b51114
mention test folders for cfg(bootstrap) ( #1294 )
2022-02-05 15:03:17 +09:00
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
341abec62a
Clarify that r? works in comments.
2022-01-20 18:01:07 -08:00
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
4d46bd0c95
Add inline assembly internals ( #1266 )
2022-01-18 11:12:06 -03:00
60bc9abf72
Spelling: Rename `rust` to `Rust` ( #1288 )
2022-01-18 11:09:37 -03:00
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
18b93ae2ee
Address more review comments in #1286 .
2022-01-05 23:26:43 -06:00
acc6718c51
Address review comments in #1286 .
2022-01-05 23:26:43 -06:00
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
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
f6a190e709
Fix link in contributing.md ( #1280 )
2021-12-27 10:28:15 -06:00
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
9bf0028b55
remove rustfix item in test intro ( #1277 )
2021-12-20 21:53:57 +09:00
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
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
5dd756bceb
Fix some broken links ( #1274 )
2021-12-13 15:16:30 +09:00
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
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
6c1f5c780b
Fix some broken links
2021-12-09 09:11:48 -06:00
0c0e4f2e44
Update src/getting-started.md
...
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-12-09 09:09:36 -06:00
3df5cc9fe5
Improve documentation on r?
2021-12-09 09:09:36 -06:00
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
2cee5a9be8
Improve 'Running tests manually' section
2021-11-27 03:45:39 -05:00
c4776cb94a
Fix some links
2021-11-24 10:23:07 -05:00
8a817bc6ca
Update for review comments.
2021-11-24 10:22:37 -05:00
aaf6ccc951
Document rustfix-only-machine-applicable
2021-11-24 10:22:37 -05:00
9660c153fe
Apply suggestions from pierwill
...
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-11-24 10:22:37 -05:00
285b3e4410
Document more compiletest headers.
2021-11-24 10:22:37 -05:00
a2fc963502
Describe drop elaboration ( #1240 )
2021-11-18 13:31:13 -05:00
5fbfe9363d
Fix an invalid link on Diagnostic Items ( #1261 )
2021-11-16 10:45:40 -03:00
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
24132faa13
Unify `x.py` usage ( #1258 )
2021-11-16 07:44:50 +09:00
0fc1fa9f1e
Spelling fixes
2021-11-15 08:23:01 -06:00
f1297f5560
Fix compare-mode documentation
2021-11-14 17:01:35 -06:00
6b9c8ae1a8
Fix broken link in "Bootstrapping"
...
The italics added in #1239 broke the implicitly-resolved link.
2021-11-09 21:46:27 -06:00
196ef69aa6
Fix typo: [upv.rs_mentioned] -> [upvars_mentioned]
2021-11-07 07:48:47 -06:00
ffcc6297c6
Add note to emphasize replacing TARGET_TRIPLE ( #1250 )
2021-11-06 18:32:55 +09:00
8a8452cfcc
Remove some legacy test suites.
2021-11-04 14:18:39 -05:00
a034fad804
tiny capitalization fix
2021-11-04 14:15:06 -05:00
2ad51b6d75
Fix date
...
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-11-04 09:33:03 -07:00
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
292072d8e2
enhance subtree docs, link to clippy docs
2021-11-02 20:09:23 -05:00
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
70966e597f
Some minor adjustments to the diagnostic documentation
2021-10-29 21:51:05 -05:00
f3fb373be9
Edit "About this guide" for semantic line feeds
...
This is work toward #1241 .
2021-10-28 15:30:08 -05:00
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
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
87968b466f
Describe how to trigger perf runs ( #1237 )
2021-10-22 01:00:27 +09:00
4ff071741a
Remove docs on Assemble step ( #1233 )
2021-10-18 02:17:19 +09:00
fba15a46ca
Update some docs from 2021-10 date triage ( #1230 )
2021-10-12 08:52:21 +09:00
ceec906a31
Recommend `rustfmt --edition=2021`
2021-10-10 08:28:12 -05:00
afbcc3efa9
Update sanitizer documentation
2021-10-08 15:49:53 -05:00
cec5879a86
Mention needs-sanitizer-hwaddress directive
2021-10-08 15:49:53 -05:00
72906c9bed
Address review comments
2021-10-08 15:41:06 -05:00
dc16b5293b
Document tracing awesomeness
2021-10-08 15:41:06 -05:00
013c8892dd
Move log/tracing instructions to its own file
2021-10-08 15:41:06 -05:00
0cff8fbeec
Update src/closure.md
...
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-10-07 17:48:12 -05:00
67faab2aa2
Fix accidental HTML tag
...
The markdown parser was interpreting the `<something>` in `adjust_upvar_borrow_kind_for_<something>` as an HTML tag that was hidden in the rendered text. This minor edit fixes that.
2021-10-07 17:48:12 -05:00
b71e9792c7
Update links to `rustc_mir` in Two Phase Borrows ( #1226 )
...
https://github.com/rust-lang/rust/pull/80522 split the `rustc_mir` crates into 5 crates, effectively invalidating all the direct links to `rustc_mir` in the docs.
I found this while looking at the Two Phase Borrows doc, which is why I am giving out this PR to fix this.
2021-10-06 09:07:51 -03:00
b5b3c0aa04
Update some docs from 2021-10 date triage ( #1224 )
2021-10-05 17:24:24 -03:00
d1f03cbaa3
Fix a typo on closure.md ( #1218 )
2021-09-24 12:00:29 +09:00
82d4c5604d
const generics update
2021-09-20 12:35:16 -05:00
17957567f7
s/--blessed/--bless/
2021-09-19 10:36:26 -05:00
56f6bdbb70
Make indentation consistent in example vscode config file
2021-09-17 16:52:56 -05:00
60ef9da723
Suggests `--edition=2018` argument when using stage0/bin/rustfmt directly
2021-09-17 14:53:44 -05:00
09bf2bd2df
`ty::Unevaluated`: dealing with unused substs ( #1190 )
...
* unused ct substs
* q
* q
* Update src/constants.md
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2021-09-17 15:50:26 -04:00
8c39edb660
Parallel codegen ( #1206 )
...
* Described underlying data structures in parallel code generation and crates they are used in
* Added links
* replace crate information with description of types
2021-09-16 20:58:07 -05:00
9198465b6c
Clarify difference of a help vs note diagnostic.
2021-09-12 11:50:44 -05:00
295922ec93
remove ctag section
2021-09-08 15:13:44 -05:00
8f98dac74d
Update suggested.md
2021-09-08 15:13:44 -05:00
d1f77858e7
Update SUMMARY.md
2021-09-08 15:13:44 -05:00
fb62bc398f
Move ctag section to "Suggested Workflow"
2021-09-08 15:13:44 -05:00
5b607d9862
Delete ctags.md
2021-09-08 15:13:44 -05:00
9a42b37519
Clarify paragraph in "Keeping things up to date"
2021-09-08 12:36:10 -05:00
0cc70fcaf1
Docs: added section on rustdoc
2021-09-07 11:08:38 -05:00
0eb2c70cf5
Docs: made suggested fix
2021-09-07 11:08:38 -05:00
1df026246a
Docs: deleted copy
2021-09-07 11:08:38 -05:00
c31ec83e91
Docs: added section discussing core ideas
2021-09-07 11:08:38 -05:00
78afd53e8a
Docs: delete redundant use of correctness
2021-09-07 11:08:38 -05:00
0fe44f730b
Docs: consolidated parallelism information
2021-09-07 11:08:38 -05:00
71d88b345f
Add links to overview.md ( #1202 )
2021-09-06 18:34:16 -03:00
a5dea10a46
Spelling change intermidiate to intermediate
...
Very importent change.
2021-09-05 12:11:19 -05:00
30826ca7d8
Fix a typo ( #1200 )
2021-09-05 09:40:35 -03:00
139b8fb11b
Documenting diagnostic items with their usage and naming conventions ( #1192 )
...
* Documenting diagnostic items with their usage and naming conventions
* Fixed typos in diagnostic items documentation
Co-authored-by: Camelid <camelidcamel@gmail.com>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-09-01 11:26:58 -07:00
95f1acf9a3
Add link to `Span`
2021-08-31 12:38:30 -05:00
9be3fafda6
Add rustc-source to suggested rust-analyzer config ( #1189 )
...
This allows loading the sources for crates loaded from the sysroot.
2021-08-31 10:13:18 -07:00
fa6a787cfd
Fix typo, clarify backtick wording, and use inline code
2021-08-31 12:08:01 -05:00
2f447292ff
Trailing date comments in a line inside of a paragraph caused beginning of a new paragraph. ( #1196 )
...
This PR fixes the 2 occurrences of that.
(I'm not sure if there's an underlying issue with mdbook or if this is working as intended.)
2021-08-28 08:26:16 -03:00
0e5be8a943
Fix a code block containing ```rust
...
This wasn't displayed correctly.
Changing `` ```rust `` to `` ```rust`` made it a code block again,
but the leading space was rendered as-well.
(This may be an issue in mdbook, but I'm not sure.)
This commit changes it to use HTML-syntax in order to get the desired result.
2021-08-27 15:13:38 -05:00
cf0e151b79
Fix typo “a Rc” → “an Rc” ( #1191 )
2021-08-22 11:47:02 -03:00
77a9813ae0
Expand THIR section with more details ( #1183 )
...
* Expand THIR section with more details
* Remove incorrect reference to `HirId`s
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-08-21 19:55:56 -04:00
9a6bd9fc98
Remove docs for old -Z profile-queries flag
2021-08-16 08:20:03 -05:00
c4644b427c
Remove a dead link in `new-target.md` + other nits ( #1186 )
2021-08-10 20:41:44 +09:00
e218184b68
Add description of -opt-bisect-limit LLVM option ( #1182 )
2021-08-07 10:12:22 +02:00
809f4d1d33
Fixed team responsible for stabilization ( #1181 )
2021-08-05 13:41:16 +02:00
d111b3ea7e
Add S-Inactive PRs as another source of things contributors could work on ( #1177 )
2021-07-29 06:05:19 +02:00
f094672828
git.md: Fix No-Merge Policy link
2021-07-28 09:45:23 -04:00
09343d6f92
Fix typo in building/bootstrapping.md ( #1175 )
2021-07-26 00:37:28 +02:00
f2c4bba539
Link directly to stabilization report comments ( #1173 )
...
Previously, readers had to scroll through tons of comments to find the
report.
2021-07-20 17:39:41 -07:00
93422c21ba
Update for merge of CrateDisambiguator into StableCrateId
2021-07-13 12:45:58 -04:00
1b56b09472
Minor capitalization fix ( #1170 )
2021-07-08 01:27:47 +02:00
60e2825591
Fixed typos in inline code
2021-07-05 11:21:03 -04:00
33c1eff45e
Document lang items ( #1119 )
...
* Document lang items
* Apply suggestions from code review
Co-authored-by: Camelid <camelidcamel@gmail.com>
* Add an example of retrieving lang items
* Add two missing words
* Fix line lengths
Co-authored-by: Mikail Bagishov <bagishov.mikail@yandex.ru>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-07-05 08:34:33 +02:00
1a51a21243
More specifics on what future-incompatible lints are used for
2021-07-04 23:21:24 -04:00
c3c110f107
Fix line lens
2021-07-04 23:21:24 -04:00
9636fa92ab
Update information on lints particularly on future-incompatible
2021-07-04 23:21:24 -04:00
a4e29c5cb5
Update section of lint store
2021-07-04 23:21:24 -04:00
442ba10f1e
Update around half of the January 2021 date references ( #1155 )
2021-07-02 10:43:34 +02:00
ea66b238e4
Create issues for many TODOs ( #1163 )
...
* Create issues for many TODOs
* Update src/crates-io.md
Co-authored-by: Joshua Nelson <github@jyn.dev>
* Update src/backend/inline-asm.md
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Joshua Nelson <github@jyn.dev>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-07-02 10:43:12 +02:00
84779866ff
Links from rustc-dev-guide to std-dev-guide ( #1152 )
2021-07-01 13:19:06 +02:00
c319110e8d
Document how to mark features as incomplete ( #1151 )
...
* Document how to mark features as incomplete
This was changed in https://github.com/rust-lang/rust/pull/86446 so that
incompleteness is included in the delcaration.
* Footerify link
2021-06-29 18:41:13 +02:00
48d01f867d
Remove requests or suggestions about rebase and fixup contradictory to rust-highfive bot comment ( #1111 )
2021-06-25 01:50:50 +09:00
a1ed0ddbc4
Generate glossary table correctly ( #1146 )
...
Co-authored-by: Yuki Okushi <yuki.okushi@huawei.com>
2021-06-24 13:57:37 +09:00
8fcb613cac
Correct the wrong serial number ( #1147 )
2021-06-23 15:14:09 +09:00
fe34beddb4
Update "Inference variables" section ( #1145 )
2021-06-21 21:50:12 +02:00
a58da1ba0d
Document how to run unit tests ( #1141 )
2021-06-17 17:25:28 -03:00
be1d3c4dd4
We stopped using allow_internal_unstable a while ago ( #1142 )
...
Co-authored-by: Ralf Jung <post@ralfj.de>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2021-06-15 17:04:54 +09:00
3a63b1296e
Change the feature used as an example of stabilizing lib features ( #1143 )
2021-06-15 05:57:10 +09:00
c3ac40dc23
We use HIR to do type inference, trait solving and type checking ( #1139 )
...
* We use HIR to do type inference, trait solving and type checking
* Update src/overview.md
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
* Update src/overview.md
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
* Update src/overview.md
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
* Fix type checking brief explanation
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2021-06-14 20:35:38 +02:00
6e4f0cbe1b
Add suggested settings note for coc ( #1144 )
2021-06-13 01:17:06 +09:00
8608047fb2
move 7/8 to prose
2021-06-09 14:43:20 -04:00
072657e0a5
Add a section on keeping things up to date in the git section
2021-06-09 14:43:20 -04:00
c8da5bfd1c
Fix some links ( #1137 )
...
* Fix some links
* Address review comment
2021-06-04 09:08:56 +02:00
78204563e2
explain Miri engine vs Miri-the-tool
2021-05-30 02:18:51 +02:00
70e979a519
Add more information about no_hash query modifier. ( #1133 )
2021-05-28 17:23:27 +02:00
f6f83e2fae
improve section introduction
2021-05-26 06:24:44 -04:00
99e60b3302
not all tools require waiting for a nightly release before they can be fixed
2021-05-26 06:24:44 -04:00
12f9ede977
Describe the difference of rustc_lint vs rustc_lint_defs.
2021-05-25 21:37:21 -04:00
50de7f0682
update rustfmt references to reflect change from submod to subtree ( #1129 )
...
* update rustfmt references to reflect change to subtree
* clarify broken toolstate hypothetical scenario
2021-05-20 15:02:20 +02:00
8faa1646f5
Remove `--stage 1` argument from `doc` invocations ( #1125 )
2021-05-18 19:10:39 +02:00
c989a4db5b
Update coverage docs ( #1122 )
2021-05-13 19:19:43 -07:00
f58dfe98ad
Document -Zunpretty=thir-tree ( #1128 )
...
* document -Zunpretty=thir-tree
* Update position/wording
2021-05-13 20:51:43 +02:00
1e6c7fbda4
Unified CPU Requirements ( #1126 )
2021-05-10 13:38:24 +09:00
5b63bc2fb7
add 'waiting-for-review' incantation to main contrib page ( #1124 )
2021-05-05 13:53:42 +02:00
e72b43a649
Suggest using `git range-diff` ( #1092 )
...
I have found it to be very helpful when rebasing.
2021-04-27 12:35:37 -07:00
ccc286ba87
Add sample nix shell
...
This also suggests using `x.py setup` instead of copying config.toml.
2021-04-27 08:52:22 -04:00
9b0135d306
more RA config suggestions ( #1114 )
2021-04-26 18:34:50 -04:00
2f5927a77e
Add Polymorphisation paper ( #1093 )
2021-04-24 10:53:30 +09:00
8cf042c6f5
Mention unpretty=mir-cfg for debugging MIR
2021-04-23 16:25:11 -04:00
a9bd2bbf31
Improve formatting and update info in "method lookup" section
2021-04-09 18:12:21 -04:00
31e44f4116
Change wording a bit: `module` => `crate`
...
It seems more correct
2021-04-09 10:34:26 -04:00
2c2f61ae19
fix typo ( #1107 )
2021-04-09 12:30:04 +02:00
83b81fdd69
fix typo
2021-04-08 17:29:13 -04:00
871a54568f
Mention CI build of LLVM in build instruction
2021-04-03 22:28:35 -04:00
d1e2f3bf50
Fix rustdocs test command typo ( #1103 )
2021-04-04 01:41:35 +09:00
8d6459ffff
Update the "LLVM updates" section
2021-04-02 05:57:57 -04:00
dfe398bd5a
Fix a link about Rustdoc internals
2021-04-02 05:25:14 -04:00
32c6d27b4b
Add quickstart for adding a new optimization ( #1094 )
2021-04-01 19:24:44 +02:00
dda441c42e
Add back example of {{cwd}} ( #1099 )
...
I force-pushed this in the last commit and accidentally deleted the
github suggestion.
2021-04-01 04:04:46 +09:00
a05852eec0
Document test input normalization
2021-03-31 14:51:19 -04:00
0687daac28
Add notes about nightly rustc version for the rustc-driver examples
2021-03-28 13:33:56 -04:00
9a676ee3a4
Fix rust compiler meeting info ( #1087 )
...
* Remove dead link
* Make general text a bit better
* Fix Zulip link
* Improve description of what the compiler meeting is about
2021-03-19 19:11:43 -04:00
67ebd4b55d
Remove extra the ( #1088 )
2021-03-11 13:36:25 -08:00
e72bf56a45
Fix double-word typos ( #1084 )
...
Inspired by #1079 . I used this command to find these typos:
rg --multiline --pcre2 '\b([a-zA-Z]+) \1\b' src -tmd
There were a couple false positives of the form "that that" meaning
"that it" or "that this".
2021-03-12 03:29:19 +09:00
ff363172f9
I-nominated are nominated for discussion ( #1080 )
...
* I-nominated are nominated for discussion
* Generalize meeting expression
Co-authored-by: Camelid <camelidcamel@gmail.com>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-11 19:05:02 +01:00
0526ce3339
Complete unfinished statement
2021-03-11 13:01:44 -05:00
bfe8e98253
Update lins
2021-03-10 12:00:27 -05:00
872ba49f48
Apply suggestions from code review
...
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-10 12:00:27 -05:00
4c8fdcf511
Add stub about the THIR
2021-03-10 12:00:27 -05:00
912aa00c3b
Adjust a bit better P- label text
2021-03-10 11:35:23 -05:00
f83c57bee6
Fix typos ( #1079 )
2021-03-10 23:56:51 +09:00
0b1bdbb183
Update cmake version in prerequisites.md ( #1077 )
...
LLVM requires at least cmake 3.13.4.
https://www.llvm.org/docs/CMake.html
2021-03-09 20:00:12 +01:00
ddadc67423
Fix typo: suceed -> succeed
2021-03-09 12:37:10 -05:00
91f8f334f4
Add article on using WPA to profile rustc memory usage on Windows ( #1074 )
...
Document how to use WPA to profile rustc and what the normal workflow
should be for investigating bootstrap memory usage issues.
Co-authored-by: Ryan Levick <ryan.levick@gmail.com>
2021-03-09 04:42:56 +09:00
8bb61fe105
Use more accurate estimate of generated LLVM IR with llvm-lines
...
The `--emit=llvm-ir` emits an optimized LLVM IR. For optimized builds it will be
highly inaccurate estimate of the amount IR generated initially. While the
inaccuracy can be somewhat reduce after disabling the optimization, that in turn
has other unintended consequences, since opt-level controls the emission of
lifetime markers, sharing of generics between crates, instantiation of inline
functions, etc.
Use `-Csave-temps` and `no-opt` bitcode as a basis for more accurate estimate of
initial work handed of to the LLVM.
2021-03-07 10:57:13 -05:00
c431f8c29a
Cleanup rustdoc chapters a bit
...
* Rename "The walking tour of rustdoc" to "Rustdoc overview",
which I think is a more accurate name
* Use same name in sidebar TOC as in chapter text
* Make links between the two chapters prominent
* Convert a few `.html` links to `.md`
Probably we should just merge the chapters, but leaving that for later.
2021-02-28 16:35:20 -05:00
3cdb245b43
Fix broken links
2021-02-28 11:01:07 -05:00
1f68820307
Document how to enable CI LLVM without using `x.py setup`
2021-02-26 15:38:01 -05:00
761f92f390
Remove some unrelated changes
2021-02-26 15:38:01 -05:00
b932cf20cf
Fix typos
2021-02-26 15:38:01 -05:00
ca851c6b70
Restore instructions for using system LLVM
...
They were removed in #1030 , but are still useful.
2021-02-26 15:38:01 -05:00
07b5693a90
Update some out-of-date information
2021-02-26 15:38:01 -05:00
033a1ea771
Fixes typo in getting started guide
2021-02-24 21:20:36 -05:00
9214d4a8c3
Fix formatting of more date references ( #1067 )
2021-02-22 18:22:23 +09:00
c0e7305d33
Fix broken links in query.md ( #1068 )
2021-02-21 09:51:34 +01:00
c4c0f33a1d
Update docs from date triage for 2021-02 ( #1048 )
...
The biggest change was updating the list of rustdoc passes. Several new
ones have been added since that documentation was written, so I added
those, and I also sorted the list so it is roughly alphabetical (except
for the part for the `strip-*` passes, which I left in the same order
since one of the list items has two passes so there's no "correct"
order).
2021-02-20 19:27:24 -08:00
5297659bb1
Fix date-check comment formatting ( #1066 )
...
I realized that the format I had been previously using for date-checks
(as of January 2021 <!-- date: 2021-01 -->)
left a space before the closing parenthesis in the rendered output,
which looks weird.
I could fix this by removing the space between `2021` and `<!-- ...`,
but that looks weird in the source. So I ended up deciding on changing
it to
(as of <!-- date: 2021-01 --> January 2021)
2021-02-20 19:24:01 -08:00
f5eea60da7
Make "URL" show up ( #1065 )
...
* Make "URL" show up
* Use `<URL>`
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-02-20 13:58:22 +01:00
fba44ed2fa
Point to main branch on llvm-project's links
2021-02-19 20:25:36 -05:00
42a531c1eb
Fix typo ( #1063 )
2021-02-18 19:37:43 +01:00
5b2ef08416
Update running.md
2021-02-17 17:13:07 -05:00
3708c8227a
Add Oxide paper to bibliography
2021-02-15 10:14:03 -05:00
f525bc8071
Fix typo
2021-02-07 22:12:28 -05:00
219813a75c
Fix typo in Bug Fix Procedure ( #1050 )
2021-02-07 11:15:54 -05:00
95c3930c67
Add chapter on libs and metadata. ( #1044 )
2021-02-04 11:34:52 -05:00
5e57035110
Add lots of date-check annotations
...
Also added dates for things that previously said "as of now" or "as of
this writing" and cleaned up a couple of things along the way.
2021-02-03 19:29:07 -05:00
bd008cc786
Document how to stabilize a library feature ( #1036 )
...
* Move 'force-unstable-if-unmarked' to the bootstrapping chapter
* Document how to stabilize a library feature
Note that features can't be stabilized until they go through FCP and
that FCP happens on the tracking issue, not the PR.
* Fix wrong glob
By default `**` behaves the same as two `*` side by side, i.e. it only
globs file paths, not directories. `shopt -s globstar` needs to be set
for it to mean a directory. I didn't notice this before now because
`globstar` is set by default in interactive mode, but not otherwise.
2021-02-01 19:31:00 +01:00
85c995de1b
Update test suite descriptions. ( #1042 )
2021-01-30 20:12:01 +09:00
de386fd48a
put `x.py` in ticks
2021-01-30 10:59:57 +02:00
93a25a9fb7
Update links to `librustc_llvm` and `rustllvm`
2021-01-24 08:18:34 -05:00
697dba3bb7
Add link to promotion.md ( #1033 )
...
* Add link to promotion.md
* Improve link text
Co-authored-by: Camelid <camelidcamel@gmail.com>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-01-22 11:49:52 +01:00
d88726cd19
Add missing period
2021-01-21 14:26:25 -05:00
4e48f42e05
Remove "Skipping LLVM build" section
...
`download-ci-llvm` is available and enabled by default for all tier 1
platforms, so there is no need to change it. Using system LLVM over CI
llvm is still supported, but is not recommended. Building LLVM from
source is still supported.
This also notes that you need to explicitly disable downloading LLVM
when updating the submodule.
2021-01-20 13:45:05 -05:00
bee2fd52ce
Add mdbook-toc, markers, and documentation ( #1028 )
...
* Add mdbook-toc to travis, book.toml and documentation
* Add toc markers
* Whitespace cleanup and some punctuation
* Addressed comments
2021-01-20 14:33:11 -03:00
bd8e94a001
Link to `feature_err` in stability section ( #1022 )
2021-01-19 11:47:45 -08:00
a090b28d8e
Fix typo ( #1027 )
2021-01-17 11:50:04 -03:00
176bbba4bf
Note that `--check` now allows using any stage
2021-01-17 05:51:00 +02:00
93fcae6322
improved the readablity of a line
2021-01-16 12:04:07 -05:00
c87ef62351
Fixed a grammatical error in hardawre requirements section
2021-01-16 10:03:23 -05:00
7ea20079df
Corrected MIR file path and fixed a typo ( #1020 )
2021-01-14 14:10:08 -08:00
3e731b7934
Add a note about UI test entry limitation ( #1019 )
2021-01-12 07:55:13 +09:00
0a5bb7f5e6
Add context to dated information ( #1013 )
...
* Fixes #924 Add context to dated information
* Fixes #924 Addressed comments and some uses of 'currently'
* Update src/contributing.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
* Update src/salsa.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
* Fixes #924 Addressed comments
* Fixes #924 Fixed line lengths.
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-10 19:23:22 -03:00
e7ac2ff724
Update 'Workspace structure' section ( #1017 )
...
* Update description of `src/`
* Note that `library/` also contains the Rust runtime
2021-01-10 16:19:39 -05:00
d87e197f26
Point to `HirId` instead of `NodeId`
2021-01-09 21:05:10 -05:00
ba9259eaaf
Fix typo ( #1016 )
...
"currenty"!
2021-01-09 17:18:57 -08:00
ed721052a6
Break up long line
2021-01-05 16:13:58 -05:00
a62429b367
Remove backticks and comment about possible bug
2021-01-05 16:13:58 -05:00
df8df90fe9
Update src/compiler-debugging.md
...
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-05 16:13:58 -05:00
468faaea87
Make instructions for configuring compiler for debug more explicit
2021-01-05 16:13:58 -05:00
92e47a0559
Remove old sentence that should have been removed
...
It was mistakenly not removed in #997 .
2021-01-04 22:43:03 -05:00
49f1ed8d77
Fix "Potential incomplete link" error on compiler-debugging.md
2021-01-04 20:12:37 -05:00
11b83ebb5a
Add link to rust-analyzer docs on getting started page
2021-01-04 10:09:49 -05:00
a0819a6d98
Fix some typos
2021-01-04 10:02:33 -05:00
de3bdce4b8
Tweak wording around provider purity
2021-01-03 22:31:09 -05:00
64c4632faf
Fix typo (reflex -> reflect)
2021-01-02 09:25:03 -05:00
541976f658
Clarify that `check` uses a different stage than `build` ( #999 )
2021-01-01 20:59:23 +00:00
148742b6ce
Fix broken link for `BoundRegion` ( #998 )
2020-12-31 01:13:49 +01:00
f2e7d46f28
Update logging section and explain `RUSTC_LOG_COLOR` ( #997 )
...
* Update logging section and explain `RUSTC_LOG_COLOR`
* Small fixes
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
* Mention that prefixes of paths work as log filters
* `=debug` matches `debug!` *and higher*
* Note that `MIRI_LOG_COLOR` only applies to logs from Miri
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-31 01:08:00 +01:00
e7da4fd769
Fix broken link in the contributing guide ( #996 )
2020-12-29 21:08:55 +01:00
Tshepang Mbambo
Joshua Nelson
Martin Nordholts
Santiago Pastorino
Yutaro Ohno
Daniel Xu
Ralf Jung
David Wood
EdwinRy
Alcaro
Omer Tuchfeld
Edwin Rybarczyk
Eric Huss
lcnr
Jonas Schievink
Andrew Dona-Couch -- GitHub drop ICE
Yuki Okushi
pierwill
Waffle Maybe
Jacob Pratt
Soroush Zare
Ali MJ Al-Nasrawy
Who? Me?!
printfn
Felix S Klock II
scottmcm
Frank Steffahn
Eric Holk
David Wood
Matthew Woodcraft
Ivor Wanders
Noah Lev
Hongbo
xFrednet
skippy10110
Guillaume Gomez
Chayim Refael Friedman
James Cole
Téo Bouvard
Samuel Moelius
Raoul Strackx
Yuki Okushi
Manish Goregaokar
Ivor Wanders
Amanieu d'Antras
Georgiy Komarov
Nicholas Nethercote
Ben Reeves
Wang Qilin
Maxwell Elliot Heiber
Badel2
Jacob Hoffman-Andrews
Lucas Kent
Rich Kadel
Dylan MacKenzie
Ken Matsui
chubei
asquared31415
Dmitry Savintsev
Caleb Cartwright
pierwill
Janggun Lee
Ramon de C Valle
Rémy Rakic
Joshua Nelson
Yusuke Abe
Tomasz Miąsko
Oli Scherer
Dave Farnham
Sl1mb0
Andrey Cherkashin
Dezhi Wu
sjud
Frank Steffahn
Smittyvb
Rahul Butani
Bryan Cantrill
Yoh Deadfall
the8472
Dave
bjorn3
Eric Holk
Joshua Nelson
Ryan Levick
Ryan Levick
Josh Triplett
Jesús Hernández
二手掉包工程师
Oli Scherer
Jade
Gus Wynn
Michael Woerister
Caleb Cartwright
Justus K
Nixon Enraght-Moony
AngelicosPhosphoros
JohnTitor
Léo Lanteri Thauvin
Wesley Wiser
Daniel Santos
Hirochika Matsumoto
r00ster
dmezh
bstrie
Yusuke Tanaka
Henry Boisdequin
Iñaki Garay
Martin Geisler
ashosive
saki-osive
saki-osive
Ryan Levick
Sebastian Widua
Laurențiu Nicola