about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2025-09-17a valid state is achieved by passing the test suiteTshepang Mbambo-1/+1
2025-09-17Rollup merge of #146460 - simp4t7:add-tidy-readme, r=clubby789Stuart Cook-1/+3
Add tidy readme This PR adds a Readme to `src/tools/tidy`. Basically just explains how `tidy` works and covers all of tidy's checks, directives, and how to use tidy. I tried to add a bit more detail on some of the options like `--extra-checks` and the style directives that aren't really documented well elsewhere. Planning to link to this in the dev guide. Closes: rust-lang/rust#129368
2025-09-17Rollup merge of #142807 - sourcefrog:failfast, r=dtolnayStuart Cook-0/+12
libtest: expose --fail-fast as an unstable command-line option This exposes the `fail_fast` option added in rust-lang/rust#105153 on the test harness command line, so that workflows that only want to know if any test fails can find out without waiting for everything to run. For example, cargo-mutants just needs to know if any tests fails. It only works with `-Zunstable-options`. Tracking issue: rust-lang/rust#142859
2025-09-16add Readme.md to tidyT-1/+3
update Readme add info about githooks and bootstrap.toml add info about config and remove linting specific files add link to rustc-dev-guide
2025-09-15Update src/tests/ci.mdJakub Beránek-1/+1
Co-authored-by: Ralf Jung <post@ralfj.de>
2025-09-15Clarify that backtick escaping doesn't work for `@bors try jobs`Jakub Beránek-2/+3
2025-09-14fix 404 linkLucas Baumann-1/+1
2025-09-14Drop armebv7r-none-eabi* to Tier 3Jonathan 'theJPster' Pallant-3/+3
These targets are not widely used, and are difficult to test because qemu-system-arm cannot emulate them.
2025-09-13Rollup merge of #146506 - mikysett:patch-1, r=UrgauJacob Pratt-1/+1
Fix small typo in check-cfg.md
2025-09-13Rollup merge of #146419 - thejpster:update-arm-target-docs, r=workingjubileeJacob Pratt-40/+264
Update the arm-* and aarch64-* platform docs. This PR updates some of the arm*-unknown-none target docs, and adds some missing target pages. ## aarch64-none-elf and aarch64-none-elf-softfloat The Rust Embedded Devices Working Group's Arm Team is added as a maintainer, and a target page is added. Links are added to the EDWG's support crates for this target. ## armv7a-none-eabi and armv7a-none-eabihf The Rust Embedded Devices Working Group's Arm Team is added as a maintainer, and a target page is added. Links are added to the EDWG's support crates for this target. ## armv7r-none-eabi and armv7r-none-eabihf The Rust Embedded Devices Working Group's Arm Team is added as a maintainer, and the target page is split from the Big Endian versions. Links are added to the EDWG's support crates for this target. ## armebv7r-none-eabi and armveb7r-none-eabihf The target page is split from the Little Endian versions. No change in maintainers. I have agreement to add EDWG/T-Arm as maintainers, which was voted upon in [their repo](https://github.com/rust-embedded/wg/issues/851).
2025-09-13Note that these targets are bare-metal.Jonathan 'theJPster' Pallant-13/+25
This is important to note, as it affects how easy it is to build a binary, and that `#![no_std]` is mandatory. A different PR should probably add this to all the other platform pages.
2025-09-13Fix small typo in check-cfg.mdMichele Sessa-1/+1
2025-09-12Fix two typos spotted in reviewJonathan 'theJPster' Pallant-4/+4
2025-09-12Re-order and re-work the aarch64-unknown-none platform support page.Jonathan 'theJPster' Pallant-60/+17
Removes a bunch of information that isn't, strictly speaking, target specific.
2025-09-12Remove bullet points from the target maintainer list for the arm bare-metal ↵Jonathan 'theJPster' Pallant-12/+12
targets
2025-09-12Add --print target-spec-json-schemaNoratrieb-0/+15
This schema is helpful for people writing custom target spec JSON. It can provide autocomplete in the editor, and also serves as documentation when there are documentation comments on the structs, as `schemars` will put them in the schema.
2025-09-12Merge pull request #2584 from rust-lang/tshepang-patch-5nora-2/+1
remove confusing parts of sentence
2025-09-12Merge pull request #2588 from fmease/to-crash-testsLeón Orell Valerian Liehr-9/+10
Rename "crashes tests" to "crash tests"
2025-09-12Rename "crashes tests" to "crash tests"León Orell Valerian Liehr-9/+10
2025-09-11Insert missing word.Jonathan 'theJPster' Pallant-2/+2
2025-09-11Cleanups from review comments.Jonathan 'theJPster' Pallant-4/+3
2025-09-11Add general arm-linux.md platform doc.Jonathan 'theJPster' Pallant-4/+234
Covers all Arm Linux systems, and means that we can reduce the amount of information required in the target specific pages to just the Tier level, the maintainer, and any specific details for that target.
2025-09-11Restructure the docsJakub Beránek-15/+37
2025-09-11Merge pull request #2385 from KMJ-007/masterManuel Drehwald-0/+194
documentation for Enzyme Type Trees
2025-09-11docs: typetree in autodiffkaran-0/+194
2025-09-11Rollup merge of #146370 - heiher:update-loong-linux-docs, r=jieyouxuStuart Cook-8/+11
Update the LoongArch target documentation This patch defines minimum CPU feature requirements, updates toolchain baseline, and streamlines maintainer list: - Specify double-precision floating-point and LSX as mandatory CPU features - Raise the minimum required binutils version to 2.42+, due to relocations introduced by the default medium code model - Remove outdated maintainers to reduce irrelevant notifications r? `@jieyouxu`
2025-09-10Update aarch64-unknown-none.md to include -softfloat tooJonathan 'theJPster' Pallant-2/+2
2025-09-10Add aarch64-unknown-none to SUMMARY.mdJonathan 'theJPster' Pallant-0/+1
2025-09-10Add missing links in platform-support.mdJonathan 'theJPster' Pallant-2/+2
2025-09-10Pick up changes from robamu that I missed.Jonathan 'theJPster' Pallant-18/+28
From https://github.com/thejpster/rust/pull/1.
2025-09-10Update the arm-* and aarch64-* platform docs.Jonathan 'theJPster' Pallant-19/+264
The Rust Embedded Devices Working Group (wg-embedded) Arm Team (t-arm) agreed to listed as maintainers of: * aarch64-unknown-none * aarch64-unknown-none-softfloat * armv7a-none-eabi * armv7r-none-eabi * armv7r-none-eabihf The aarch64-unknown-none* target didn't have a page so I added it. wg-embedded t-arm did not want to take over: * armebv7r-none-eabi * armebv7r-none-eabihf So I gave them their own target page. The current maintainer remains.
2025-09-10Merge pull request #2516 from lolbinarycat/patch-4Tshepang Mbambo-0/+1
glossary: add entry for rustbuild
2025-09-10Add missing documentation for running tests with GCC backendGuillaume Gomez-1/+32
2025-09-10glossary(rustbuild): reword according to code reviewlolbinarycat-1/+1
Co-authored-by: Tshepang Mbambo <hopsi@tuta.io>
2025-09-10glossary: add entry for rustbuildlolbinarycat-0/+1
2025-09-09Update the LoongArch target documentationWANG Rui-8/+11
This patch defines minimum CPU feature requirements, updates toolchain baseline, and streamlines maintainer list: - Specify double-precision floating-point and LSX as mandatory CPU features - Raise the minimum required binutils version to 2.42+, due to relocations introduced by the default medium code model - Remove outdated maintainers to reduce irrelevant notifications
2025-09-09Rollup merge of #146339 - rustbot:docs-update, r=ehussStuart Cook-0/+0
Update books ## rust-lang/nomicon 1 commits in 57ed4473660565d9357fcae176b358d7e8724ebf..f17a018b9989430967d1c58e9a12c51169abc744 2025-09-05 22:46:58 UTC to 2025-09-05 22:46:58 UTC - Add missing "C" ABI to FFI example code (rust-lang/nomicon#501) ## rust-lang/reference 7 commits in 89f67b3c1b904cbcd9ed55e443d6fc67c8ca2769..b3ce60628c6f55ab8ff3dba9f3d20203df1c0dee 2025-09-05 20:14:36 UTC to 2025-08-26 20:17:24 UTC - Ensure all lexical elements are SCREAMING_CASE (rust-lang/reference#1990) - Link out to the notation from grammar summary (rust-lang/reference#1989) - Or-patterns are extending (rust-lang/reference#1975) - Specify lifetime extension of `match` arms and `if` consequent/`else` block tail expressions (rust-lang/reference#1981) - clean up and properly test temporary lifetime extension in doctests (rust-lang/reference#1979) - Update `cold` and `inline` to use the attribute template (rust-lang/reference#1907) - Pluralize "syntax diagrams" (rust-lang/reference#1977) ## rust-lang/rust-by-example 1 commits in ad27f82c18464525c761a4a8db2e01785da59e1f..dd26bc8e726dc2e73534c8972d4dccd1bed7495f 2025-09-04 22:33:29 UTC to 2025-09-04 22:33:29 UTC - Fix drop order explanation in trait > drop (rust-lang/rust-by-example#1953)
2025-09-09Rollup merge of #139593 - lolbinarycat:sitemap, r=jieyouxuStuart Cook-0/+6
add sitemap to rust docs attempt to mitigate https://github.com/rust-lang/rust/issues/104670
2025-09-08Update booksrustbot-0/+0
2025-09-08Fix broken Microsoft URL missing slashAli Nazzal-1/+1
2025-09-08readabilityTshepang Mbambo-1/+1
2025-09-08fix markupTshepang Mbambo-0/+3
2025-09-08sembrTshepang Mbambo-5/+11
2025-09-08Merge pull request #2573 from rust-lang/tshepang/make-more-clearTshepang Mbambo-2/+4
clarify typo pr guidance
2025-09-08remove confusing parts of sentenceTshepang Mbambo-2/+1
I can guess what this meant, but decided to just keep it simple
2025-09-08Merge ref '2f3f27bf79ec' from rust-lang/rustThe rustc-josh-sync Cronjob Bot-76/+248
Pull recent changes from https://github.com/rust-lang/rust via Josh. Upstream ref: 2f3f27bf79ec147fec9d2e7980605307a74067f4 Filtered ref: 82a5eafbafdb98eae68193600732388ae4135756 Upstream diff: https://github.com/rust-lang/rust/compare/a1dbb443527bd126452875eb5d5860c1d001d761...2f3f27bf79ec147fec9d2e7980605307a74067f4 This merge was created using https://github.com/rust-lang/josh-sync.
2025-09-08Prepare for merging from rust-lang/rustThe rustc-josh-sync Cronjob Bot-1/+1
This updates the rust-version file to 2f3f27bf79ec147fec9d2e7980605307a74067f4.
2025-09-07Rollup merge of #146170 - kumarUjjawal:master, r=Mark-SimulacrumMatthias Krüger-2/+4
fix: offline rustdoc html missing favicon As discussed in the rust-lang/rust#146149 the doc was missing the favicon icon when build locally and viewed on a browser. I changed the relative path and also now we explicitly copy both SVG and PNG. <img width="1132" height="425" alt="Screenshot 2025-09-03 at 11 57 46 PM" src="https://github.com/user-attachments/assets/062cbb08-04ec-4d88-a43a-710fb6190f82" />
2025-09-06Auto merge of #146233 - jieyouxu:run-make-fission, r=Kobzolbors-30/+39
Split `run-make` into two {`run-make`,`run-make-cargo`} test suites ## Summary Split `tests/run-make` into two test suites, to make it faster and more convenient for contributors to run run-make tests that do not need in-tree `cargo`. | New test suites | Explanation | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tests/run-make` | The "fast path" test suite intended for run-make tests that do not need in-tree `cargo`. These tests may not use `cargo`. | | `tests/run-make-cargo` | The "slow path" test suite that requires checking out `cargo` submodule and building in-tree `cargo`, and thus will have access to in-tree `cargo`. In practice, these constitute a very small portion of the original `run-make` tests. | This PR carries out [MCP 847: Split run-make test suite into slower-building test suite with suitably-staged cargo and faster-building test suite without cargo](https://github.com/rust-lang/compiler-team/issues/847). Fixes rust-lang/rust#135573 (for the tests that do not need in-tree `cargo`). Fixes rust-lang/rust#134109. ## Remarks - I considered if we want to split by in-tree tools previously. However, as discussed rust-lang/rust#134109, in practice `rustdoc` is not very slow to build, but `cargo` takes a good few minutes. So, the partition boundary was determined to be along in-tree `cargo` availability. - The `run-make` tests previously that wanted to use `cargo` cannot just use the bootstrap `cargo`, otherwise they would run into situations where bootstrap `cargo` can significantly diverge from in-tree `cargo` (see https://github.com/rust-lang/rust/pull/130642). --- try-job: aarch64-msvc-1 try-job: test-various try-job: x86_64-gnu-debug try-job: aarch64-gnu-debug try-job: aarch64-apple try-job: dist-various-1
2025-09-06point to Compiler team docs on ForgeTshepang Mbambo-0/+4