about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2022-09-25Rollup merge of #101997 - cuviper:drop-legacy-pm, r=nikicfee1-dead-1/+1
Remove support for legacy PM This removes support for optimizing with LLVM's legacy pass manager, as well as the unstable `-Znew-llvm-pass-manager` option. We have been defaulting to the new PM since LLVM 13 (except for s390x that waited for 14), and LLVM 15 removed support altogether. The only place we still use the legacy PM is for writing the output file, just like `llc` does. cc #74705 r? ``@nikic``
2022-09-24style-guide: Fix broken linksJosh Triplett-2/+2
2022-09-24style-guide: Remove trailing spaceJosh Triplett-6/+6
2022-09-24Move style guide to rust-lang/rustJosh Triplett-0/+2001
Per [RFC 3309](https://rust-lang.github.io/rfcs/3309-style-team.html).
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-22Rollup merge of #102079 - ehuss:update-books, r=ehussYuki Okushi-0/+0
Update books ## nomicon 1 commits in d880e6ac2acf133dce640da24b9fb692844f02d4..f53bfa056929217870a5d2df1366d2e7ba35096d 2022-08-24 12:42:34 -0700 to 2022-09-05 07:19:02 -0700 - Small typo (rust-lang/nomicon#379) ## reference 9 commits in f62e93c28323ed9637d0a205a0c256498674a509..a7cdac33ca7356ad49d5c2b5e2c5010889b33eee 2022-08-28 10:01:28 -0700 to 2022-09-19 17:39:58 -0700 - Clarify wording for references. (rust-lang/reference#1223) - Update Unicode reference to match rustc implementation (rust-lang/reference#1271) - Add documentation for raw-dylib and link_ordinal (rust-lang/reference#1244) - Specify guarantees for repr(rust) structs (rust-lang/reference#1152) - Classify AsyncBlockExpression as ExpressionWithoutBlock (rust-lang/reference#1268) - Update closure-expr.md (rust-lang/reference#1269) - Clarify that 0 is a valid multiple of a type's alignment (rust-lang/reference#1260) - Remove `ne` from derive example (rust-lang/reference#1264) - Clarify reference on async blocks (rust-lang/reference#1262) ## book 6 commits in 0a5421ceb238357b3634fb75234eba4d1dad643c..f1e5ad844d0c61738006cdef26227beeb136948e 2022-08-28 19:51:04 -0400 to 2022-09-19 09:48:21 -0400 - Fix punctuation in ch05-02 - Ownership move chapter link fix - Wrong listing number - Reword text around box - `Box<T>` instead of "box" - Update Clippy output in Appendix D ## rust-by-example 2 commits in 03301f8ae55fa6f20f7ea152a517598e6db2cdb7..767a6bd9727a596d7cfdbaeee475e65b2670ea3a 2022-08-14 08:51:44 -0300 to 2022-09-14 09:17:18 -0300 - struct_visibility.md: Remove unneeded '#[allow(dead_code)]' (rust-lang/rust-by-example#1609) - Fix assorted typos (rust-lang/rust-by-example#1601) ## rustc-dev-guide 15 commits in 04892c1a6fc145602ac7367945fda9d4ee83c9fb..f587d6e7cddeaa3cf0a33ec1e368df1a408fa0aa 2022-08-29 20:07:51 +0200 to 2022-09-20 07:43:59 +0900 - Update stability guide to use CURRENT_RUSTC_VERSION (rust-lang/rustc-dev-guide#1468) - Add a note about building `rust-analyzer-proc-macro-srv` (rust-lang/rustc-dev-guide#1467) - Link from "implementing to new features" to mcp.md (rust-lang/rustc-dev-guide#1465) - remove stray ** - Explain the new valtree system for type level constants. (rust-lang/rustc-dev-guide#1097) - fix typos and formatting - Say "bootstrap" instead of "rustbuild"; the latter is not explained anywhere and is not much more clear. - Rewrite the section on passing flags to subcommands - Remove the diagram of all outputs generated by x.py - "symbol names" => ABI - Add symbol-addition to the how-to for new features (rust-lang/rustc-dev-guide#1457) - Fix typo (rust-lang/rustc-dev-guide#1459) - Document multipart_suggestion derive on SessionSubdiagnostic - Add reference for updating Windows PATH and fix typo - Update for removal of RLS (rust-lang/rustc-dev-guide#1450) ## embedded-book 1 commits in befe6840874311635c417cf731377f07234ee373..4ce51cb7441a6f02b5bf9b07b2eb755c21ab7954 2022-07-25 07:51:14 +0000 to 2022-09-15 08:53:09 +0000 - Create CITATION.bib (as per rust-embedded/book#327) (rust-embedded/book#329)
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-20Update booksEric Huss-0/+0
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-18Update the reason llvm tracing is disabled by defaultJosh Stone-1/+1
Co-authored-by: Andreas Jonson <andjo403@users.noreply.github.com>
2022-09-18Remove -Znew-llvm-pass-managerJosh Stone-1/+1
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`
2022-09-17Rollup merge of #101915 - notriddle:notriddle/redirect, r=GuillaumeGomezDylan DPC-1/+1
doc: fix redirected link in `/index.html` Fallout from #101166
2022-09-16Rollup merge of #101340 - andrewpollack:fuchsia-zxdb-docs, r=tmandryMichael Howell-2/+135
Adding Fuchsia zxdb debugging walkthrough to docs Adding `zxdb` docs to walkthrough to show debugging steps
2022-09-16doc: fix redirected link in `/index.html`Michael Howell-1/+1
2022-09-16Adding Fuchsia zxdb debugging walkthrough to docsAndrew Pollack-2/+135
2022-09-14Changes to rename target and update docsYour Name-13/+14
2022-09-13Added platform docsYour Name-0/+75
2022-09-10Auto merge of #99916 - dpaoliello:stablizerawdylib, r=wesleywiserbors-5/+5
Stabilize raw-dylib for non-x86 This stabilizes the `raw-dylib` and `link_ordinal` features (#58713) for non-x86 architectures (i.e., `x86_64`, `aarch64` and `thumbv7a`): * Marked the `raw_dylib` feature as `active`. * Marked the `link_ordinal` attribute as `ungated`. * Added new errors if either feature is used on x86 targets without the `raw_dylib` feature being enabled. * Updated tests to only set the `raw_dylib` feature when building for x86.
2022-09-09Stabilze raw-dylib for non-x86Daniel Paoliello-5/+5
2022-09-09remove DS stuff from docs + change to use thumb_baseQuinn Painter-11/+2
2022-09-08Link UEFI target documentation from target listSeo Sanghyeon-3/+3
2022-09-07Rollup merge of #101343 - diminishedprime:patch-3, r=tmandryMatthias Krüger-0/+1
Add -api-level to pm command As of ~Aug 30th, `pm build` commands require an `api-level` flag. This flag should match the fuchsia api-level that's being targeted by the code. Since this is dependent on the version of the SDK that's being used, we may want to change this to something a bit more robust in the future.
2022-09-06Update src/doc/rustc/src/platform-support/fuchsia.mdMatt Hamrick-1/+1
Co-authored-by: Andrew Pollack <andrewpkq@gmail.com>
2022-09-03Rollup merge of #101347 - diminishedprime:patch-4, r=tmandryMatthias Krüger-0/+2
ffx component run should provide a collection In the future,`ffx component run` will not default to the using the `/core/ffx-laboratory` collection. Updated the run commands to include this.
2022-09-03Rollup merge of #101338 - diminishedprime:patch-2, r=tmandryDylan DPC-3/+11
Fix unsupported syntax in .manifest file Fuchsia .manifest files do not support a `#` comment syntax. Because of this, if you copy and paste the current example code for this file, and then remove the line you don't need, you still see an error. To make this a bit easier to follow, split this into two code blocks, one for rustc, and one for cargo.
2022-09-02ffx component run should provide a collectionMatt Hamrick-0/+2
In the future,`ffx component run` will not default to the using the `/core/ffx-laboratory` collection. Updated the run commands to include this.
2022-09-02Auto merge of #97802 - Enselic:add-no_ignore_sigkill-feature, r=joshtriplettbors-0/+54
Support `#[unix_sigpipe = "inherit|sig_dfl"]` on `fn main()` to prevent ignoring `SIGPIPE` When enabled, programs don't have to explicitly handle `ErrorKind::BrokenPipe` any longer. Currently, the program ```rust fn main() { loop { println!("hello world"); } } ``` will print an error if used with a short-lived pipe, e.g. % ./main | head -n 1 hello world thread 'main' panicked at 'failed printing to stdout: Broken pipe (os error 32)', library/std/src/io/stdio.rs:1016:9 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace by enabling `#[unix_sigpipe = "sig_dfl"]` like this ```rust #![feature(unix_sigpipe)] #[unix_sigpipe = "sig_dfl"] fn main() { loop { println!("hello world"); } } ``` there is no error, because `SIGPIPE` will not be ignored and thus the program will be killed appropriately: % ./main | head -n 1 hello world The current libstd behaviour of ignoring `SIGPIPE` before `fn main()` can be explicitly requested by using `#[unix_sigpipe = "sig_ign"]`. With `#[unix_sigpipe = "inherit"]`, no change at all is made to `SIGPIPE`, which typically means the behaviour will be the same as `#[unix_sigpipe = "sig_dfl"]`. See https://github.com/rust-lang/rust/issues/62569 and referenced issues for discussions regarding the `SIGPIPE` problem itself See the [this](https://rust-lang.zulipchat.com/#narrow/stream/219381-t-libs/topic/Proposal.3A.20First.20step.20towards.20solving.20the.20SIGPIPE.20problem) Zulip topic for more discussions, including about this PR. Tracking issue: https://github.com/rust-lang/rust/issues/97889
2022-09-02Add -api-level to pm commandMatt Hamrick-0/+1
As of ~Aug 30th, `pm build` commands require an `api-level` flag. This flag should match the fuchsia api-level that's being targeted by the code. Since this is dependent on the version of the SDK that's being used, we may want to change this to something a bit more robust in the future.
2022-09-02Fix unsupported syntax in .manifest fileMatt Hamrick-3/+11
Fuchsia .manifest files do not support a `#` comment syntax. Because of this, if you copy and paste the current example code for this file, and then remove the line you don't need, you still see an error. To make this a bit easier to follow, split this into two code blocks, one for rustc, and one for cargo.
2022-09-02Add {thumb,arm}v5te-none-eabi targetsQuinn Painter-0/+78
2022-09-01Rollup merge of #101271 - QuinnPainter:patch-1, r=Dylan-DPCMatthias Krüger-0/+0
Fix filename of armv4t-none-eabi.md The filename differed from the link in SUMMARY.md, causing it to 404.
2022-09-01Rollup merge of #101256 - andrewpollack:fuchsia-docs-adding, r=tmandryMatthias Krüger-10/+18
Fixes/adjustments to Fuchsia doc walkthrough Small fixes/adjustments missed during #100927
2022-09-01Rollup merge of #101251 - diminishedprime:patch-1, r=JohnTitorMatthias Krüger-1/+1
Fix bad target name in Walkthrough Walkthrough currently say: ``` rustup target add aarch_64-fuchsia ``` but should say ``` rustup target add aarch64-fuchsia ```
2022-09-01Fix filename of armv4t-none-eabi.mdQuinn Painter-0/+0
The filename differed from the link in SUMMARY.md, causing it to 404.
2022-09-01Auto merge of #100707 - dzvon:fix-typo, r=davidtwcobors-5/+5
Fix a bunch of typo This PR will fix some typos detected by [typos]. I only picked the ones I was sure were spelling errors to fix, mostly in the comments. [typos]: https://github.com/crate-ci/typos
2022-09-01Tweaks to fuchsia doc walkthroughAndrew Pollack-10/+18
2022-08-31Fix bad target name in WalkthroughMatt Hamrick-1/+1
Walkthrough currently say: ``` rustup target add aarch_64-fuchsia ``` but should say ``` rustup target add aarch64-fuchsia ```
2022-08-31Rollup merge of #101240 - JohnTitor:JohnTitor-patch-1, r=ehussMatthias Krüger-1/+1
Fix a typo on `wasm64-unknown-unknown` doc
2022-08-31Fix a typo on `wasm64-unknown-unknown` docYuki Okushi-1/+1
2022-08-31Document x86_64-fortanix-unknown-sgx platformJethro Beekman-1/+74
2022-08-31Rollup merge of #101216 - ehuss:sanitizer-links, r=JohnTitorRalf Jung-10/+26
Use in-page links for sanitizer docs. This updates the sanitizer documentation page so that the links in the summary at the top jump to the relevant sections within the page instead of leading away to a different site. I think this makes it a little easier to navigate this page which has gotten quite long. This also fixes the broken link for MemTagSanitizer which was not defined. It also adds MemTagSanitizer to the external summary list at the bottom of the page.
2022-08-31Fix a bunch of typoDezhi Wu-6/+6
This PR will fix some typos detected by [typos]. I only picked the ones I was sure were spelling errors to fix, mostly in the comments. [typos]: https://github.com/crate-ci/typos
2022-08-31Rollup merge of #101025 - semarie:openbsd-archs, r=petrochenkovMatthias Krüger-0/+4
Add tier-3 support for powerpc64 and riscv64 openbsd # powerpc64 - MCP for [powerpc64-unknown-openbsd tier-3 support](https://github.com/rust-lang/compiler-team/issues/551) - only need to add spec definition in rustc_target # riscv64 - MCP for [riscv64-unknown-openbsd tier-3 support](https://github.com/rust-lang/compiler-team/issues/552) - add spec definition in rustc_target - follow freebsd about avoiding linking with `libatomic`
2022-08-31Rollup merge of #101219 - ehuss:update-books, r=ehussYuki Okushi-0/+0
Update books ## nomicon 1 commits in 8e6aa3448515a0654e347b5e2510f1d4bc4d5a64..d880e6ac2acf133dce640da24b9fb692844f02d4 2022-08-15 15:36:13 -0700 to 2022-08-24 12:42:34 -0700 - Update lifetimes.md (rust-lang/nomicon#372) ## reference 2 commits in e647eb102890e8927f488bea12672b079eff8d9d..f62e93c28323ed9637d0a205a0c256498674a509 2022-08-16 11:35:27 -0700 to 2022-08-28 10:01:28 -0700 - Update examples of what implements `Termination` (rust-lang/reference#1256) - allow to quickly edit a page directly on github (rust-lang/reference#1254) ## book 7 commits in 42ca0ef484fcc8437a0682cee23abe4b7c407d52..0a5421ceb238357b3634fb75234eba4d1dad643c 2022-08-12 21:52:02 -0400 to 2022-08-28 19:51:04 -0400 - Add a missing line generated by 'cargo new' - Clarify ThreadPool-Worker analogy wording - Fixed incorrect mutex lock usage - Merge remote-tracking branch 'origin/pr/3314' - Put interactive book notice in a blockquote box to draw attention to it - Remove the word 'new' because someday it won't be new anymore - Merge remote-tracking branch 'origin/pr/3304' ## rustc-dev-guide 27 commits in d3daa1f28e169087becbc5e2b49ac91ca0405a44..04892c1a6fc145602ac7367945fda9d4ee83c9fb 2022-08-13 10:00:38 +0900 to 2022-08-29 20:07:51 +0200 - Fix the link to `Parser` struct - Remove a dangling link on "The `#[test]` attribute" - Update the stabilization guide to refer to the new placeholder system - Refine the lintstore section (rust-lang/rustc-dev-guide#1429) - typo - Updates text to refer to LLVM documentation. - Updates LLVM prereqs since upgrade to C++17. - we got 3 (rust-lang/rustc-dev-guide#1447) - A few corrections - Update some statements - correct typo in parallel-rustc.md - Correct some statements in parallel-rustc.md - update parallel-rustc.md - address review comment - make date-check more easy to use - update thir output (rust-lang/rustc-dev-guide#1445) - do not offer option to run code (rust-lang/rustc-dev-guide#1442) - fix quick-edit link (rust-lang/rustc-dev-guide#1441) - Document changes introduced by kind-less SessionDiagnostics - diagnostics: fix outdated use of string slugs (rust-lang/rustc-dev-guide#1436) - Add missing lifetime (rust-lang/rustc-dev-guide#1439) - more syntax fixes - fix incorrect #[note] syntax - Update slug style to use _ instead of - (rust-lang/rustc-dev-guide#1426) - remove incorrect info (rust-lang/rustc-dev-guide#1435) - fix lifetime name (rust-lang/rustc-dev-guide#1431) - Update the date reference around Git submodule bug (rust-lang/rustc-dev-guide#1430)
2022-08-31Rollup merge of #100927 - andrewpollack:fuchsia-docs-rustup, r=tmandryYuki Okushi-97/+426
Adding new Fuchsia rustup docs... reworking walkthrough Docs improvements: * Adding new `rustup` target add for Fuchsia targets * Reworking walkthrough to show directory building as it happens * Reworking walkthrough to use `hello_fuchsia_pkg/` directory cc. `@djkoloski`