Commit Graph

2369 Commits

Author SHA1 Message Date
Kajetan Puchalski 34a13c2e52 building/suggested: Add instructions for Emacs & Helix (#2080)
Co-authored-by: 许杰友 Jieyou Xu (Joe) <39484203+jieyouxu@users.noreply.github.com>
2024-09-28 20:09:48 +08:00
Christopher Speir de2f32e59c Fix file paths to section 35.1 & 35.2 example code (#2078) 2024-09-25 22:18:50 +08:00
Noratrieb eca2a904d1 elaborate on warnings 2024-09-24 20:59:54 +02:00
Yuri Astrakhan 9303d5b017 Apply suggestions from code review
Co-authored-by: 许杰友 Jieyou Xu (Joe) <39484203+jieyouxu@users.noreply.github.com>
2024-09-24 20:59:54 +02:00
Yuri Astrakhan c923ae6187 Clarify how to disable warnings in deps 2024-09-24 20:59:54 +02:00
Tbkhi 8bac43ba1e Update compiler-src.md
Various link additions and minor edits for clarity.

revisions

fix line length

adding links

minor edits
2024-09-24 20:57:06 +02:00
León Orell Valerian Liehr b80083b5c0 Update rustdoc build instructions 2024-09-24 20:47:22 +02:00
Noratrieb 8a5ec724fd minor edits 2024-09-24 20:46:07 +02:00
Tbkhi dabf6dabde doc edits 2024-09-24 20:46:07 +02:00
Tbkhi 5658f05dfc Update salsa.md
Formatting updates.
2024-09-24 20:46:07 +02:00
Tbkhi f5594304c2 Update memory.md
Minor updates to formatting.

documentation updates

Update memory.md

minor edits
2024-09-24 20:43:37 +02:00
Noratrieb fa8e2b4794 minor edits 2024-09-24 20:33:04 +02:00
Tbkhi 6803fdb36b updates documentation 2024-09-24 20:33:04 +02:00
Tbkhi fb88f31f79 Update serialization.md
Minor documentation updates.
2024-09-24 20:33:04 +02:00
Tbkhi 1374a2ab4a improve rustc-driver.md
minor addition and adding links

Update rustc-driver.md

removing parens for functions

reorganized directory

reorganized directory

minor edits
2024-09-24 20:29:07 +02:00
Noratrieb f92166e2b5 minor edits 2024-09-24 20:21:23 +02:00
Tbkhi dc74644c7d Update syntax-intro.md 2024-09-24 20:21:23 +02:00
Noratrieb 58f95e3d49 minor edits 2024-09-24 20:19:59 +02:00
Tbkhi 763a2bee2f Update the-parser.md 2024-09-24 20:19:59 +02:00
Tbkhi 41c4e9c988 Update the-parser.md 2024-09-24 20:19:59 +02:00
Noratrieb 04480082ad Minor edits 2024-09-24 20:16:28 +02:00
Tbkhi b956638072 Update macro-expansion.md 2024-09-24 20:16:28 +02:00
Tbkhi c6fed1ee39 Update macro-expansion.md 2024-09-24 20:16:28 +02:00
Tbkhi 027c805e5c additional changes to links and some text 2024-09-24 20:16:28 +02:00
Tbkhi 07aa8b109f Update macro-expansion.md
removing parens
2024-09-24 20:16:28 +02:00
Tbkhi 5676ddd217 Update macro-expansion.md 2024-09-24 20:16:28 +02:00
Noah Lev f09dd295ae Use 2021 edition for example code playground link
The playground defaults to 2015. Might as well use the latest edition.
2024-09-24 20:15:12 +02:00
Noah Lev 25ad416da4 Move example code block to paragraph referencing it
Noticed by Mario Carneiro.
2024-09-24 20:15:12 +02:00
Noratrieb 70477c40f8 Minor edits
- un-codeblock some words
- uncomment the last paragraph (it's useful to know this)
2024-09-24 20:07:57 +02:00
Tbkhi 8b9408e49f Update name-resolution.md 2024-09-24 20:07:57 +02:00
Tbkhi 1cbd715177 Update name-resolution.md 2024-09-24 20:07:57 +02:00
Felix Rath cd32af3b6a feat: Add section about partial clones with `git clone --filter='blob:none'` 2024-09-24 19:59:44 +02:00
dianne a1c37098dc mention rustc's stable-through-unstable bug being fixed 2024-09-24 19:57:58 +02:00
trevyn 4040f38175 Fix `is_diagnostic_item()` example 2024-09-24 19:56:37 +02:00
许杰友 Jieyou Xu (Joe) f56b9b0a44 Revise wording to not imply *only* Python 3.10 can be installed 2024-09-24 19:55:07 +02:00
nora 15da3b9246 Update src/tests/compiletest.md 2024-09-24 19:54:06 +02:00
许杰友 Jieyou Xu (Joe) d871e70475 Document `crashes` test suite
Describe procedure for adding new crashes tests and removing crashes
tests when the crash is intentionally fixed.

Also mention setting `COMPILETEST_VERBOSE_CRASHES=1` env var for verbose
crashes test output.
2024-09-24 19:54:06 +02:00
Vetle Rasmussen 06f9ccf1f2 Fix getting diagnostics example 2024-09-24 19:53:51 +02:00
dianne c852d1c693 Document `#[rustc_default_body_unstable]` 2024-09-24 19:53:17 +02:00
许杰友 Jieyou Xu (Joe) e3451dc015 Describe `.git-blame-ignore-rev` 2024-09-24 19:51:44 +02:00
许杰友 Jieyou Xu (Joe) 6e8fc18158 Note lldb debuginfo requires `python310.dll` to be present in `PATH` 2024-09-24 19:49:14 +02:00
Marco Ieni a66f8b1a36 chore: add missing `.` (#2074) 2024-09-23 20:51:33 +08:00
许杰友 Jieyou Xu (Joe) baf5c020a3 Add remark on required free disk space (#2073) 2024-09-23 20:11:47 +08:00
Max Heller 5d8ddf98bb fix broken links (#2063) 2024-09-23 16:47:44 +08:00
许杰友 Jieyou Xu (Joe) 8d9a7a8b13 Add advice about submitting potentially hard-to-review PRs (#2036) 2024-09-23 16:46:49 +08:00
joculatrix 0810cd3c34 Edit a sentence for clarity (#2071) 2024-09-23 12:02:25 +08:00
adwin db6f8ad56d Emphasize how to run a single tool test (#2070) 2024-09-20 15:10:29 +08:00
Santiago Pastorino d80226941e Remove chalk is owned by WG-traits 2024-09-18 17:48:40 -04:00
Santiago Pastorino d6c5ed5c47 Fix conditions lowering text for enums with no fields (#2066) 2024-09-18 08:45:24 +08:00
lcnr acee479aee update proof tree chapter (#2054)
* update proof tree chapter

* uwu

* cool beans
2024-09-17 06:45:13 +02:00
Michael Howell 33731b7569 Further clarification 2024-09-15 14:53:28 -04:00
Michael Howell 41b9c6cc57 Specify, more explicitly, the default behavior 2024-09-15 14:53:28 -04:00
Michael Howell a233a7ddcb Update src/rustdoc-internals/search.md
Co-authored-by: Guillaume Gomez <guillaume1.gomez@gmail.com>
2024-09-15 14:53:28 -04:00
Michael Howell 6bf7f54861 Clean up misleading language 2024-09-15 14:53:28 -04:00
Michael Howell 305fbac89a Minor wording improvements 2024-09-15 14:53:28 -04:00
Michael Howell 953292a349 Add docs for JS tests 2024-09-15 14:53:28 -04:00
dianne c83a18cc76 Reflect `x.py test`'s `--rustc-args` option being renamed to `--compiletest-rustc-args` (#2062) 2024-09-12 09:58:27 +08:00
Tshepang Mbambo 3525f6f1aa we standardized on this more reliable command (#2061) 2024-09-11 02:58:06 +08:00
Veera 3d59d4f511 Fix Typo and Remove Outdated Line About C Variadics
This PR does two minor fixes:
1. Removes the line "c-variadic functions are declared with at least
one named argument" since it is no longer true since 124048 got
merged.

2. Fixes typo: "lingint" -> "linting".
2024-09-10 09:32:10 +02:00
cui fliter e012229e1e fix some comments (#2059)
Signed-off-by: cuishuang <imcusg@gmail.com>
2024-09-09 12:58:45 +02:00
Prashanth Mundkur 33c8ae55b7 Fix a link and create an implied internal link (#2051) 2024-09-09 00:15:41 +08:00
Tshepang Mbambo e22d05ae17 link to additional LLVM update PRs (#2055) 2024-09-09 00:13:44 +08:00
Tshepang Mbambo a8f2415953 fix/improve rdg contributing howto (#2056) 2024-09-09 00:13:14 +08:00
Bilal Khan 5b39f1293b fixed the typo (#2058) 2024-09-08 11:51:11 -04:00
jdonszelmann 9dea4cfc76 fix typo maker -> marker (thanks @lholten) 2024-09-08 14:01:27 +02:00
Jonathan Dönszelmann 4e0755f384 improve query system documentation (#2041)
* improve query system documentation

* fix typo messages => message

* Update src/queries/incremental-compilation-in-detail.md

Co-authored-by: lcnr <rust@lcnr.de>

---------

Co-authored-by: lcnr <rust@lcnr.de>
2024-09-06 16:23:23 +02:00
Jonathan Dönszelmann 1239ad3da0 add section on overlap checks (#2042)
* add section on overlap checks

* fix some typos

* merge piece on overlap checks with docs about coherence (based on review comments)

* fix comments after discussion
2024-09-06 16:03:43 +02:00
Ralf Jung 7a37519254 clarify the role of rustc_const_unstable 2024-08-31 15:02:08 +02:00
Marc Poulhiès 45e3b9d6b2 Fix x.py reference
Trivial fix to change `x.py` into `x`
2024-08-26 16:46:50 +02:00
Folkert de Vries 3f3aabc749 Update `stabilization_guide.md` (#2034) 2024-08-24 02:46:04 +08:00
León Orell Valerian Liehr 27bca443ca Explain the internal `#[rustc_*]` TEST attributes used for debugging and inside tests (#2046) 2024-08-24 01:58:50 +08:00
Tshepang Mbambo 80c0794aae missing char (#2047) 2024-08-22 22:43:28 +02:00
Prashanth Mundkur d196a77485 Replace direct http links to rustc-dev-guide.rust-lang.org to relative links to the corresponding md source files. (#2044)
Use relative links to the corresponding md source files; this helps local browsing of generated docs.
2024-08-21 11:54:39 -07:00
flash be6899e3fd fix typo (#2043)
line 320:
original: "valtree back a to MIR constant"
updated: "valtree back to a MIR constant"
2024-08-20 02:08:49 +08:00
Nikita Popov 9c427609af Update LLVM docs (#2039)
* Update LLVM docs

* Apply feedback
2024-08-12 18:07:49 -03:00
GabrieleC07 c156104dbe Added 'the' in chapter "Running test" subtitle "Run unit tests on the compiler/library" (#2040) 2024-08-09 01:54:27 +08:00
xFrednet bacd3c57b1 Review comments <3 2024-08-07 20:32:37 -07:00
xFrednet 91f2d11e9c Correct rust code block in *Dataflow Analysis* 2024-08-07 20:32:37 -07:00
riyueguang e6d8737cb1 chore: fix some comments
Signed-off-by: riyueguang <rustruby@outlook.com>
2024-07-30 08:04:13 +02:00
Martin Liška 9a13c75f11 linkcheck: fix reported broken links (part 2) (#2024)
* linkcheck: fix reported broken links (part 2)

* Apply suggestions from code review

Co-authored-by: León Orell Valerian Liehr <me@fmease.dev>

* Fix mir::Constant link target

* Fix borked links

* Fix one more link name

* Exclude 2 links from checking

* Fix exclude patterns in book.toml

* Fix comment

* Fix rmake-tests URL

* Apply suggestions from code review

Co-authored-by: León Orell Valerian Liehr <me@fmease.dev>

---------

Co-authored-by: León Orell Valerian Liehr <me@fmease.dev>
2024-07-27 14:45:57 +02:00
Tshepang Mbambo ab06b10c89 typo (#2029) 2024-07-26 15:31:20 -07:00
Stuart Cook 47b72731d7 Fix broken links in `llvm-coverage-instrumentation.md` (#2027) 2024-07-26 21:19:51 +08:00
Jakub Beránek 04317739eb Fix invalid link to toolstate documentation (#2021) 2024-07-24 20:02:10 +08:00
Martin Liška fb1d8b872c linkcheck: fix reported broken links (part 1) (#2022) 2024-07-24 20:01:25 +08:00
lcnr b48843216e fix link 2024-07-24 13:08:53 +02:00
Martin Liska 4ee24c9286 MIR docs: fix borked links and update style
Changes applied:
- updating-llvm.md: make consistent style in a listing
- CleanupNonCodegenStatements - renamed to CleanupPostBorrowck
- SimplifyCfg - fix link target (it is an enum now)
- LocalUseVisitor - replaced with another existing Visitor
- PGO in LLVM - embed link
2024-07-24 05:03:16 +02:00
10takla 2006cc8a83 Update adding.md (#2016)
Add `@' to the test header edition:2018
2024-07-19 15:15:12 +08:00
Jaic1 03dfd90ce5 refine mir passes doc 2024-07-15 17:16:43 +02:00
Jaic1 bd44a1714a Typo in src/mir/passes.md
accidently -> accidentally

Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2024-07-15 17:16:43 +02:00
chj 2f8dd37f16 Improve doc of MIR queries & passes 2024-07-15 17:16:43 +02:00
Noah Lev 04ffdc24ec Fix typo: lists -> lints (#2011)
It's a bit of a tongue-twister it seems.
2024-07-08 21:28:55 +00:00
onur-ozkan 06ca6d1e6e use "bootstrap" instead of "rustbuild"
Let's stick with the single name "bootstrap" to refer to the bootstrap project to avoid confusion.

Signed-off-by: onur-ozkan <work@onurozkan.dev>
2024-07-06 23:28:20 +02:00
Arjun Patel 722e2539e6 Fix grammar issue in optimize-build.md (#2009) 2024-07-02 11:05:55 +08:00
Tyler Mandry 625c6a9cc9 Update name of Fuchsia builder (#2008) 2024-07-01 21:05:14 +02:00
Urgau 194f5fe227 Update new target check-cfg instructions 2024-07-01 12:51:26 +02:00
Jakub Beránek 8d3431a961 Add link to integration tests list 2024-07-01 00:31:56 +02:00
Jakub Beránek 304f99d079 Add Rust for Linux integration tests documentation 2024-07-01 00:31:56 +02:00
Tyler Mandry a8837a54bd Add docs for building Fuchsia locally and in CI (#1989) 2024-06-28 23:12:08 +02:00
DianQK 3f1e015a75 provide `libstdc++.so.6` through `LD_LIBRARY_PATH` 2024-06-27 16:15:59 +02:00
许杰友 Jieyou Xu (Joe) b97fd6c266 tests: document how to run `run-make` on Windows (#2002) 2024-06-24 05:21:15 +00:00
许杰友 Jieyou Xu (Joe) 46dc1c7033 tests/headers: document `needs-symlink` (#2001)
Added in <https://github.com/rust-lang/rust/pull/126862>.
2024-06-24 04:31:35 +00:00
Yosh 079c8d4d7a Rename `wasm32-wasi` to `wasm32-wasip1` 2024-06-23 20:21:42 +02:00
Aaron Hill f2000b880e Document inert vs active attributes (#1110)
* Document inert vs active attributes

This PR adds a subsection to the 'Syntax and AST' section describing
inert vs active attributes.

For consistency, I've also updated the '#[test] implementation' page to
stop referring to `#[test]' as a 'built in' attribute, since that has a
specific meaning defined on this page.

* Update src/attributes.md

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* Update src/attributes.md

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* Update src/attributes.md

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* Update src/attributes.md

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* Update src/attributes.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update src/test-implementation.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update src/attributes.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update src/test-implementation.md

* Update src/test-implementation.md

* Update src/test-implementation.md

---------

Co-authored-by: Nilstrieb <48135649+Nilstrieb@users.noreply.github.com>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2024-06-23 16:09:09 +02:00
许杰友 Jieyou Xu (Joe) e69bb74b2e docs: document hard-resetting submodules 2024-06-19 20:14:28 +02:00
León Orell Valerian Liehr de583d2b44 Fix note about compiletest header `rustfix-only-machine-applicable` (#1998) 2024-06-18 23:50:10 +01:00
许杰友 Jieyou Xu (Joe) 38b6a5cf3e docs: mention RUSTC_ICE=0 to suppress ICE file 2024-06-18 19:24:17 +01:00
onur-ozkan f3618f3dd5 tell about `STAGE0_MISSING_TARGETS` for new targets
We just realized that the bootstrap target sanity check isn't documented anywhere,
and it would be quite exhausting to learn this manually through a series of failing CI builds.

Signed-off-by: onur-ozkan <work@onurozkan.dev>
2024-06-16 08:39:57 +02:00
Jakub Beránek 265c59a42c Rewrite CI documentation 2024-06-13 15:14:55 +02:00
Stuart Cook c2eb5560d2 Compiletest docs for recently-added features (#1994)
* Docs for `needs-forced-clang-based-tests` (was `needs-matching-clang`)

* Docs for `aux-codegen-backend`

* Docs for `{{sysroot-base}}` and `{{target-linker}}`
2024-06-12 15:58:02 +01:00
Lukas Wirth 93acb2dd7f Add {{target}} to header substitutions 2024-06-12 15:59:20 +02:00
许杰友 Jieyou Xu (Joe) cf49c91585 run-make: add tip about quick-compile with stage0 rustc 2024-06-10 13:49:19 +02:00
erikdesjardins 8e290bc634 Mention `COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS` in `needs-llvm-components` documentation (#1990) 2024-06-10 12:41:47 +01:00
Jakub Beránek f369e78b56 Add run-make port initiative to the Recurring work section (#1992) 2024-06-09 09:57:13 +01:00
Stuart Cook 62990d0e5e Document the `//@ unused-revision-names:` test header (#1991) 2024-06-08 13:13:44 +01:00
听寒 c62f870bd9 Fix dead links (#1988)
* fix dead links in memory.md

* fix dead links in ty_module/generic_arguments.md

* Update src/memory.md

use .md instead of .html for self-links

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

---------

Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2024-06-03 23:15:15 -07:00
听寒 06a3f3bed1 should use `&` to load completions for PowerShell (#1978) 2024-06-04 06:31:05 +01:00
Boxy 43eaf6d559 Reviews 2024-05-31 01:27:28 +01:00
Boxy 89536d8e5b Rewrite the "representing types" section to be more comprehensive 2024-05-31 01:27:28 +01:00
Boxy fa325b1081 Introduce chapter for defining generic parameters 2024-05-31 01:27:28 +01:00
onur-ozkan 1f915f11d8 sync the stage0 filename
Signed-off-by: onur-ozkan <work@onurozkan.dev>
2024-05-25 15:42:06 -07:00
Jakub Beránek b9e2e86bbb Add Rust for Linux notification group entry 2024-05-25 15:40:04 -07:00
surechen e5c589981c fix some typos 2024-05-21 11:56:12 +02:00
Boxy f2754a4fa9 add a high level explanation, and remove a disclaimer (#1982) 2024-05-17 19:04:58 +02:00
David Archibald 4ab266716b Fix broken link to "Lowering" 2024-05-17 12:15:36 +02:00
gstjepan2 27f021bcb5 Fix broken link 2024-05-16 04:53:03 +02:00
Jakub Beránek 43e0bcae52 Add note about how to pick up abandoned PRs 2024-05-15 19:59:36 +02:00
Ardi 8b88776316 Toc here is overkill 2024-05-15 09:45:05 +02:00
许杰友 Jieyou Xu (Joe) 34b055b8f8 Link to lint L-* labels 2024-05-13 20:09:18 +02:00
Matthew Woodcraft 0bfce7989f Update the rustc_interface examples for current rustc (#1974) 2024-05-11 00:06:30 +01:00
surechen 4f5d764758 Edit `Parameter Environments`'s url as it has been edited in #1953 2024-05-09 15:22:03 +02:00
Urgau d0cd4f5dbb Improve FALSE sentence
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2024-05-06 08:48:21 +02:00
Urgau f4c400cdf2 Add documentation for check-cfg by-default in UI tests 2024-05-06 08:48:21 +02:00
Mads Marquart b07fb9546d Add Apple notification group (#1964) 2024-05-05 14:13:50 -04:00
Jakub Beránek 4874368185 Add an example how to add a job to PR CI 2024-05-04 08:04:25 +02:00
Jakub Beránek dff746fb9c Update CI documentation to avoid mentioning `expand-yaml-anchors` 2024-05-04 08:04:25 +02:00
Yutaro Ohno cbd09807b0 Rename `-Z verbose` to `-Z verbose-internals`
The `-Z verbose` option has been renamed to `-Z verbose-internals` in
commit  b5d83619 [1] (PR #119129 [2]). This commit updates the remaining
`-Z verbose` to `-Z verbose-internals`.

[1]: b5d8361909
[2]: https://github.com/rust-lang/rust/pull/119129
2024-04-30 10:15:49 +02:00
Emanuel Czirai 588fd8f4da typo traige->triage 2024-04-28 20:31:21 +02:00
Trevor Gross 34aaf19626 Add a note about checks with multiple revisions (#1963) 2024-04-13 16:16:44 +01:00
许杰友 Jieyou Xu (Joe) 75c164f9c5 compiletest: clarify that headers must be one header per line 2024-04-11 05:14:52 +02:00
needsure 2dd74894e8 chore: fix some typos in conments
Signed-off-by: needsure <qinzhipeng@outlook.com>
2024-04-09 10:59:59 +02:00
许杰友 Jieyou Xu (Joe) 43f390bed0 compiletest: specify which special env var and which particular CI job (#1960)
* compiletest: specify which special env var and which particular CI job

* compiletest: fix grammar and add link to Dockerfile
2024-04-08 21:00:54 +02:00
许杰友 Jieyou Xu (Joe) 1b1b3b4627 Explicitly mention compiletest directives are supported in rmake.rs (#1949) 2024-04-06 22:41:09 +02:00
Michael Howell c56637ddb2 Add docs for sharded descriptions 2024-04-06 22:17:41 +02:00
Martin Nordholts 4f4e8ee67d Add basic docs for the new `aux-bin` header (#1942) 2024-04-06 21:01:03 +01:00
Eric Huss 522ca9b495 Add needs-threads header command (#1943) 2024-04-06 20:57:34 +01:00
Prashanth Mundkur 4065bd5d9d Fix some broken links under bootstrapping. (#1958)
* Fix some broken links under bootstrapping.

* Fix more broken links for bootstrapping.
2024-04-06 20:55:06 +01:00
Tim Neumann ef095092e5 Replace -Zno-parallel-llvm with -Zno-parallel-backend
This was renamed by https://github.com/rust-lang/rust/pull/116791.
2024-04-05 07:05:33 +02:00
Boxy af587b635f Fix some broken links 2024-04-01 17:25:54 +01:00
Boxy 3c8a96562f Reorganise into subchapters and explain `Reveal` 2024-04-01 17:25:54 +01:00
Boxy a8dac4064c reviews 2024-04-01 17:25:54 +01:00