summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2025-02-17Update the reference for reverted `extended_varargs_abi_support`Josh Stone-0/+0
2025-02-13Revert "Stabilize `extended_varargs_abi_support`"Jubilee Young-0/+10
This reverts commit 685f189b4307435b83d625fea397ef36dff4e955.
2025-02-01Update edition-guideEric Huss-0/+0
2025-02-01Rollup merge of #136312 - compiler-errors:overflow_delimited_expr-2024, r=ytmimiJacob Pratt-52/+7
Disable `overflow_delimited_expr` in edition 2024 This reverts the style guide changes and sets the default to "false" in rustfmt for style edition 2024. r? `@ytmimi` cc `@rust-lang/style` `@rust-lang/rustfmt`
2025-01-25[beta] TRPL: integrate edits to Chapter 17Chris Krycho-0/+0
2025-01-25[beta] TRPL: more backward-compatible Edition changesChris Krycho-0/+0
- Improve the discussion of `unsafe` blocks within `unsafe` functions. - Fix formatting in Appendix A
2025-01-14[beta] TRPL: incorporate all backward-compatible Edition changesChris Krycho-0/+0
This incorporates all the backwards-compatible changes for the 2024 Edition. There will also be a follow-on PR to land revisions to the new chapter on async so it can be as ready as possible when officially released with 1.85 and the 2024 Edition. Additionally, there are a few other, non-backward-compatible, changes (largely around `use<..>`) we can only land using the stable edition, which we may or may not be able to land in 1.85 by using the beta toolchain in the example code. Those may or may not be ported over, depending on how that does or does not play with the infrastructure.
2025-01-07update version placeholdersPietro Albini-1/+1
2025-01-03Rollup merge of #131729 - Urgau:check-cfg-test-userspace, r=petrochenkovMatthias Krüger-2/+4
Make the `test` cfg a userspace check-cfg This PR implements MCP https://github.com/rust-lang/compiler-team/issues/785, which makes the `test` cfg a "userspace" check-cfg, i.e. no longer included in the well known cfg list. Things to do: - [x] Accept the MCP (https://github.com/rust-lang/compiler-team/issues/785#issuecomment-2424121886) - [x] Mark `test` in Cargo (https://github.com/rust-lang/cargo/pull/14963) `@rustbot` labels +S-waiting-on-MCP +F-check_cfg r? `@petrochenkov`
2025-01-02Make the `test` cfg a "userspace" check-cfgUrgau-2/+4
2025-01-01Add rustc-dev-guide as a josh subtreeJakub Beránek-0/+348503
2025-01-01Removed `rustc-dev-guide` as a submoduleJakub Beránek-0/+0
2025-01-01Auto merge of #134926 - rustbot:docs-update, r=ehussbors-0/+0
Update books ## rust-lang/book 13 commits in ad2011d3bcad9f152d034faf7635c22506839d58..04d06dfe541607e6419f3d028c3f9b245f3be4d9 2024-12-20 22:44:11 UTC to 2024-12-16 18:18:21 UTC - Update section name (rust-lang/book#4175) - Update text to reflect the change from '&str' to 'char' in example (rust-lang/book#4173) - Update figure number in text and file name (rust-lang/book#4172) - Fix chapter number (rust-lang/book#4171) - Delete unused reference (rust-lang/book#4170) - Remove orphaned half-sentence (rust-lang/book#4169) - Fix chapter number (rust-lang/book#4168) - A better phrasing for generic methods. (rust-lang/book#3428) - Fix minor grammatical error (rust-lang/book#4098) - Update appendix-06-translation.md to add another Chinese translation. (rust-lang/book#3608) - Change Korean translation repo to newer (rust-lang/book#3625) - Clarify/improve readability in Ch. 02 discussion of `Result` variants (rust-lang/book#4167) - Ch. 20: conclude §01 with a reference to the Rustonomicon (rust-lang/book#4166) ## rust-lang/nomicon 1 commits in 97e84a38c94bf9362b11284c20b2cb4adaa1e868..7ef05b9777c94836bc92f50f23e6e00981521a89 2024-12-30 10:38:10 UTC to 2024-12-30 10:38:10 UTC - Fix URL fragment to MutexGuard's negative impl of Send (rust-lang/nomicon#472) ## rust-lang/reference 3 commits in 9f41bc11342d46544ae0732caf14ec0bcaf27376..acd6794e712d5e2ef6f5c84fb95688d32a69b816 2024-12-18 23:04:30 +0000 to 2024-12-30 22:12:57 +0000 - Revert "`coverage` attribute" (rust-lang/reference#1706) - Document Rust 2024 match ergonomics reservations (rust-lang/reference#1702) - Add documentation for `#[diagnostic::do_not_recommend]` (rust-lang/reference#1663) ## rust-lang/edition-guide 5 commits in bc4ce51e1d4dacb9350a92e95f6159a42de2f8c6..d56e0f3a0656b7702ca466d4b191e16c28262b82 2024-12-18 05:34:59 +0000 to 2024-12-31 20:04:52 +0000 - 2024: Document rustfmt overflow_delimited_expr (rust-lang/edition-guide#352) - 2024: Document rustfmt fixes (rust-lang/edition-guide#351) - Update the transitioning steps (rust-lang/edition-guide#350) - Revert "2024: Assignment operator RHS indentation" (rust-lang/edition-guide#343) - Revert "2024: Add chapter on single-line `where` clauses" (rust-lang/edition-guide#344) ## rust-lang/rust-by-example 1 commits in 76406337f4131253443aea0ed7e7f451b464117c..093397535b48ae13ec76bc526b7e6eb8c096a85c 2024-12-18 17:29:56 UTC to 2024-12-18 17:29:56 UTC - Mention that you're not allowed to partially move Drop types (rust-lang/rust-by-example#1902) ## rust-lang/rustc-dev-guide 18 commits in 7f7ba48f04abc2ad25e52f30b5e2bffa286b019f..ad93c5f1c49f2aeb45f7a4954017b1e607df9f5e 2024-12-30 09:22:22 UTC to 2024-12-17 17:00:38 UTC - Opt into, rather than out of, linkcheck (rust-lang/rustc-dev-guide#2180) - Remove stale implementation details of coverage instrumentation (rust-lang/rustc-dev-guide#2179) - Remove properly tracked config file from .gitignore & add support for skipping of link-checking (rust-lang/rustc-dev-guide#2023) - Add a couple of linkcheck exceptions: (rust-lang/rustc-dev-guide#2120) - Add missing link for [Node] (rust-lang/rustc-dev-guide#2177) - Fix 403 received for HEAD request (rust-lang/rustc-dev-guide#2176) - Start using mdbook-linkcheck2 (rust-lang/rustc-dev-guide#2103) - Document `x test --no-capture` (rust-lang/rustc-dev-guide#2174) - Remove the `-test` suffix from normalize directives (rust-lang/rustc-dev-guide#2172) - Rework the driver docs (rust-lang/rustc-dev-guide#2162) - Document `forbid-output` for UI tests (rust-lang/rustc-dev-guide#2171) - completions: Zsh is now supported (rust-lang/rustc-dev-guide#2173) - region-outlives propagation (rust-lang/rustc-dev-guide#2169) - compiletest: Document the `--debugger` flag (rust-lang/rustc-dev-guide#2170) - document the public ci dashboard (rust-lang/rustc-dev-guide#2167) - Fix trivial typo of "query-fied" (rust-lang/rustc-dev-guide#2165) - Fix some typos (rust-lang/rustc-dev-guide#2166) - Add suggestion for `--keep-stage 0` (rust-lang/rustc-dev-guide#2164)
2024-12-31Rollup merge of #134975 - ehuss:revert-style-guide-rhs-break, r=compiler-errorsTrevor Gross-28/+0
Revert style guide rhs break This reverts https://github.com/rust-lang/rust/pull/132369 and https://github.com/rust-lang/rust/pull/119838. The style-guide change for indentation of rhs was not implemented in time for the 2024 style edition. See tracking issue https://github.com/rust-lang/rust/issues/132380. cc #134974 for the other style guide change in 2024. r? ``@compiler-errors``
2024-12-31Rollup merge of #134974 - ehuss:revert-single-line-where, r=compiler-errorsTrevor Gross-27/+4
Revert #119515 single line where clause style guide This did not get implemented for the style edition in 2024, so this PR removes it from the documentation. See tracking issue https://github.com/rust-lang/rust/issues/132381. This can be added back in the next edition if it gets implemented. I'm a little unclear on what the style team intends for how future changes are documented. For example, the current style-guide documented behavior that rustfmt does not support. I'm not sure who the audience for this document is, or how this is intended to stay in sync with rustfmt. For example, if I read this and assume this is how it is supposed to work, and then rustfmt breaks that, it seems like that is confusing. Similarly, if I'm staying on an older edition, this documentation would be incorrect for my crate. Perhaps changes like this could be "teed-up" in a PR, but not merged until the edition is stabilized (similar to how the reference works)? And include notes for parts that are edition-specific (so if I am using an older edition, I can see that something is different). In general, I'm a little confused on how this is intended to work. Reverts: - https://github.com/rust-lang/rust/pull/119515
2024-12-31Update reference, edition-guideEric Huss-0/+0
2024-12-31Revert "Rollup merge of #119838 - joshtriplett:style-guide-binop-indent, ↵Eric Huss-33/+0
r=compiler-errors" This reverts commit 36287830a22897fc05f33f615291df7efe8cad20, reversing changes made to 31026b7fe3e510a646eddeda838d1f0859f892e7.
2024-12-31Revert "Rollup merge of #132369 - ↵Eric Huss-6/+11
joshtriplett:style-guide-binop-heuristic-assignment-only, r=calebcartwright" This reverts commit 348d28052b1717f152b04725492c256c3409a361, reversing changes made to 526c67f37be44688345aec14f7b1c5926f4a59a7.
2024-12-31Revert "Rollup merge of #119515 - ↵Eric Huss-27/+4
joshtriplett:style-guide-gat-where-clause-same-line, r=compiler-errors" This reverts commit 4d1cce9de5af0e74169c6508d44c99b546d7abde, reversing changes made to 030a12ce2b1ee42f2d8837b1b500fd9cf12ea191.
2024-12-31Use `id` attribute for `<a>` tags instead of deprecated `name` attribute (#2184)Max Heller-27/+27
2024-12-31Rollup merge of #134610 - tbu-:pr_doc_target_fmt, r=NoratriebMatthias Krüger-8/+8
Format `build.toml` consistently in platform support docs Also fix compiler team name in target tier docs.
2024-12-30Rollup merge of #132477 - Noratrieb:illumos-oxide, r=workingjubileeMatthias Krüger-2/+45
Add illumos target documentation Fixes https://github.com/rust-lang/rust/pull/130132#issuecomment-2339055221 `@jclulow` `@pfmooney` I'm adding you as requested. The page is very barebones (as I do not know illumos well) and could use some improvements (for example in the "Cross-compilation toolchains and C code" section). Feel free to suggest improvements (or rewrite it from scratch) if you find something.
2024-12-30Update booksrustbot-0/+0
2024-12-30Add illumos target documentationNoratrieb-2/+45
2024-12-30Opt into, rather than out of, linkcheck (#2180)Noah Lev-7/+9
This makes it less of a hassle to render the book locally.
2024-12-30Remove stale implementation details of coverage instrumentation (#2179)Stuart Cook-354/+2
This level of detail in the dev guide is a maintenance burden; better to leave this sort of thing to in-tree comments.
2024-12-29Auto merge of #134901 - matthiaskrgr:rollup-b0wwuht, r=matthiaskrgrbors-1/+1
Rollup of 4 pull requests Successful merges: - #134870 (Fix sentence fragment in `pin` module docs) - #134884 (Fix typos) - #134892 (Added codegen test for elidings bounds check when indexes are manually checked) - #134894 (Document how to run the split Docker pipelines) r? `@ghost` `@rustbot` modify labels: rollup
2024-12-29Remove properly tracked config file from .gitignore & add support for ↵Martin Liška-9/+18
skipping of link-checking (#2023) * Remove properly tracked config file from .gitignore The file is part of the git history and is a configuration file. Fixes: #2018 * Add env. variable support * Refactoring * Really skip linkcheck if requested
2024-12-29Add a couple of linkcheck exceptions: (#2120)Martin Liška-1/+7
* Add a couple of linkcheck exceptions: Addresses: ``` Server returned 500 Internal Server Error for https://github.com/rust-lang/rust/pulls?q=is%3Apr+label%3AS-inactive+is%3Aclosed Server returned 401 Unauthorized for https://objects.githubusercontent.com/github-production-release-asset-2e65be/343907537/60cd5880-7b81-11eb-9502-68d5f473ebe2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=releaseassetproduction%2F20241103%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20241103T085906Z&X-Amz-Expires=300&X-Amz-Signature=e532fd7d2bd271f12988982bc8e5a47a0f966b40452b55d444bbb74292ac1fb1&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3Drustc.generic.wpaProfile&response-content-type=application%2Foctet-stream Server returned 500 Internal Server Error for https://github.com/rust-lang/rust/pulls?q=is%3Apr+label%3AS-inactive ``` * Skip only github.com/rust-lang/rust/pulls?q=
2024-12-30Add missing link for [Node] (#2177)Martin Liška-0/+1
2024-12-30Fix 403 received for HEAD request (#2176)Martin Liška-1/+1
2024-12-29Rollup merge of #134884 - calciumbe:patch1, r=jieyouxuMatthias Krüger-1/+1
Fix typos Hello, I fix some typos in docs and comments. Thank you very much.
2024-12-29Auto merge of #134765 - Noratrieb:linux-none-cant-unwind-silly, r=jieyouxubors-0/+5
Improve default target options for x86_64-unknown-linux-none Without a standard library, we cannot unwind, so it should be panic=abort by default. Additionally, it does not have std because while it is Linux, it cannot use libc, which std uses today for Linux. Using PIE by default may be surprising to users, as shown in #134763, so I've documented it explicitly. I'm not sure if we want to count that as fixing the issue or not. cc `@morr0ne,` as you added the target (and are the maintainer), and `@Noratrieb,` who reviewed that PR (:D).
2024-12-29Document x86_64-unknown-linux-none is PIE by defaultNoratrieb-0/+5
2024-12-29docs: fix typosdxsullivan-4/+4
2024-12-29fix: typoscalciumbe-1/+1
Signed-off-by: calciumbe <192480234+calciumbe@users.noreply.github.com>
2024-12-28Start using mdbook-linkcheck2 (#2103)Martin Liška-14/+8
2024-12-28Document virality of `feature(rustc_private)`Tamir Duberstein-2/+5
Since 9cb1998ea15e179482504e07cad8fa121e169a32 this feature is viral.
2024-12-28Document `x test --no-capture` (#2174)clubby789-0/+8
2024-12-28Remove the `-test` suffix from normalize directives (#2172)Stuart Cook-8/+4
2024-12-27Rework the driver docs (#2162)bjorn3-198/+272
2024-12-27Document `forbid-output` for UI tests (#2171)clubby789-1/+1
2024-12-27Sort triples by name in platform_support.md9names-52/+52
2024-12-27completions: Zsh is now supported (#2173)clubby789-3/+1
2024-12-25Rollup merge of #134525 - adetaylor:unstable-book-changes, r=wesleywiserDianQK-0/+211
Arbitrary self types v2: unstable doc updates. Document these two feature flags. Part of #44874 .
2024-12-23region-outlives propagation (#2169)lcnr-1/+5
* region-outlives propagation * woops * gamer
2024-12-23Document the `--debugger` flag (#2170)clubby789-0/+3
2024-12-23Rollup merge of #134672 - Zalathar:revert-coverage-attr, r=wesleywiserTrevor Gross-0/+30
Revert stabilization of the `#[coverage(..)]` attribute Due to a process mixup, the PR to stabilize the `#[coverage(..)]` attribute (#130766) was merged while there are still outstanding concerns. The default action in that situation is to revert, and the feature is not sufficiently urgent or uncontroversial to justify special treatment, so this PR reverts that stabilization. --- - A key point that came up in offline discussions is that unlike most user-facing features, this one never had a proper RFC, so parts of the normal stabilization process that implicitly rely on an RFC break down in this case. - As the implementor and de-facto owner of the feature in its current form, I would like to think that I made good choices in designing and implementing it, but I don't feel comfortable proceeding to stabilization without further scrutiny. - There hasn't been a clear opportunity for T-compiler to weigh in or express concerns prior to stabilization. - The stabilization PR cites a T-lang FCP that occurred in the tracking issue, but due to the messy design and implementation history (and lack of a clear RFC), it's unclear what that FCP approval actually represents in this case. - At the very least, we should not proceed without a clear statement from T-lang or the relevant members about the team's stance on this feature, especially in light of the other concerns listed here. - The existing user-facing documentation doesn't clearly reflect which parts of the feature are stable commitments, and which parts are subject to change. And there doesn't appear to be a clear consensus anywhere about where that line is actually drawn, or whether the chosen boundary is acceptable to the relevant teams and individuals. - For example, the [stabilization report comment](https://github.com/rust-lang/rust/issues/84605#issuecomment-2166514660) mentions that some aspects are subject to change, but that text isn't consistent with my earlier comments, and there doesn't appear to have been any explicit discussion or approval process. - [The current reference text](https://github.com/rust-lang/reference/blob/4dfaa4f/src/attributes/coverage-instrumentation.md) doesn't mention this distinction at all, and instead simply describes the current implementation behaviour. - When the implementation was changed to its current form, the associated user-facing error messages were not updated, so they still refer to the attribute only being allowed on functions and closures. - On its own, this might have been reasonable to fix-forward in the absence of other concerns, but the fact that it never came up earlier highlights the breakdown in process that has occurred here. --- Apologies to everyone who was excited for this stabilization to land, but unfortunately it simply isn't ready yet.
2024-12-23Revert "Auto merge of #130766 - clarfonthey:stable-coverage-attribute, ↵Zalathar-0/+30
r=wesleywiser" This reverts commit 1d35638dc38dbfbf1cc2a9823135dfcf3c650169, reversing changes made to f23a80a4c2fbca593b64e70f5970368824b4c5e9.
2024-12-22Add platform docs for FreeBSD.Alan Somers-8/+65
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-04-24 06:14:52 +0000