about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2024-08-24Update `stabilization_guide.md` (#2034)Folkert de Vries-6/+6
2024-08-24Explain the internal `#[rustc_*]` TEST attributes used for debugging and ↵León Orell Valerian Liehr-30/+81
inside tests (#2046)
2024-08-23Rollup merge of #128511 - alexcrichton:doc-wasm-features, r=jieyouxuGuillaume Gomez-1/+226
Document WebAssembly target feature expectations This commit is a result of the discussion on #128475 and incorporates parts of #109807 as well. This is all done as a new page of documentation for the `wasm32-unknown-unknown` target which previously did not exist. This new page goes into details about the preexisting target and additionally documents the expectations for WebAssembly features and code generation. The tl;dr is that LLVM will enable features over time after most engines have had support for awhile. Compiling without features requires `-Ctarget-cpu=mvp` to rustc plus `-Zbuild-std` to Cargo. Closes #109807 Closes #119811 Closes #128475
2024-08-22missing char (#2047)Tshepang Mbambo-1/+1
2024-08-21Replace direct http links to rustc-dev-guide.rust-lang.org to relative links ↵Prashanth Mundkur-8/+8
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-20rustdoc: consistentify `#TOC` and `#ModNav` to lowercaseMichael Howell-1/+1
2024-08-20fix typo (#2043)flash-1/+1
line 320: original: "valtree back a to MIR constant" updated: "valtree back to a MIR constant"
2024-08-18Auto merge of #126450 - madsmtm:promote-mac-catalyst, r=Mark-Simulacrumbors-10/+14
Promote Mac Catalyst targets to Tier 2, and ship with rustup Promote the Mac Catalyst targets `x86_64-apple-ios-macabi` and `aarch64-apple-ios-macabi` to Tier 2, as per [the MCP](https://github.com/rust-lang/compiler-team/issues/761) (see that for motivation and details). These targets are now also distributed with rustup, although without the sanitizer runtime, as that currently has trouble building, see https://github.com/rust-lang/rust/issues/129069.
2024-08-15Rollup merge of #128348 - ↵Matthias Krüger-1/+15
dingxiangfei2009:allow-shadow-call-stack-sanitizer, r=tmandry Unconditionally allow shadow call-stack sanitizer for AArch64 It is possible to do so whenever `-Z fixed-x18` is applied. cc ``@Darksonn`` for context The reasoning is that, as soon as reservation on `x18` is forced through the flag `fixed-x18`, on AArch64 the option to instrument with [Shadow Call Stack sanitizer](https://clang.llvm.org/docs/ShadowCallStack.html) is then applicable regardless of the target configuration. At the every least, we would like to relax the restriction on specifically `aarch64-unknonw-none`. For this option, we can include a documentation change saying that users of compiled objects need to ensure that they are linked to runtime with Shadow Call Stack instrumentation support. Related: #121972
2024-08-15Rollup merge of #129015 - rustbot:docs-update, r=ehussMatthias Krüger-0/+0
Update books ## rust-lang/book 7 commits in 67fa536768013d9d5a13f3a06790521d511ef711..04bc1396bb857f35b5dda1d773c9571e1f253304 2024-07-31 13:19:44 UTC to 2024-07-16 18:18:38 UTC - mdbook-trpl-listing: Add missing elided lifetimes (rust-lang/book#3995) - infra: include ghp-import and git push in generate-preview script (rust-lang/book#3998) - infra: add robots.txt for GH Pages previews (rust-lang/book#3997) - Clarify function definitions vs. expressions (rust-lang/book#3870) - infra: fix some shellcheck issues in CI config (rust-lang/book#3988) - infra: support test renderer in mdbook preprocessors (rust-lang/book#3982) - Improve handling of `<Listing>`s (rust-lang/book#3975) ## rust-lang/edition-guide 4 commits in 5454de3d12b9ccc6375b629cf7ccda8264640aac..aeeb287d41a0332c210da122bea8e0e91844ab3e 2024-08-06 21:16:24 UTC to 2024-07-29 21:41:36 UTC - Stabilize unsafe extern blocks (rust-lang/edition-guide#313) - Add chapter for Lifetime Capture Rules 2024 (rust-lang/edition-guide#316) - 2024: Add page for missing_fragment_specifier (rust-lang/edition-guide#315) - Add documentation for 2024 prelude migration. (rust-lang/edition-guide#314) ## rust-lang/nomicon 3 commits in 0ebdacadbda8ce2cd8fbf93985e15af61a7ab895..6ecf95c5f2bfa0e6314dfe282bf775fd1405f7e9 2024-08-11 16:55:29 UTC to 2024-08-09 23:25:22 UTC - Stabilize `min_exhaustive_patterns` (rust-lang/nomicon#445) - repr(int) enums: both size and sign matter (rust-lang/nomicon#458) - Update what-unsafe-does.md (rust-lang/nomicon#457) ## rust-lang/reference 6 commits in 2e191814f163ee1e77e2d6094eee4dd78a289c5b..62cd0df95061ba0ac886333f5cd7f3012f149da1 2024-08-11 21:06:12 UTC to 2024-07-30 06:34:03 UTC - Reformat (and only reformat) the inline assembly chapter (rust-lang/reference#1550) - Changes for unsafe extern blocks (RFC 3484) (rust-lang/reference#1536) - Stabilize Wasm relaxed SIMD (rust-lang/reference#1421) - Remove custom blockquote styling (rust-lang/reference#1547) - Fix std-links for generics with commas. (rust-lang/reference#1549) - Add details on how names are introduced. (rust-lang/reference#1052) ## rust-lang/rust-by-example 3 commits in 89aecb6951b77bc746da73df8c9f2b2ceaad494a..8f94061936e492159f4f6c09c0f917a7521893ff 2024-08-06 17:25:35 UTC to 2024-07-16 20:58:25 UTC - Update lifetime_bounds.md (rust-lang/rust-by-example#1869) - Remove the link to Japanese translation (rust-lang/rust-by-example#1868) - Add an example of implementing the FromStr trait for Circles. (rust-lang/rust-by-example#1865) ## rust-lang/rustc-dev-guide 12 commits in 0c4d55cb59fe440d1a630e4e5774d043968edb3f..43d83780db545a1ed6d45773312fc578987e3968 2024-08-08 17:54:27 UTC to 2024-07-19 07:15:12 UTC - Added 'the' in chapter "Running test" subtitle "Run unit tests on the compiler/library" (rust-lang/rustc-dev-guide#2040) - Correct rust code block in *Dataflow Analysis* (rust-lang/rustc-dev-guide#2037) - linkcheck: fix filtering of the source files (rust-lang/rustc-dev-guide#2019) - chore: fix some comments (rust-lang/rustc-dev-guide#2028) - linkcheck: fix reported broken links (part 2) (rust-lang/rustc-dev-guide#2024) - typo (rust-lang/rustc-dev-guide#2029) - Fix broken links in `llvm-coverage-instrumentation.md` (rust-lang/rustc-dev-guide#2027) - Fix invalid link to toolstate documentation (rust-lang/rustc-dev-guide#2021) - linkcheck: fix reported broken links (part 1) (rust-lang/rustc-dev-guide#2022) - fix link (rust-lang/rustc-dev-guide#2020) - MIR docs: fix borked links and update style (rust-lang/rustc-dev-guide#2017) - Update adding.md (rust-lang/rustc-dev-guide#2016)
2024-08-15Rollup merge of #128963 - GuillaumeGomez:output-to-stdout, r=aDotInTheVoidMatthias Krüger-0/+3
Add possibility to generate rustdoc JSON output to stdout Fixes #127165. I think it's likely common to want to get rustdoc json output directly instead of reading it from a file so I added this option to allow it. It's unstable and only works with `--output-format=json`. r? `@aDotInTheVoid`
2024-08-15Rollup merge of #127905 - BKPepe:powerpc-muslspe, r=wesleywiserMatthias Krüger-0/+34
Add powerpc-unknown-linux-muslspe compile target This is almost identical to already existing targets: - powerpc_unknown_linux_musl.rs - powerpc_unknown_linux_gnuspe.rs It has support for PowerPC SPE (muslspe), which can be used with GCC version up to 8. It is useful for Freescale or IBM cores like e500. This was verified to be working with OpenWrt build system for CZ.NIC's Turris 1.x routers, which are using Freescale P2020, e500v2, so add it as a Tier 3 target. Follow-up of https://github.com/rust-lang/rust/pull/100860
2024-08-14Rollup merge of #128570 - folkertdev:stabilize-asm-const, r=Amanieu许杰友 Jieyou Xu (Joe)-11/+0
Stabilize `asm_const` tracking issue: https://github.com/rust-lang/rust/issues/93332 reference PR: https://github.com/rust-lang/reference/pull/1556 this will probably require some CI wrangling (and a rebase), so let's get that over with even though the final required PR is not merged yet. r? `@ghost`
2024-08-14Promote Mac Catalyst targets to tier 2, and ship with rustupMads Marquart-10/+14
- aarch64-apple-ios-macabi - x86_64-apple-ios-macabi
2024-08-13stabilize `asm_const`Folkert-11/+0
2024-08-13Add documentation for the doctest `standalone` attributeGuillaume Gomez-0/+51
2024-08-12Update LLVM docs (#2039)Nikita Popov-27/+71
* Update LLVM docs * Apply feedback
2024-08-12Update booksrustbot-0/+0
2024-08-12Add documentation for `-o -`Guillaume Gomez-0/+3
2024-08-11Auto merge of #122362 - Zoxc:rustc_driver_static_std, ↵bors-0/+11
r=oli-obk,lqd,bjorn3,Kobzol Link `std` statically in `rustc_driver` This makes `rustc_driver` statically link to `std`. This is done by not passing `-C prefer-dynamic` when building `rustc_driver`. However building `rustc-main` won't work currently as it tries to dynamically link to both `rustc_driver` and `std` resulting in a crate graph with `std` duplicated. To fix that new command line option `-Z prefer_deps_of_dynamic` is added which prevents linking to a dylib if there's a static variant of it already statically linked into another dylib dependency. The main motivation for this change is to enable `#[global_allocator]` to be used in `rustc_driver` allowing overriding the allocator used in rustc on all platforms. --- Instead of adding `-Z prefer_deps_of_dynamic`, this PR is changed to crate opt-in to the linking change via the `rustc_private` feature instead, as that would be typically needed to link to `rustc_driver` anyway. --- try-job: aarch64-apple try-job: x86_64-msvc try-job: i686-mingw try-job: dist-x86_64-msvc try-job: aarch64-gnu
2024-08-11Rollup merge of #128592 - evelynharthbrooke:master, r=Mark-SimulacrumMatthias Krüger-4/+1
Promote aarch64-apple-darwin to Tier 1 This promotes aarch64-apple-darwin to Tier 1 status as per rust-lang/rfcs#3671 and tracking issue #73908. Not sure what else is necessary for this to impement the aforementioned RFC, however I figured I'd try. I did read in previous issues and PRs that the necessary infrastructure was already in place for the aarch64-apple-darwin target, and the RFC mentions the same. So this should be all thats necessary in order for the target to be promoted. This is a recreation of my previous PR because I accidentally did an incorrect git rebase which caused unnecessary changes to various commit SHAs. So this PR is a recreation of my previous PR without said stumble. My bad.
2024-08-11Update the unstable bookJohn Kåre Alsaker-0/+11
2024-08-10Auto merge of #128400 - petrochenkov:nowhole3, r=bjorn3bors-3/+1
linker: Remove the "`--whole-archive` in test mode" backcompat hack Fixes https://github.com/rust-lang/rust/issues/116910.
2024-08-09unconditionally allow shadow call-stack for AArch64 whenever fixed-x18 is ↵Ding Xiang Fei-1/+15
applied
2024-08-08Review commentsAlex Crichton-6/+6
2024-08-09Added 'the' in chapter "Running test" subtitle "Run unit tests on the ↵GabrieleC07-1/+1
compiler/library" (#2040)
2024-08-08Update platform support docs for VxWorks targetB I Mohammed Abbas-6/+8
2024-08-07Disable linkcheck in PRs until bugs are fixedNoah Lev-0/+6
See https://github.com/Michael-F-Bryan/mdbook-linkcheck/issues/77 and https://github.com/Michael-F-Bryan/mdbook-linkcheck/issues/86. These bugs are causing linkcheck to erroneously fail because we run it using `-f`, to avoid too many requests. For now, disable linkcheck in PR CI, though leave it enabled in the cron job, where the bug should not occur.
2024-08-07Review comments <3xFrednet-11/+11
2024-08-07Correct rust code block in *Dataflow Analysis*xFrednet-10/+12
2024-08-07Specify a minimum supported version for VxWorksDavid Carlier-0/+6
2024-08-03Add platform support document for riscv64gc-unknown-linux-muslAmanieu d'Antras-1/+49
2024-08-03linkcheck: fix filtering of the source files (#2019)Martin Liška-2/+2
2024-08-03Promote aarch64-apple-darwin to Tier 1Evelyn Harthbrooke-4/+1
Per rust-lang/rfcs#3671.
2024-08-02Review commentsAlex Crichton-8/+20
2024-08-01Appease tidyAlex Crichton-2/+2
2024-08-01Document on-by-default featuresAlex Crichton-0/+8
2024-08-01Ignore two new doc blocks in testingAlex Crichton-2/+2
2024-08-01Add new page to SUMMARY.mdAlex Crichton-0/+1
2024-08-01Add a note about libraries and `#[target_feature]`Alex Crichton-0/+33
2024-08-01Review commentsAlex Crichton-5/+8
2024-08-01Document WebAssembly target feature expectationsAlex Crichton-1/+169
This commit is a result of the discussion on #128475 and incorporates parts of #109807 as well. This is all done as a new page of documentation for the `wasm32-unknown-unknown` target which previously did not exist. This new page goes into details about the preexisting target and additionally documents the expectations for WebAssembly features and code generation. The tl;dr is that LLVM will enable features over time after most engines have had support for awhile. Compiling without features requires `-Ctarget-cpu=mvp` to rustc plus `-Zbuild-std` to Cargo. Closes #109807 Closes #128475
2024-08-01Rollup merge of #127490 - ↵Matthias Krüger-1/+131
ferrocene:hoverbear/add-riscv64gc-unknown-linux-target-page, r=pietroalbini Add target page for riscv64gc-unknown-linux-gnu I was reading https://github.com/rust-lang/rust/issues/113739 and realized I knew most of the information necessary to create the `riscv64gc-unknown-linux-gnu` target page.
2024-07-31Add VxWorks platfrom support documentsB I Mohammed Abbas-6/+58
2024-07-30linker: Remove the "`--whole-archive` in test mode" backcompat hackVadim Petrochenkov-3/+1
2024-07-30chore: fix some commentsriyueguang-3/+3
Signed-off-by: riyueguang <rustruby@outlook.com>
2024-07-29Add `-Z embed-source=yes` to embed source code in DWARF debug infoMrmaxmeier-0/+12
2024-07-28Rollup merge of #128215 - ehuss:update-reference, r=KobzolMatthias Krüger-0/+0
Update the reference This updates the reference to use the new mdbook-spec preprocessor, which is a Cargo library inside the reference submodule. Note that this PR contains a bunch of bootstrap cleanup commits to assist with making sure the submodules are working correctly. All of the cleanup PRs should have a description in their commit. I'd be happy to move those to a separate PR if that makes review easier. The main changes for the reference are: - Move the `doc::Reference` bootstrap step out of the generic macro into a custom step. - This step needs to build rustdoc because the new mdbook-spec plugin uses rustdoc for generating links. - PATH is updated so that the rustdoc binary can be found. - rustbook now includes the mdbook-spec plugin as a dependency. - rustbook enables the mdbook-spec preprocessor. I did a bunch of testing with the various commands and setups, such as: - `submodules=true` and `submodules=false` - having all submodules deinitialized - not in a git repository However, there are probably thousands of different permutations of different commands, settings, and environments, so there is a chance I'm missing something.
2024-07-28Rollup merge of #128285 - lolbinarycat:rustc-custom-targets, r=jieyouxuMatthias Krüger-0/+13
rustc book: document how the RUST_TARGET_PATH variable is used based on the module comment in rust/compiler/rustc_target/src/spec/mod.rs Fixes #128280
2024-07-27rustc book: document how the RUST_TARGET_PATH variable is usedbinarycat-0/+13
based on the module comment in rust/compiler/rustc_target/src/spec/mod.rs Fixes #128280