about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
AgeCommit message (Collapse)AuthorLines
2025-04-19improve readability by adding pausesTshepang Mbambo-4/+4
2025-04-19fix grammarTshepang Mbambo-1/+1
2025-04-19needed a stronger pauseTshepang Mbambo-1/+2
2025-04-19Rollup merge of #138934 - onur-ozkan:extended-config-profiles, r=KobzolChris Denton-0/+37
support config extensions _Copied from the `rustc-dev-guide` addition:_ >When working on different tasks, you might need to switch between different bootstrap >configurations. >Sometimes you may want to keep an old configuration for future use. But saving raw config >values in >random files and manually copying and pasting them can quickly become messy, especially if >you have a >long history of different configurations. > >To simplify managing multiple configurations, you can create config extensions. > >For example, you can create a simple config file named `cross.toml`: > >```toml >[build] >build = "x86_64-unknown-linux-gnu" >host = ["i686-unknown-linux-gnu"] >target = ["i686-unknown-linux-gnu"] > > >[llvm] >download-ci-llvm = false > >[target.x86_64-unknown-linux-gnu] >llvm-config = "/path/to/llvm-19/bin/llvm-config" >``` > >Then, include this in your `bootstrap.toml`: > >```toml >include = ["cross.toml"] >``` > >You can also include extensions within extensions recursively. > >**Note:** In the `include` field, the overriding logic follows a right-to-left order. For example, in `include = ["a.toml", "b.toml"]`, extension `b.toml` overrides `a.toml`. Also, parent extensions always overrides the inner ones. try-job: x86_64-mingw-2
2025-04-19Merge pull request #2346 from folkertdev/bootstrap-in-dependencies许杰友 Jieyou Xu (Joe)-0/+54
2025-04-19document `#[cfg(bootstrap)]` in dependenciesFolkert de Vries-0/+54
2025-04-19fix broken linkTshepang Mbambo-1/+1
2025-04-19Merge from rustcThe rustc-dev-guide Cronjob Bot-59/+91
2025-04-19Preparing for merge from rustcThe rustc-dev-guide Cronjob Bot-1/+1
2025-04-19toolchain version does not need to be specifiedTshepang Mbambo-3/+3
- Rust backcompat removes the need to specify the version here - Using these commands can result in a needless toolchain getting downloaded, like in the case where user only has Nightly installed
2025-04-19readme: be copy-paste friendlyTshepang Mbambo-7/+7
2025-04-18fix(docs): add newlines between prefix/suffix chaptersHaowei Hsu-0/+5
add newlines between prefix/suffix chapters in SUMMARY.md to ensure correct extraction by mdbook-i18n-helpers.
2025-04-17upstream autodiff build instructionsManuel Drehwald-0/+87
2025-04-17rustc-dev-guide: document `//@ ignore-auxiliary`Jieyou Xu-0/+5
2025-04-17Merge pull request #2339 from rust-lang/autodiff-docs许杰友 Jieyou Xu (Joe)-0/+214
2025-04-17add a first version of autodiff docsManuel Drehwald-0/+214
2025-04-17Rollup merge of #139770 - nnethercote:rename-LifetimeName, r=BoxyUwUMatthias Krüger-4/+4
Rename `LifetimeName` as `LifetimeKind`. It's a much better name, more consistent with how we name such things. Also rename `Lifetime::res` as `Lifetime::kind` to match. I suspect this field used to have the type `LifetimeRes` and then the type was changed but the field name remained the same. r? ``@BoxyUwU``
2025-04-16Merge pull request #2337 from xizheyin/sync-codeJakub Beránek-0/+14
Remind to update dev branch while behind too many commits
2025-04-16Remind to update dev branch while behind too many commitsxizheyin-0/+14
Signed-off-by: xizheyin <xizheyin@smail.nju.edu.cn>
2025-04-16Improve `borrowck_graphviz_*` documentation.Nicholas Nethercote-1/+2
In particular, `borrowck_graphviz_preflow` no longer exists.
2025-04-16Rename `LifetimeName` as `LifetimeKind`.Nicholas Nethercote-4/+4
It's a much better name, more consistent with how we name such things. Also rename `Lifetime::res` as `Lifetime::kind` to match. I suspect this field used to have the type `LifetimeRes` and then the type was changed but the field name remained the same.
2025-04-15document `include` in `bootstrap.example.toml`onur-ozkan-2/+3
Signed-off-by: onur-ozkan <work@onurozkan.dev>
2025-04-15document config extensionsonur-ozkan-0/+36
Signed-off-by: onur-ozkan <work@onurozkan.dev>
2025-04-14Merge pull request #2333 from rust-lang/convetions-chapt-cleaningTshepang Mbambo-32/+33
Coding conventions chapter cleaning
2025-04-14clean "Coding conventions" chapterTshepang Mbambo-32/+33
- use correct code block markers - add missing title - rustfmt can now use edition setting in its config ... and this is set in Rust repo - reduce visual noise - needless repetition - convention is to start sentence with upper case - sembr - whitespace - semi-heading not adding much value - fix grammar
2025-04-14Documentation fixes.Nicholas Nethercote-25/+19
Remove old references to the HIR map.
2025-04-13Merge pull request #2334 from rust-lang/consistency许杰友 Jieyou Xu (Joe)-45/+44
2025-04-13tests: document `-A {unused,internal_features}` ui test mode presetsJieyou Xu-0/+23
2025-04-13Rollup merge of #139618 - petrochenkov:virsugg, r=jieyouxuChris Denton-17/+39
compiletest: Make `SUGGESTION` annotations viral If one of them is expected in a test file, then others should be annotated as well, in the same way as with `HELP`s and `NOTE`s. This doesn't require much of an additional annotation burden, but simplifies the rules. r? ```@jieyouxu```
2025-04-12Enable [canonicalize-issue-links] and [no-mentions] in triagebot.tomlUrgau-0/+4
2025-04-12use consistent title capitalizationTshepang Mbambo-45/+44
2025-04-12fix pathTshepang Mbambo-1/+1
2025-04-12Merge pull request #2330 from rust-lang/tshepang-patch-5Tshepang Mbambo-3/+3
date-check rdg contribution section
2025-04-12date-check rdg contribution sectionTshepang Mbambo-3/+3
2025-04-12Merge pull request #2327 from rust-lang/tshepang-patch-1许杰友 Jieyou Xu (Joe)-1/+1
2025-04-12Merge pull request #2329 from rust-lang/tshepang-patch-4Tshepang Mbambo-1/+1
add missing word
2025-04-12add missing wordTshepang Mbambo-1/+1
2025-04-12remove implied textTshepang Mbambo-1/+1
"how much to trust" implies the opposite
2025-04-12use more simple languageTshepang Mbambo-1/+1
Not obvious what "sort by" means
2025-04-12ease copy-pasteTshepang Mbambo-2/+4
2025-04-12Update "crater" link to actually point to crater.mdFreya Arbjerg-1/+1
2025-04-11Document that `opt-dist` requires metrics to be enabledJakub Beránek-2/+7
2025-04-11Merge pull request #2320 from smanilov/patch-1Tshepang Mbambo-14/+22
Update table of contents in about-this-guide.md
2025-04-11Update table of contents in about-this-guide.mdStan Manilov-14/+22
1. added two new parts: Bootstrapping and Supporting Infrastructure; 2. touched up names of pre-existing parts, to match actual names in sidebar; 3. syntactic nits (start description of Analysis with a capital letter); and 4. make numbered list use only 1. Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2025-04-11Auto merge of #139578 - ferrocene:pa-compiletest-edition, r=jieyouxubors-8/+8
Fix breakage when running compiletest with `--test-args=--edition=2015` Compiletest has an `--edition` flag to change the default edition tests are run with. Unfortunately no test suite successfully executes when that flag is passed. If the edition is set to something greater than 2015 the breakage is expected, since the test suite currently supports only edition 2015 (Ferrous Systems will open an MCP about fixing that soonish). Surprisingly, the test suite is also broken if `--edition=2015` is passed to compiletest. This PR focuses on fixing the latter. This PR fixes the two categories of failures happening when `--edition=2015` is passed: * Some edition-specific tests set their edition through `//@ compile-flags` instead of `//@ edition`. Compiletest doesn't parse the compile flags, so it would see no `//@ edition` and add another `--edition` flag, leading to a rustc error. * Compiletest would add the edition after `//@ compile-flags`, while some tests depend on flags passed to `//@ compile-flags` being the last flags in the rustc invocation. Note that for the first category, I opted to manually go and replace all `//@ compile-flags` setting an edition with an explicit `//@ edition`. We could've changed compiletest to instead check whether an edition was set in `//@ compile-flags`, but I thought it was better to enforce a consistent way to set the edition in tests. I also added the edition to the stamp, so that changing `--edition` results in tests being re-executed. r? `@jieyouxu`
2025-04-11Fix link to rustc_* TEST attributes in ui.mdStan Manilov-1/+1
2025-04-10dev-guide: Document `dont-require-annotations`Vadim Petrochenkov-17/+39
and its use cases in more detail
2025-04-10mention --edition restrictions in rustc-dev-guidePietro Albini-8/+8
2025-04-10rustc-dev-guide: document `needs-crate-type`Jieyou Xu-1/+6
2025-04-09Remove redundant wordstimesince-1/+1