summary refs log tree commit diff
path: root/src/doc/rustc
AgeCommit message (Collapse)AuthorLines
2023-01-16Update instrument-coverage.mdgftea-0/+2
Document the default for LLVM_PROFILE_FILE and add a recemmondation for setting it for older versions of Rust which had a different default.
2023-01-11Change `src/test` to `tests` in source files, fix tidy and testsAlbert Larsan-2/+2
2023-01-09Accept old spelling of Fuchsia target triplesDavid Koloski-0/+2
Because the old spelling is widely used, some projects may need time to migrate their uses to the new triple spelling. The old spelling may eventually be removed altogether.
2023-01-05Add vendor to Fuchsia's target tripleDavid Koloski-50/+50
Historically, Rust's Fuchsia targets have been labeled x86_64-fuchsia and aarch64-fuchsia. However, they should technically contain vendor information. This CL changes Fuchsia's target triples to include the "unknown" vendor since Clang now does normalization and handles all triple spellings. This was previously attempted in #90510, which was closed due to inactivity.
2023-01-04Rollup merge of #106464 - djkoloski:update_fuchsia_platform_support_docs, ↵Michael Goulet-0/+3
r=tmandry Update Fuchsia walkthrough with new configs The new `download-ci-llvm` configuration option dosn't work with `lld = true` (see #100853). The Fuchsia walkthrough should recommend setting it to `false`. r? `@tmandry`
2023-01-04Update Fuchsia walkthrough with new configsDavid Koloski-0/+3
The new `download-ci-llvm` configuration option dosn't work with `lld = true` (see #100853). The Fuchsia walkthrough should recommend setting it to `false`.
2023-01-03Auto merge of #105712 - amg98:feat/vita-support, r=wesleywiserbors-0/+129
PlayStation Vita support Just the compiler definitions for no-std projects and std support using newlib Earlier PR: https://github.com/rust-lang/rust/pull/105606
2022-12-30Added link from Targets to Platform Support in the bookTrevor Gross-1/+4
2022-12-16remove relative links from `rustc-book` and `unstable-book`Ezra Shaw-12/+12
Co-authored-by: Joshua Nelson <github@jyn.dev>
2022-12-14Added PlayStation Vita supportAndrés Martínez-0/+129
2022-12-10doc: document remap matching behaviour in rustc flagsAlexis (Poliorcetics) Bourget-0/+3
2022-11-29Rollup merge of #104523 - flba-eb:fix_nto_target_name, r=wesleywiserMatthias Krüger-11/+13
Don't use periods in target names Using a period in the target name can cause issues in e.g. cargo, see also https://rust-lang.zulipchat.com/#narrow/stream/182449-t-compiler.2Fhelp/topic/Running.20tests.20on.20remote.20target
2022-11-29Rollup merge of #104465 - djkoloski:improve_fuchsia_testing_docs, r=tmandryMatthias Krüger-23/+60
Document more settings for building rustc for Fuchsia This documents that you need to link for Fuchsia with `lld` and provides configuration settings for both `clang` and `lld`. It also adjusts the documentation for running the test suite to recommend installing to a prefix. r? ``@tmandry``
2022-11-27Stabilize native library modifier `verbatim`Vadim Petrochenkov-0/+27
2022-11-17Remove periods from QNX/nto target namesFlorian Bartels-11/+11
2022-11-17Encourage developers not to use periods in target namesFlorian Bartels-0/+2
They can cause issues in e.g. cargo.
2022-11-17Add powerpc64-ibm-aix as Tier-3 targetQiu Chaofan-0/+1
2022-11-16[fuchsia] Document more settings for building RustDavid Koloski-23/+60
2022-11-16Rollup merge of #104137 - StackDoubleFlow:err-lsc-unsupported, r=bjorn3Matthias Krüger-2/+2
Issue error when -C link-self-contained option is used on unsupported platforms The documentation was also updated to reflect this. I'm assuming the supported platforms are the same as initially written in [RELEASES.md](https://github.com/rust-lang/rust/blob/master/RELEASES.md#compiler-17). Fixes #103576
2022-11-15Fuchsia test suite script fixAndrew Pollack-6/+12
2022-11-14Issue error when `-C link-self-contained` option is used on unsupported ↵StackDoubleFlow-2/+2
platforms Document supported targets for `-C link-self-contained` Move `LinkSelfContainedDefault::True` from wasm_base to wasm32_wasi
2022-11-15Rollup merge of #103842 - andrewpollack:add-fuchsia-test-script, r=tmandryMatthias Krüger-2/+54
Adding Fuchsia compiler testing script, docs Adding Fuchsia compiler testing script and related docs updates r? `@tmandry` cc. `@djkoloski`
2022-11-12Remove example code as it does not compile in CIFlorian Bartels-1/+1
Code is QNX/nto specific and will not link on Windows.
2022-11-11Adding Fuchsia compiler testing script, docsAndrew Pollack-2/+54
2022-11-11Add Tristan as maintainerFlorian Bartels-0/+1
2022-11-11Add no_std AArch64 support for the QNX Neutrino (nto) 7.1 RTOSFlorian Bartels-0/+120
This change allows to compile no_std applications for the QNX Neutrino realtime operating system for ARM 64 bit CPUs. Tested with QNX Neutrino 7.1.
2022-11-09Rollup merge of #104015 - alex:remove-kernel, r=oli-obkManish Goregaokar-1/+0
Remove linuxkernel targets These are not used by the actual Rust-for-Linux project, so they're mostly just confusing.
2022-11-09Rollup merge of #103933 - nicholasbishop:bishop-uefi-tier-2, r=JohnTitorDylan DPC-33/+11
Promote {aarch64,i686,x86_64}-unknown-uefi to Tier 2 MCP: https://github.com/rust-lang/compiler-team/issues/555 CC `@dvdhrm`
2022-11-08Rollup merge of #103955 - str4d:update-lto-doc-1.65, r=ehussDylan DPC-45/+49
Update linker-plugin-lto.md to contain up to Rust 1.65 The table rows were obtained via the script embedded in the page.
2022-11-07Migrate linker-plugin-lto.md compatibility table to show Rust rangesJack Grigg-50/+49
The helper shell script has been rewritten as a helper Python script that generates the range-based table.
2022-11-05Remove linuxkernel targetsAlex Gaynor-1/+0
These are not used by the actual Rust-for-Linux project, so they're mostly just confusing.
2022-11-04Promote {aarch64,i686,x86_64}-unknown-uefi to Tier 2Nicholas Bishop-33/+11
MCP: https://github.com/rust-lang/compiler-team/issues/555
2022-11-04Update linker-plugin-lto.md to contain up to Rust 1.65Jack Grigg-1/+6
The table rows were obtained via the script embedded in the page.
2022-11-03Add howto for adding new targetsFlorian Bartels-0/+25
2022-11-01Rollup merge of #103674 - ehuss:split-debuginfo-doc-unstable, r=davidtwcoYuki Okushi-2/+4
Update note about unstable split-debuginfo flag. split-debuginfo was effectively stabilized in #98051. The note about it requiring `-Z unstable-options` is no longer accurate. The rules for when it is gated and when it is supported are somewhat complex. I considered removing the note entirely, or making it more generic, but opted to instead try to summarize the current state.
2022-10-30Rollup merge of #102689 - ayrtonm:master, r=cjgillotMichael Howell-0/+51
Add a tier 3 target for the Sony PlayStation 1 This adds a tier 3 target, `mipsel-sony-psx`, for the Sony PlayStation 1. I've tested it pretty thoroughly with [this SDK](https://github.com/ayrtonm/psx-sdk-rs) I wrote for it. From the [tier 3 target policy](https://doc.rust-lang.org/rustc/target-tier-policy.html#tier-3-target-policy) (I've omitted the subpoints for brevity, but read over everything) > A tier 3 target must have a designated developer or developers (the "target maintainers") on record to be CCed when issues arise regarding the target. (The mechanism to track and CC such developers may evolve over time.) I'd be the designated developer > Targets must use naming consistent with any existing targets; for instance, a target for the same CPU or OS as an existing Rust target should use the same name for that CPU or OS. Targets should normally use the same names and naming conventions as used elsewhere in the broader ecosystem beyond Rust (such as in other toolchains), unless they have a very good reason to diverge. Changing the name of a target can be highly disruptive, especially once the target reaches a higher tier, so getting the name right is important even for a tier 3 target. The target name follows the conventions of the existing PSP target (`mipsel-sony-psp`) and uses `psx` following the convention of the broader [PlayStation homebrew community](https://psx-spx.consoledev.net/). > Tier 3 targets may have unusual requirements to build or use, but must not create legal issues or impose onerous legal terms for the Rust project or for Rust developers or users. No legal issues with this target. > Neither this policy nor any decisions made regarding targets shall create any binding agreement or estoppel by any party. If any member of an approving Rust team serves as one of the maintainers of a target, or has any legal or employment requirement (explicit or implicit) that might affect their decisions regarding a target, they must recuse themselves from any approval decisions regarding the target's tier status, though they may otherwise participate in discussions. :+1: > Tier 3 targets should attempt to implement as much of the standard libraries as possible and appropriate (core for most targets, alloc for targets that can support dynamic memory allocation, std for targets with an operating system or equivalent layer of system-provided functionality), but may leave some code unimplemented (either unavailable or stubbed out as appropriate), whether because the target makes it impossible to implement or challenging to implement. The authors of pull requests are not obligated to avoid calling any portions of the standard library on the basis of a tier 3 target not implementing those portions. The psx supports `core` and `alloc`, but will likely not support `std` anytime soon. > The target must provide documentation for the Rust community explaining how to build for the target, using cross-compilation if possible. If the target supports running binaries, or running tests (even if they do not pass), the documentation must explain how to run such binaries or tests for the target, using emulation if possible or dedicated hardware if necessary. This target has an SDK and a `cargo-psx` tool for formatting binaries as psx executables. Documentation and examples are provided in the [psx-sdk-rs README](https://github.com/ayrtonm/psx-sdk-rs#psx-sdk-rs), the SDK and cargo tool are both available through crates.io and docs.rs has [SDK documentation](https://docs.rs/psx/latest/psx/). > Tier 3 targets must not impose burden on the authors of pull requests, or other developers in the community, to maintain the target. In particular, do not post comments (automated or manual) on a PR that derail or suggest a block on the PR based on a tier 3 target. Do not send automated messages or notifications (via any medium, including via `@)` to a PR author or others involved with a PR regarding a tier 3 target, unless they have opted into such messages. :+1: > Patches adding or updating tier 3 targets must not break any existing tier 2 or tier 1 target, and must not knowingly break another tier 3 target without approval of either the compiler team or the maintainers of the other tier 3 target. No problem
2022-10-27Update note about unstable split-debuginfo flag.Eric Huss-2/+4
2022-10-24Document link to unstable bookCameron Steffen-1/+1
2022-10-20fix typocui fliter-1/+1
2022-10-10Add Sony PlayStation 1 tier 3 targetAyrton-0/+51
2022-10-06Remove `-Ztime` option.Nicholas Nethercote-1/+1
The compiler currently has `-Ztime` and `-Ztime-passes`. I've used `-Ztime-passes` for years but only recently learned about `-Ztime`. What's the difference? Let's look at the `-Zhelp` output: ``` -Z time=val -- measure time of rustc processes (default: no) -Z time-passes=val -- measure time of each rustc pass (default: no) ``` The `-Ztime-passes` description is clear, but the `-Ztime` one is less so. Sounds like it measures the time for the entire process? No. The real difference is that `-Ztime-passes` prints out info about passes, and `-Ztime` does the same, but only for a subset of those passes. More specifically, there is a distinction in the profiling code between a "verbose generic activity" and an "extra verbose generic activity". `-Ztime-passes` prints both kinds, while `-Ztime` only prints the first one. (It took me a close reading of the source code to determine this difference.) In practice this distinction has low value. Perhaps in the past the "extra verbose" output was more voluminous, but now that we only print stats for a pass if it exceeds 5ms or alters the RSS, `-Ztime-passes` is less spammy. Also, a lot of the "extra verbose" cases are for individual lint passes, and you need to also use `-Zno-interleave-lints` to see those anyway. Therefore, this commit removes `-Ztime` and the associated machinery. One thing to note is that the existing "extra verbose" activities all have an extra string argument, so the commit adds the ability to accept an extra argument to the "verbose" activities.
2022-09-30Upgrade dist-i586-gnu-i586-i686-musl to ubuntu:22.04Josh Stone-1/+1
The system GCC 5 in ubuntu:16.04 will be too old to compile LLVM 16, so we need an upgrade. To avoid raising the minimum glibc requirements for `i586-unknown-linux-gnu`, this target is converted to a crosstool-ng toolchain, *relaxing* it to the same Linux 3.2 / glibc 2.17 minimum we use elsewhere. The musl targets still use Ubuntu's system toolchain, but this doesn't have the same compatibility concerns.
2022-09-24Rollup merge of #102218 - ehuss:rustc-flags, r=JohnTitorMatthias Krüger-0/+11
Document some missing command-line arguments The rustc command-line arguments docs should document all of the stable arguments for rustc. Two were missing, `--force-warn` which was somewhat documented in the lint-levels chapter, but should also include a mention in the arguments list. `--diagnostic-width` was stabilized in #95635, but the docs weren't updated.
2022-09-24Rollup merge of #101780 - chriswailes:android-platform, r=joshtriplettMatthias Krüger-6/+52
Add a platform support document for Android r? ``@joshtriplett``
2022-09-23Document some missing command-line argumentsEric Huss-0/+11
2022-09-23Respond to document review feedbackChris Wailes-3/+3
2022-09-21Auto merge of #101329 - QuinnPainter:armv5te-targets, r=nagisabors-0/+69
Add armv5te-none-eabi and thumbv5te-none-eabi targets Creates two new Tier 3 targets, `armv5te-none-eabi` and `thumbv5te-none-eabi`. They are for the same target architecture (armv5te), but one defaults to the A32 instruction set and the other defaults to T32. Based on the existing `armv4t-none-eabi` and `thumbv4t-none-eabi` targets. My particular use case for these targets is Nintendo DS homebrew, but they should be usable for any armv5te system. Going through the Tier 3 target policy: > A tier 3 target must have a designated developer or developers (the "target maintainers") on record to be CCed when issues arise regarding the target. (The mechanism to track and CC such developers may evolve over time.) That will be me. > Targets must use naming consistent with any existing targets. Naming is consistent with previous targets. >> Target names should not introduce undue confusion or ambiguity unless absolutely necessary to maintain ecosystem compatibility. No ambiguity here. > Tier 3 targets may have unusual requirements to build or use, but must not create legal issues or impose onerous legal terms for the Rust project or for Rust developers or users. Doesn't create any legal issues. >> The target must not introduce license incompatibilities. This doesn't introduce any new licenses. >> Anything added to the Rust repository must be under the standard Rust license (MIT OR Apache-2.0). Yep. >> The target must not cause the Rust tools or libraries built for any other host (even when supporting cross-compilation to the target) to depend on any new dependency less permissive than the Rust licensing policy. This applies whether the dependency is a Rust crate that would require adding new license exceptions (as specified by the tidy tool in the rust-lang/rust repository), or whether the dependency is a native library or binary. In other words, the introduction of the target must not cause a user installing or running a version of Rust or the Rust tools to be subject to any new license requirements. No new license requirements. >> Compiling, linking, and emitting functional binaries, libraries, or other code for the target (whether hosted on the target itself or cross-compiling from another target) must not depend on proprietary (non-FOSS) libraries. Everything this uses is FOSS, no proprietary required. > Neither this policy nor any decisions made regarding targets shall create any binding agreement or estoppel by any party. If any member of an approving Rust team serves as one of the maintainers of a target, or has any legal or employment requirement (explicit or implicit) that might affect their decisions regarding a target, they must recuse themselves from any approval decisions regarding the target's tier status, though they may otherwise participate in discussions. OK. >> This requirement does not prevent part or all of this policy from being cited in an explicit contract or work agreement (e.g. to implement or maintain support for a target). This requirement exists to ensure that a developer or team responsible for reviewing and approving a target does not face any legal threats or obligations that would prevent them from freely exercising their judgment in such approval, even if such judgment involves subjective matters or goes beyond the letter of these requirements. OK. > Tier 3 targets should attempt to implement as much of the standard libraries as possible and appropriate (core for most targets, alloc for targets that can support dynamic memory allocation, std for targets with an operating system or equivalent layer of system-provided functionality), but may leave some code unimplemented (either unavailable or stubbed out as appropriate), whether because the target makes it impossible to implement or challenging to implement. The authors of pull requests are not obligated to avoid calling any portions of the standard library on the basis of a tier 3 target not implementing those portions. This is a bare-metal target with only support for `core` (and `alloc`, if the user provides an allocator). > The target must provide documentation for the Rust community explaining how to build for the target, using cross-compilation if possible. If the target supports running binaries, or running tests (even if they do not pass), the documentation must explain how to run such binaries or tests for the target, using emulation if possible or dedicated hardware if necessary. Documentation has been added. > Tier 3 targets must not impose burden on the authors of pull requests, or other developers in the community, to maintain the target. In particular, do not post comments (automated or manual) on a PR that derail or suggest a block on the PR based on a tier 3 target. Do not send automated messages or notifications (via any medium, including via `@)` to a PR author or others involved with a PR regarding a tier 3 target, unless they have opted into such messages. OK. > Backlinks such as those generated by the issue/PR tracker when linking to an issue or PR are not considered a violation of this policy, within reason. However, such messages (even on a separate repository) must not generate notifications to anyone involved with a PR who has not requested such notifications. OK. > Patches adding or updating tier 3 targets must not break any existing tier 2 or tier 1 target, and must not knowingly break another tier 3 target without approval of either the compiler team or the maintainers of the other tier 3 target. This doesn't break any other targets. >> In particular, this may come up when working on closely related targets, such as variations of the same architecture with different features. Avoid introducing unconditional uses of features that another variation of the target may not have; use conditional compilation or runtime detection, as appropriate, to let each target run code supported by that target. No unnecessary unconditional features here.
2022-09-20Add links to the Android platform support docChris Wailes-6/+7
2022-09-20Add a platform support document for AndroidChris Wailes-0/+45
2022-09-18Rollup merge of #101151 - jethrogb:jb/sgx-platform, r=JohnTitorMatthias Krüger-1/+74
Document x86_64-fortanix-unknown-sgx platform cc `@raoulstrackx` `@mzohreva`