Commit Graph

2346 Commits

Author SHA1 Message Date
Michael Goulet 09bb84ad7f Try to fix footnotes 2024-11-02 15:16:04 -04:00
Martin Liška 433e0f6355
Fix rustc-related links that are 404 right now (#2112) 2024-11-02 20:53:31 +08:00
Michael Goulet 776484747e fix permalinks 2024-11-02 15:27:40 +08:00
Michael Goulet 0dc7845516 Async closures chapter 2024-11-02 15:27:40 +08:00
David Wood 7ad315771e
update rfl ci job policy (#2108) 2024-11-01 01:46:24 +08:00
Thomas Nyman fd1ce7455f
Fix internal and incomplete links (#2107)
* Fix broken link in syntax-intro.md

* Fix broken link in tests/compiletest.md

* Fix incorrectly formatted reference-style link in compiler-src.md

* Fix broken links to rustc-driver.md to point to rustc-driver/intro.md

* Define URLs for incomplete links to rustc sources in stabilization_guide.md

* Define link to coherence.md for incomplete link in solve/invariants.md
2024-10-31 11:13:57 +08:00
Stuart Cook 124513ebcb
Describe why and how to use a separate build directory for rust-analyzer (#2106) 2024-10-29 18:16:11 +08:00
许杰友 Jieyou Xu (Joe) 5a2507808b
Update current status of diagnostics translation infra (#2105) 2024-10-28 17:37:50 +08:00
Ralf Jung 43df628b8c
update const stability docs (#2098) 2024-10-26 20:20:45 +08:00
Stuart Cook cc0e2c9ed3
Advice on auto-formatting C++ code (#2104) 2024-10-25 12:17:44 +08:00
lolbinarycat 49afa1d8df
Update compiler-src.md (#2102)
fix conflicting link names that lead to the "chapter link" leading to rustdoc's source code instead.
2024-10-24 17:33:08 -03:00
Juniper Tyree 59d94ea75a
Add the WASM | WASI | Emscripten notification groups (#2100) 2024-10-21 10:30:07 +08:00
Tbkhi 65d87ee319
Update bootstrapping.md (#1900)
Co-authored-by: Jieyou Xu <39484203+jieyouxu@users.noreply.github.com>
Co-authored-by: Tbkhi <me.stole546@silomails.com>
2024-10-13 17:51:38 +08:00
Stuart Cook 2f06bb1a14
Rename `needs-profiler-support` to `needs-profiler-runtime` (#2095) 2024-10-10 09:27:13 +11:00
Stuart Cook 971f80916d
Document compiletest directives `ignore-coverage-map` and `ignore-coverage-run` (#2094) 2024-10-09 10:21:58 +08:00
许杰友 Jieyou Xu (Joe) 2150561cf3 Purge `run-pass-valgrind` mentions 2024-10-07 23:12:09 +02:00
Michael Howell 07bc9ca9eb
rustdoc: docs for search deduplication (#1850) 2024-10-07 23:09:03 +08:00
许杰友 Jieyou Xu (Joe) bbdfd18383 Revise test naming advice to discourage using issue numbers alone
But accept test names that include non-prefix issue number.
2024-10-07 11:17:02 +02:00
Jakub Beránek 0cd0a749a2
Document `bootstrap` integration with `rustc-perf` (#2005) 2024-10-07 16:28:06 +08:00
Kajetan Puchalski b82e917fd0 building: Update instructions for ./x setup editor 2024-10-07 10:03:36 +02:00
许杰友 Jieyou Xu (Joe) e17bfa54e7
[Testing 2/2] Revise revisions docs (#2089)
Co-authored-by: nora <48135649+Noratrieb@users.noreply.github.com>
2024-10-07 14:33:52 +08:00
许杰友 Jieyou Xu (Joe) 1be6249d67
[Testing 1/2] Revise testing chapters excluding the directives chapter (#2088) 2024-10-07 10:39:22 +08:00
Yoh Deadfall a507102e3c
Fixed links to rust-analyzer configs for Emacs and Helix (#2087) 2024-10-06 09:43:08 +09:00
Onur Özkan 6bd436acce
update `x install` documentation (#2084) 2024-10-04 00:43:40 +08:00
León Orell Valerian Liehr 7a46f88495
Rename "object safe" to "dyn compatible" (#2083) 2024-10-03 17:31:43 +08:00
León Orell Valerian Liehr e79615d2d6
fixups (#2082) 2024-10-03 10:54:50 +08:00
Urgau abd7ea6502
Add documentation for `{{rust-src-base}}` (#2079) 2024-09-29 14:21:45 +02:00
Kajetan Puchalski 776b1ad774
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 2562a101fe
Fix file paths to section 35.1 & 35.2 example code (#2078) 2024-09-25 22:18:50 +08:00
Noratrieb 451d43fad7 elaborate on warnings 2024-09-24 20:59:54 +02:00
Yuri Astrakhan bf46b0f7e7 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 69b7b0bc91 Clarify how to disable warnings in deps 2024-09-24 20:59:54 +02:00
Tbkhi b20c899ee1 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 afdad072e3 Update rustdoc build instructions 2024-09-24 20:47:22 +02:00
Noratrieb e7e1a20983 minor edits 2024-09-24 20:46:07 +02:00
Tbkhi 4e34e79914 doc edits 2024-09-24 20:46:07 +02:00
Tbkhi 37e0c09f77 Update salsa.md
Formatting updates.
2024-09-24 20:46:07 +02:00
Tbkhi bb5cdc19cb Update memory.md
Minor updates to formatting.

documentation updates

Update memory.md

minor edits
2024-09-24 20:43:37 +02:00
Noratrieb 3c4ef7c052 minor edits 2024-09-24 20:33:04 +02:00
Tbkhi 4034a8e9a5 updates documentation 2024-09-24 20:33:04 +02:00
Tbkhi 131e86b046 Update serialization.md
Minor documentation updates.
2024-09-24 20:33:04 +02:00
Tbkhi c21730adaf 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 53170058d9 minor edits 2024-09-24 20:21:23 +02:00
Tbkhi cba023dd48 Update syntax-intro.md 2024-09-24 20:21:23 +02:00
Noratrieb 91d6ab9de4 minor edits 2024-09-24 20:19:59 +02:00
Tbkhi 26558f882c Update the-parser.md 2024-09-24 20:19:59 +02:00
Tbkhi 42e30f8ee1 Update the-parser.md 2024-09-24 20:19:59 +02:00
Noratrieb 77b005b43c Minor edits 2024-09-24 20:16:28 +02:00
Tbkhi 247519eefb Update macro-expansion.md 2024-09-24 20:16:28 +02:00
Tbkhi a4c880e8a1 Update macro-expansion.md 2024-09-24 20:16:28 +02:00
Tbkhi 749e5ba592 additional changes to links and some text 2024-09-24 20:16:28 +02:00
Tbkhi 5a07a85952 Update macro-expansion.md
removing parens
2024-09-24 20:16:28 +02:00
Tbkhi 2edd9e08d4 Update macro-expansion.md 2024-09-24 20:16:28 +02:00
Noah Lev 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
Noah Lev 23bf5eca80 Move example code block to paragraph referencing it
Noticed by Mario Carneiro.
2024-09-24 20:15:12 +02:00
Noratrieb 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
Tbkhi 172d38e99c Update name-resolution.md 2024-09-24 20:07:57 +02:00
Tbkhi 6b70577e7b Update name-resolution.md 2024-09-24 20:07:57 +02:00
Felix Rath c612fc3a72 feat: Add section about partial clones with `git clone --filter='blob:none'` 2024-09-24 19:59:44 +02:00
dianne ec77cdd64f mention rustc's stable-through-unstable bug being fixed 2024-09-24 19:57:58 +02:00
trevyn b65af7cf77 Fix `is_diagnostic_item()` example 2024-09-24 19:56:37 +02:00
许杰友 Jieyou Xu (Joe) 957ea06e2e Revise wording to not imply *only* Python 3.10 can be installed 2024-09-24 19:55:07 +02:00
nora 206f42b6f3 Update src/tests/compiletest.md 2024-09-24 19:54:06 +02:00
许杰友 Jieyou Xu (Joe) 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
Vetle Rasmussen 7cffa3b643 Fix getting diagnostics example 2024-09-24 19:53:51 +02:00
dianne 4fa05b65d5 Document `#[rustc_default_body_unstable]` 2024-09-24 19:53:17 +02:00
许杰友 Jieyou Xu (Joe) 2a67e1351a Describe `.git-blame-ignore-rev` 2024-09-24 19:51:44 +02:00
许杰友 Jieyou Xu (Joe) fc02fead52 Note lldb debuginfo requires `python310.dll` to be present in `PATH` 2024-09-24 19:49:14 +02:00
Marco Ieni 555f3de2fa
chore: add missing `.` (#2074) 2024-09-23 20:51:33 +08:00
许杰友 Jieyou Xu (Joe) 48bf61ffcd
Add remark on required free disk space (#2073) 2024-09-23 20:11:47 +08:00
Max Heller a8a77cbee1
fix broken links (#2063) 2024-09-23 16:47:44 +08:00
许杰友 Jieyou Xu (Joe) 0f7f7df3f7
Add advice about submitting potentially hard-to-review PRs (#2036) 2024-09-23 16:46:49 +08:00
joculatrix 57634df44b
Edit a sentence for clarity (#2071) 2024-09-23 12:02:25 +08:00
adwin 06b80b18c3
Emphasize how to run a single tool test (#2070) 2024-09-20 15:10:29 +08:00
Santiago Pastorino ed0e273429 Remove chalk is owned by WG-traits 2024-09-18 17:48:40 -04:00
Santiago Pastorino 4f3126e124
Fix conditions lowering text for enums with no fields (#2066) 2024-09-18 08:45:24 +08:00
lcnr 8990c68a5e
update proof tree chapter (#2054)
* update proof tree chapter

* uwu

* cool beans
2024-09-17 06:45:13 +02:00
Michael Howell 1c83da838c Further clarification 2024-09-15 14:53:28 -04:00
Michael Howell aa64419164 Specify, more explicitly, the default behavior 2024-09-15 14:53:28 -04:00
Michael Howell 713eeaa1a2 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 a30716826a Clean up misleading language 2024-09-15 14:53:28 -04:00
Michael Howell b7c3561386 Minor wording improvements 2024-09-15 14:53:28 -04:00
Michael Howell af1c98d156 Add docs for JS tests 2024-09-15 14:53:28 -04:00
dianne d39f68ba83
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 da18f77c1c
we standardized on this more reliable command (#2061) 2024-09-11 02:58:06 +08:00
Veera 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
cui fliter 0ed9229f5b
fix some comments (#2059)
Signed-off-by: cuishuang <imcusg@gmail.com>
2024-09-09 12:58:45 +02:00
Prashanth Mundkur fc6bd7eb22
Fix a link and create an implied internal link (#2051) 2024-09-09 00:15:41 +08:00
Tshepang Mbambo fc68d40975
link to additional LLVM update PRs (#2055) 2024-09-09 00:13:44 +08:00
Tshepang Mbambo 236dcb91c2
fix/improve rdg contributing howto (#2056) 2024-09-09 00:13:14 +08:00
Bilal Khan 9cbb920beb
fixed the typo (#2058) 2024-09-08 11:51:11 -04:00
jdonszelmann 1874fe2323 fix typo maker -> marker (thanks @lholten) 2024-09-08 14:01:27 +02:00
Jonathan Dönszelmann 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
Jonathan Dönszelmann 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
Ralf Jung 8ced1172f7 clarify the role of rustc_const_unstable 2024-08-31 15:02:08 +02:00
Marc Poulhiès fa928a6d19 Fix x.py reference
Trivial fix to change `x.py` into `x`
2024-08-26 16:46:50 +02:00
Folkert de Vries 369a2e95a6
Update `stabilization_guide.md` (#2034) 2024-08-24 02:46:04 +08:00
León Orell Valerian Liehr 4be2f54a02
Explain the internal `#[rustc_*]` TEST attributes used for debugging and inside tests (#2046) 2024-08-24 01:58:50 +08:00
Tshepang Mbambo 918486dd2d
missing char (#2047) 2024-08-22 22:43:28 +02:00
Prashanth Mundkur 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