749e5ba592
additional changes to links and some text
2024-09-24 20:16:28 +02:00
5a07a85952
Update macro-expansion.md
...
removing parens
2024-09-24 20:16:28 +02:00
2edd9e08d4
Update macro-expansion.md
2024-09-24 20:16:28 +02:00
6977f206f5
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
23bf5eca80
Move example code block to paragraph referencing it
...
Noticed by Mario Carneiro.
2024-09-24 20:15:12 +02:00
cb22326fae
Minor edits
...
- un-codeblock some words
- uncomment the last paragraph (it's useful to know this)
2024-09-24 20:07:57 +02:00
172d38e99c
Update name-resolution.md
2024-09-24 20:07:57 +02:00
6b70577e7b
Update name-resolution.md
2024-09-24 20:07:57 +02:00
c612fc3a72
feat: Add section about partial clones with `git clone --filter='blob:none'`
2024-09-24 19:59:44 +02:00
ec77cdd64f
mention rustc's stable-through-unstable bug being fixed
2024-09-24 19:57:58 +02:00
b65af7cf77
Fix `is_diagnostic_item()` example
2024-09-24 19:56:37 +02:00
957ea06e2e
Revise wording to not imply *only* Python 3.10 can be installed
2024-09-24 19:55:07 +02:00
206f42b6f3
Update src/tests/compiletest.md
2024-09-24 19:54:06 +02:00
6aa536dc97
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
7cffa3b643
Fix getting diagnostics example
2024-09-24 19:53:51 +02:00
4fa05b65d5
Document `#[rustc_default_body_unstable]`
2024-09-24 19:53:17 +02:00
2a67e1351a
Describe `.git-blame-ignore-rev`
2024-09-24 19:51:44 +02:00
fc02fead52
Note lldb debuginfo requires `python310.dll` to be present in `PATH`
2024-09-24 19:49:14 +02:00
555f3de2fa
chore: add missing `.` ( #2074 )
2024-09-23 20:51:33 +08:00
48bf61ffcd
Add remark on required free disk space ( #2073 )
2024-09-23 20:11:47 +08:00
a8a77cbee1
fix broken links ( #2063 )
2024-09-23 16:47:44 +08:00
0f7f7df3f7
Add advice about submitting potentially hard-to-review PRs ( #2036 )
2024-09-23 16:46:49 +08:00
57634df44b
Edit a sentence for clarity ( #2071 )
2024-09-23 12:02:25 +08:00
06b80b18c3
Emphasize how to run a single tool test ( #2070 )
2024-09-20 15:10:29 +08:00
ed0e273429
Remove chalk is owned by WG-traits
2024-09-18 17:48:40 -04:00
4f3126e124
Fix conditions lowering text for enums with no fields ( #2066 )
2024-09-18 08:45:24 +08:00
8990c68a5e
update proof tree chapter ( #2054 )
...
* update proof tree chapter
* uwu
* cool beans
2024-09-17 06:45:13 +02:00
1c83da838c
Further clarification
2024-09-15 14:53:28 -04:00
aa64419164
Specify, more explicitly, the default behavior
2024-09-15 14:53:28 -04:00
713eeaa1a2
Update src/rustdoc-internals/search.md
...
Co-authored-by: Guillaume Gomez <guillaume1.gomez@gmail.com>
2024-09-15 14:53:28 -04:00
a30716826a
Clean up misleading language
2024-09-15 14:53:28 -04:00
b7c3561386
Minor wording improvements
2024-09-15 14:53:28 -04:00
af1c98d156
Add docs for JS tests
2024-09-15 14:53:28 -04:00
d39f68ba83
Reflect `x.py test`'s `--rustc-args` option being renamed to `--compiletest-rustc-args` ( #2062 )
2024-09-12 09:58:27 +08:00
da18f77c1c
we standardized on this more reliable command ( #2061 )
2024-09-11 02:58:06 +08:00
34cb340a85
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
0ed9229f5b
fix some comments ( #2059 )
...
Signed-off-by: cuishuang <imcusg@gmail.com>
2024-09-09 12:58:45 +02:00
fc6bd7eb22
Fix a link and create an implied internal link ( #2051 )
2024-09-09 00:15:41 +08:00
fc68d40975
link to additional LLVM update PRs ( #2055 )
2024-09-09 00:13:44 +08:00
236dcb91c2
fix/improve rdg contributing howto ( #2056 )
2024-09-09 00:13:14 +08:00
9cbb920beb
fixed the typo ( #2058 )
2024-09-08 11:51:11 -04:00
1874fe2323
fix typo maker -> marker (thanks @lholten)
2024-09-08 14:01:27 +02:00
77be3b8dcc
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
75ffaf02a9
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
8ced1172f7
clarify the role of rustc_const_unstable
2024-08-31 15:02:08 +02:00
fa928a6d19
Fix x.py reference
...
Trivial fix to change `x.py` into `x`
2024-08-26 16:46:50 +02:00
369a2e95a6
Update `stabilization_guide.md` ( #2034 )
2024-08-24 02:46:04 +08:00
4be2f54a02
Explain the internal `#[rustc_*]` TEST attributes used for debugging and inside tests ( #2046 )
2024-08-24 01:58:50 +08:00
918486dd2d
missing char ( #2047 )
2024-08-22 22:43:28 +02:00
cd7f60006b
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
98926c5e61
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
d194bc5607
Update LLVM docs ( #2039 )
...
* Update LLVM docs
* Apply feedback
2024-08-12 18:07:49 -03:00
43d83780db
Added 'the' in chapter "Running test" subtitle "Run unit tests on the compiler/library" ( #2040 )
2024-08-09 01:54:27 +08:00
9c47f8c741
Review comments <3
2024-08-07 20:32:37 -07:00
3fbb21e75c
Correct rust code block in *Dataflow Analysis*
2024-08-07 20:32:37 -07:00
8f92da7a48
chore: fix some comments
...
Signed-off-by: riyueguang <rustruby@outlook.com>
2024-07-30 08:04:13 +02:00
4765bd775d
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
fdb610d33a
typo ( #2029 )
2024-07-26 15:31:20 -07:00
fa411dcd4b
Fix broken links in `llvm-coverage-instrumentation.md` ( #2027 )
2024-07-26 21:19:51 +08:00
e5cb04cd24
Fix invalid link to toolstate documentation ( #2021 )
2024-07-24 20:02:10 +08:00
f49f30d427
linkcheck: fix reported broken links (part 1) ( #2022 )
2024-07-24 20:01:25 +08:00
9e353070a0
fix link
2024-07-24 13:08:53 +02:00
55477c16ed
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
0a92516459
Update adding.md ( #2016 )
...
Add `@' to the test header edition:2018
2024-07-19 15:15:12 +08:00
0c4d55cb59
refine mir passes doc
2024-07-15 17:16:43 +02:00
8ec48c0170
Typo in src/mir/passes.md
...
accidently -> accidentally
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2024-07-15 17:16:43 +02:00
6bbd1c4a0c
Improve doc of MIR queries & passes
2024-07-15 17:16:43 +02:00
6571079eb5
Fix typo: lists -> lints ( #2011 )
...
It's a bit of a tongue-twister it seems.
2024-07-08 21:28:55 +00:00
5837d21fed
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
108ce63095
Fix grammar issue in optimize-build.md ( #2009 )
2024-07-02 11:05:55 +08:00
cb5b44424c
Update name of Fuchsia builder ( #2008 )
2024-07-01 21:05:14 +02:00
d6e3a32a55
Update new target check-cfg instructions
2024-07-01 12:51:26 +02:00
98c5f27cf7
Add link to integration tests list
2024-07-01 00:31:56 +02:00
7ecba2621c
Add Rust for Linux integration tests documentation
2024-07-01 00:31:56 +02:00
0bd5b6af26
Add docs for building Fuchsia locally and in CI ( #1989 )
2024-06-28 23:12:08 +02:00
f303e09e88
provide `libstdc++.so.6` through `LD_LIBRARY_PATH`
2024-06-27 16:15:59 +02:00
c4f9678427
tests: document how to run `run-make` on Windows ( #2002 )
2024-06-24 05:21:15 +00:00
22fbccf329
tests/headers: document `needs-symlink` ( #2001 )
...
Added in <https://github.com/rust-lang/rust/pull/126862 >.
2024-06-24 04:31:35 +00:00
a251320dc6
Rename `wasm32-wasi` to `wasm32-wasip1`
2024-06-23 20:21:42 +02:00
88cc55334f
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
6875c49261
docs: document hard-resetting submodules
2024-06-19 20:14:28 +02:00
5ec72a2498
Fix note about compiletest header `rustfix-only-machine-applicable` ( #1998 )
2024-06-18 23:50:10 +01:00
e7998be731
docs: mention RUSTC_ICE=0 to suppress ICE file
2024-06-18 19:24:17 +01:00
aec82168dd
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
521f87fa26
Rewrite CI documentation
2024-06-13 15:14:55 +02:00
3f0b69b8ee
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
9179f48f33
Add {{target}} to header substitutions
2024-06-12 15:59:20 +02:00
cb69788d4d
run-make: add tip about quick-compile with stage0 rustc
2024-06-10 13:49:19 +02:00
92f40da697
Mention `COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS` in `needs-llvm-components` documentation ( #1990 )
2024-06-10 12:41:47 +01:00
77735079cc
Add run-make port initiative to the Recurring work section ( #1992 )
2024-06-09 09:57:13 +01:00
544d2624de
Document the `//@ unused-revision-names:` test header ( #1991 )
2024-06-08 13:13:44 +01:00
203ade3127
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
99d2ed7965
should use `&` to load completions for PowerShell ( #1978 )
2024-06-04 06:31:05 +01:00
6a7374bd87
Reviews
2024-05-31 01:27:28 +01:00
4a705f99e5
Rewrite the "representing types" section to be more comprehensive
2024-05-31 01:27:28 +01:00
ea35ee8e01
Introduce chapter for defining generic parameters
2024-05-31 01:27:28 +01:00
b71f723db7
sync the stage0 filename
...
Signed-off-by: onur-ozkan <work@onurozkan.dev>
2024-05-25 15:42:06 -07:00
f7a8759167
Add Rust for Linux notification group entry
2024-05-25 15:40:04 -07:00
77478e960f
fix some typos
2024-05-21 11:56:12 +02:00
b6d4a4940b
add a high level explanation, and remove a disclaimer ( #1982 )
2024-05-17 19:04:58 +02:00
dbfb44dcc1
Fix broken link to "Lowering"
2024-05-17 12:15:36 +02:00
79bf0ba32b
Fix broken link
2024-05-16 04:53:03 +02:00
6f60d12b01
Add note about how to pick up abandoned PRs
2024-05-15 19:59:36 +02:00
4978a88866
Toc here is overkill
2024-05-15 09:45:05 +02:00
d01697bab3
Link to lint L-* labels
2024-05-13 20:09:18 +02:00
610b875ea5
Update the rustc_interface examples for current rustc ( #1974 )
2024-05-11 00:06:30 +01:00
4b692c012c
Edit `Parameter Environments`'s url as it has been edited in #1953
2024-05-09 15:22:03 +02:00
2d1947ff34
Improve FALSE sentence
...
Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2024-05-06 08:48:21 +02:00
27b2b40451
Add documentation for check-cfg by-default in UI tests
2024-05-06 08:48:21 +02:00
57f40831d7
Add Apple notification group ( #1964 )
2024-05-05 14:13:50 -04:00
2f9b577171
Add an example how to add a job to PR CI
2024-05-04 08:04:25 +02:00
1cf32e07fd
Update CI documentation to avoid mentioning `expand-yaml-anchors`
2024-05-04 08:04:25 +02:00
4c97ad5479
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]: b5d8361909https://github.com/rust-lang/rust/pull/119129
2024-04-30 10:15:49 +02:00
e5c5fc3a13
typo traige->triage
2024-04-28 20:31:21 +02:00
07425fed36
Add a note about checks with multiple revisions ( #1963 )
2024-04-13 16:16:44 +01:00
f70352388d
compiletest: clarify that headers must be one header per line
2024-04-11 05:14:52 +02:00
9fbba973ab
chore: fix some typos in conments
...
Signed-off-by: needsure <qinzhipeng@outlook.com>
2024-04-09 10:59:59 +02:00
61c1e83484
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
b77a34bd46
Explicitly mention compiletest directives are supported in rmake.rs ( #1949 )
2024-04-06 22:41:09 +02:00
55f79b5a87
Add docs for sharded descriptions
2024-04-06 22:17:41 +02:00
b735c7e9b8
Add basic docs for the new `aux-bin` header ( #1942 )
2024-04-06 21:01:03 +01:00
0b6f21054a
Add needs-threads header command ( #1943 )
2024-04-06 20:57:34 +01:00
5d1fdd3bec
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
4375d8579c
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
84bbfc3a5c
Fix some broken links
2024-04-01 17:25:54 +01:00
e8cd1d933e
Reorganise into subchapters and explain `Reveal`
2024-04-01 17:25:54 +01:00
01810f4aec
reviews
2024-04-01 17:25:54 +01:00
f2adb25de2
Change location in guide
2024-04-01 17:25:54 +01:00
317a4e279b
Initial rewrite
2024-04-01 17:25:54 +01:00
f66b472e0a
Add quickstart for how to build and run the compiler ( #1951 )
...
* Add quickstart for how to build and run the compiler
The chapter is quite long, and a lot of the information is, while
valuable, not very important for newcomers. I think it makes sense to
have a condensed version for anyone just wanting to get started with
only the most important information.
* A few improvements to quickstart
2024-03-31 06:23:21 +02:00
f1095490cc
Delete length check ( #1952 )
...
It's super annoying to be forced to use this bad convention, and
apparently everyone agrees. The only reason no improvements have been
done is because those were blocked on writing a better checker.
I strongly believe that no checker is better than a bad checker, so
let's just delete it in the meantime. I kindly asked anyone who sees
this to complain about overly long sentences in review in the future, I
think we can make this turn out fine.
2024-03-30 17:46:30 +01:00
35e77b8e64
Fix some comments
...
Signed-off-by: JohnEndson <jiayuzhen@outlook.com>
2024-03-28 13:58:43 +02:00
1ddb90c58a
summary: opaque-types-region-inference-restrictions
2024-03-27 09:49:05 +01:00
45d0afbee7
add opaque-types-region-inference-restrictions
2024-03-27 09:49:05 +01:00
ffa246b7fd
Rename AstConv to HIR ty lowering
2024-03-23 08:44:42 +01:00
8f6a4f62c8
add chapter to summary
2024-03-22 12:46:08 +01:00
f1698b1270
explain rigid aliases
2024-03-22 11:11:41 +00:00
0c4c6d79a8
Update src/solve/significant-changes.md
...
Co-authored-by: Oli Scherer <github35764891676564198441@oli-obk.de>
2024-03-22 11:11:41 +00:00
92066e7a59
Update src/solve/significant-changes.md
...
Co-authored-by: Oli Scherer <github35764891676564198441@oli-obk.de>
2024-03-22 11:11:41 +00:00
66d43a8aac
is this sensible? idk
2024-03-22 11:11:41 +00:00
a10a29a33f
explore significant changes with the new solver
2024-03-22 11:11:41 +00:00
87894b025f
canonicalization is out of date
2024-03-22 11:11:41 +00:00
db46d3eb06
Fix broken link in chapter '1. How to build and run the compiler'
...
The 'read this chapter' link under the 'What is x.py?' section
returned a Document not found (404) error.
2024-03-22 10:49:12 +02:00
d4c8701a07
typo
2024-03-19 19:12:28 +01:00
4cb2b3b88c
Reflect rustc_codegen_cranelift move
2024-03-18 20:37:35 +02:00
e864c0252e
Update rustdoc-internals.md ( #1911 )
...
* Update rustdoc-internals.md
Minor updates to syntax and some clarifications.
* updates
* Update rustdoc-internals.md
2024-03-13 18:56:14 -03:00
8587c9b6f7
Update test-implementation.md ( #1937 )
...
* Update test-implementation.md
* Update test-implementation.md
2024-03-13 18:23:20 -03:00
dbee504b23
Extract Bootstrap into its own section ( #1939 )
...
* Extract Bootstrap into its own section
Add brief explanation for `Step` and `Builder::ensure` as core
Bootstrap internal concepts.
* Drop common commands page (use `x --help` instead)
* Add `make` as an alternative entry point
* Add src/bootstrap/README.md link
2024-03-13 18:18:29 -03:00
144e53540f
typos
...
Also
- use proper case for rust-analyzer
- reformat a bit, for sembr
2024-03-13 04:28:30 +01:00
7d6e6c63a1
More updates for recent diagnostics changes.
...
A sequel to #1883 , this covers diagnostic naming changes from
rust-lang/rust/pull/121489, rust-lang/rust/pull/121780, and
rust-lang/rust/pull/122132.
2024-03-12 02:12:31 +01:00
Tbkhi
Noah Lev
Noratrieb
Felix Rath
dianne
trevyn
许杰友 Jieyou Xu (Joe)
Vetle Rasmussen
Marco Ieni
Max Heller
joculatrix
adwin
Santiago Pastorino
lcnr
Michael Howell
Tshepang Mbambo
Veera
cui fliter
Prashanth Mundkur
Bilal Khan
jdonszelmann
Jonathan Dönszelmann
Ralf Jung
Marc Poulhiès
Folkert de Vries
León Orell Valerian Liehr
flash
Nikita Popov
GabrieleC07
xFrednet
riyueguang
Martin Liška
Stuart Cook
Jakub Beránek
Martin Liška
10takla
Jaic1
onur-ozkan
Arjun Patel
Tyler Mandry
Urgau
Jakub Beránek
DianQK
Yosh
Aaron Hill
许杰友 Jieyou Xu (Joe)
Lukas Wirth
erikdesjardins
听寒
Boxy
surechen
David Archibald
gstjepan2
Ardi
Matthew Woodcraft
Urgau
Mads Marquart
Yutaro Ohno
Emanuel Czirai
Trevor Gross
needsure
Martin Nordholts
Eric Huss
Prashanth Mundkur
Tim Neumann
Nilstrieb
JohnEndson
Ali MJ Al-Nasrawy
Christopher B. Speir
Seo Sanghyeon
Nicholas Nethercote