about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2020-09-30Fix typoJoshua Nelson-1/+1
2020-09-30Rollup merge of #77348 - ehuss:update-books, r=ehussJonas Schievink-0/+0
Update books ## rust-by-example 5 commits in 19f0a0372af497b34369cf182d9d16156cab2969..7d3ff1c12db08a847a57a054be4a7951ce532d2d 2020-08-26 09:38:48 -0300 to 2020-09-28 15:54:25 -0300 - Prevent duplicated error information in "wrapping errors" example (rust-lang/rust-by-example#1375) - Avoid lifetime annotation in struct example (rust-lang/rust-by-example#1378) - Clone.md comment and variable name change (rust-lang/rust-by-example#1379) - Replace panic example with a simpler version (rust-lang/rust-by-example#1380) - Prefer `const` over `static` (rust-lang/rust-by-example#1381) ## embedded-book 1 commits in 0cd2ca116274b915924c3a7e07c1e046b6f19b77..dd310616308e01f6cf227f46347b744aa56b77d9 2020-08-19 10:33:15 +0000 to 2020-09-26 08:54:08 +0000 - Add instructions for ARM v8 instruction sets (rust-embedded/book#265)
2020-09-30Add more tests and check for ABIHugues de Valon-0/+6
Signed-off-by: Hugues de Valon <hugues.devalon@arm.com>
2020-09-30Add support for cmse_nonsecure_entry attributeHugues de Valon-0/+75
This patch adds support for the LLVM cmse_nonsecure_entry attribute. This is a target-dependent attribute that only has sense for the thumbv8m Rust targets. You can find more information about this attribute here: https://developer.arm.com/documentation/ecm0359818/latest/ Signed-off-by: Hugues de Valon <hugues.devalon@arm.com>
2020-09-30Incorporated suggestions into git page and edit for more brevity.Jakob Degen-47/+52
The Advanced Rebasing section has been mostly rewritten to include both a major suggestion from jyn and a general rewrite. Additional thanks to camelid for some suggestions!
2020-09-30Edit using git page for brevity and clarity.Jakob Degen-52/+36
The previous iteration of the page was often wordy and occasionally unclear. This has been cleaned up in places. Additionally, the TODO in the no-merge policy section has been removed and addressed.
2020-09-30Add a section on using git.Jakob Degen-0/+204
This section addresses the biggest issues that new contributors, especially those with limited familiarity with git, are likely to face. This is still a WIP. Thanks to jyn for the recommended improvements!
2020-09-29Update booksEric Huss-0/+0
2020-09-29--verbose is useful when not compiling and when compiling (#901)Santiago Pastorino-2/+2
2020-09-28Add unstable book docs for `-Zunsound-mir-opts`Wesley Wiser-0/+8
2020-09-28Update unstable-book: Fix ABNF in inline assembly docsJethro Beekman-1/+1
2020-09-27Rollup merge of #77249 - jyn514:private-links, r=ManishearthJonas Schievink-0/+40
Separate `private_intra_doc_links` and `broken_intra_doc_links` into separate lints This is not ideal because it means `deny(broken_intra_doc_links)` will no longer `deny(private_intra_doc_links)`. However, it can't be fixed with a new lint group, because `broken` is already in the `rustdoc` lint group; there would need to be a way to nest groups somehow. This also removes the early `return` so that the link will be generated even though it gives a warning. r? @Manishearth cc @ecstatic-morse (https://github.com/rust-lang/rust/pull/77242#issuecomment-699565095)
2020-09-27Rollup merge of #76839 - lzutao:mips-asm, r=AmanieuJonas Schievink-1/+16
Add asm! support for MIPS For now, I only add support for mips32. mips64 may come in future PRs if I could learn more about the target.
2020-09-27Add documentation for `private_intra_doc_links`Joshua Nelson-0/+40
2020-09-27Use implicit reference links for shorter linesfollower-4/+4
(As suggested by jyn514.)
2020-09-27Fix line length error.follower-3/+3
Reduced line length to <100 (as indicated by PR build error). (Also removed extra space character before link.)
2020-09-27Add links to documentation sources.follower-2/+5
Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them.
2020-09-27Add MIPS asm! supportLzu Tao-1/+16
This patch also: * Add soft-float supports: only f32 * zero-extend i8/i16 to i32 because MIPS only supports register-length arithmetic. * Update table in asm! chapter in unstable book.
2020-09-27Add docs for x.py setupJoshua Nelson-14/+21
2020-09-26Add link from "Writing Documentation" suggestionfollower-1/+2
A link to the relevant section of the contributing documentation makes it easier for contributors to locate the relevant information. (e.g. via an in-page search for "doc".) This is particularly important currently as https://github.com/rust-lang/rust/blob/85072e330394440776ace5ae612e3ced32ef6348/CONTRIBUTING.md links directly to the (currently `rustc`-focused) "Getting Started" guide rather than the general Rust contribution content to which it used to point.
2020-09-26correct output path in Writing DocumentationShahar Or (mightyiam)-1/+1
2020-09-25update link to 'BorrowKind' to be implicit in markdownYoungsuk_Kim-2/+2
2020-09-25add link to 'BorrowKind' in closure.mdYoungsuk_Kim-3/+4
2020-09-25update description of 'ByRef' borrows of closuresYoungsuk_Kim-3/+3
2020-09-25minor punctuation/grammar error fixYoungsuk_Kim-4/+4
2020-09-25Adds a GitHub Actions CI build for aarch64-pc-windows-msvc via ↵Arlo Siemsen-1/+1
cross-compilation on an x86_64 host. This promotes aarch64-pc-windows-msvc from a Tier 2 Compilation Target (std) to a Tier 2 Development Platform (std+rustc+cargo+tools). Fixes #72881
2020-09-25Remove note about missing ios/tvos targets in platform docs.Eric Huss-9/+8
I misunderstood how this works, and I have fixed the linux builds to support ios/tvos.
2020-09-24Remove reference to copyright notices.Jakob Degen-2/+1
Immediately below the section on copyright notices being removed, it is mentioned that a particular thing should be placed below the notices. This seems confusing.
2020-09-24Auto merge of #74430 - Manishearth:stabilize-intra-doc, r=Manishearthbors-61/+105
Stabilize intra-doc links Fixes https://github.com/rust-lang/rust/issues/43466 Thanks to the great work of `@jyn514` in getting the [cross-crate reexport issue](https://github.com/rust-lang/rust/issues/65983) in intra-rustdoc links fixed, I think we're now in a position to stabilize this feature. The tracking issue currently has two unresolved issues: - <s>behavior around doc(hidden): This is fixed in https://github.com/rust-lang/rust/pull/73365, which is just waiting for CI and should land tomorrow. It's also a pretty niche bug so while I expect it to land soon I don't think we need to block stabilization on it anyway.</s> - Non-identifier primitive types like slices: This was not a part of the original RFC anyway, and is a pretty niche use case The feature itself, sans https://github.com/rust-lang/rust/issues/65983, has been shipped on nightly for three years now, with people using it on docs.rs. https://github.com/rust-lang/rust/issues/65983 itself is not an overwhelmingly central bit of functionality; the reason we elected to block stabilization on it was that back in 2017 it was not possible to fix the issue without some major refactorings of resolve, and we did not want to stabilize something that had such a potentially unfixable bug. Given that we've fixed it, I see no reason to delay stabilization on this long awaited feature. It's possible that the latest patches have problems, however we _have_ done crater runs of some of the crucial parts. Furthermore, that's what the release trains are for, we will have a solid three months to let it ride the trains before it actually hits the stable compiler. r? `@rust-lang/rustdoc`
2020-09-23Link to the -Zmir-opt-level proposalDániel Buga-1/+14
I was confused about what the different levels mean. This PR adds a paragraph that shortly explains the rationale behind different mir-opt-levels and links to the current proposal where there's some information about them. Let me know if I wrote something unreasonable or incorrect. Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-23Don't recommend building the compiler for running tests on the standard ↵Joshua Nelson-3/+3
library (#887) Thought of this while reading https://internals.rust-lang.org/t/contributing-changes-to-std/12829/.
2020-09-22`ConstEvalResult` is now `EvalToConstValueResult` (#885)Camelid-2/+2
Also fixed typo.
2020-09-19Improve instructions for adding a new test (#881)Joshua Nelson-4/+14
* Improve instructions for adding a new test - Add a section for library tests - Expand section on rustdoc tests * Address review comments - Say what should be considered a library test - Mention adding error numbers to doc tests - Link to #ui section - Line wrapping * Fix incorrect link It shouldn't have been a link in the first place. Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com> Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-09-18Rename method to `assert_len`dylni-10/+10
2020-09-18Move `slice::check_range` to `RangeBounds`dylni-10/+10
2020-09-17Update src/doc/rustdoc/src/linking-to-items-by-name.mdManish Goregaokar-1/+1
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-17Fix typo in table of contentsCamelid-1/+1
2020-09-17Revert "Mention that places are sometimes called "lvalues""Camelid-2/+1
This reverts commit bf5e1c451de505fa453672c1168b09db07a145cb.
2020-09-17Mention that places are sometimes called "lvalues"Camelid-1/+2
2020-09-17More improvementsCamelid-5/+5
2020-09-17Improve MIR sections in appendixCamelid-27/+54
Add a new graphical representation of one of the examples of MIR and basic blocks! And make other minor improvements.
2020-09-16debug-logging=true instead of debug-assertions=yesMacdonald Umoren-2/+2
2020-09-16Auto merge of #76804 - tmandry:rollup-nwntt3q, r=tmandrybors-0/+0
Rollup of 16 pull requests Successful merges: - #75026 (Add array_windows fn) - #76642 (Do not lint ignored private doc tests) - #76719 (Change error message for ty param in const) - #76721 (Use intra-doc links in `core::mem`) - #76728 (Add a comment why `extern crate` is necessary for rustdoc) - #76735 (Remove unnecessary `clone()`s in bootstrap) - #76741 (Avoid printing dry run timings) - #76747 (Add missing code examples in libcore) - #76756 (fix a couple of stylistic clippy warnings) - #76758 ([fuchsia] Propagate the userspace UTC clock) - #76759 (Fix stabilization marker for future_readiness_fns) - #76760 (don't lazily evaluate some trivial values for Option::None replacements (clippy::unnecessary_lazy_evaluations)) - #76764 (Update books) - #76775 (Strip a single leading tab when rendering dataflow diffs) - #76778 (Simplify iter fuse struct doc) - #76794 (Make graphviz font configurable) Failed merges: r? `@ghost`
2020-09-16Rollup merge of #76764 - ehuss:update-books, r=ehussTyler Mandry-0/+0
Update books ## nomicon 1 commits in 25854752549d44d76fbd7650e17cb4f167a0b8fb..6e57e64501f61873ab80cb78a07180a22751a5d6 2020-08-19 16:41:48 -0400 to 2020-09-14 11:40:23 -0400 - Fix API change to alloc::Global::grow. (rust-lang-nursery/nomicon#236) ## reference 3 commits in 25391dba46262f882fa846beefaff54a966a8fa5..56a13c082ee90736c08d6abdcd90462517b703d3 2020-09-02 07:22:55 -0700 to 2020-09-14 23:20:16 -0700 - Update the description of staticlib (rust-lang-nursery/reference#884) - Rust 1.46 now allows more features in const fn (rust-lang-nursery/reference#883) - Document the enum changes in RFC 2195 (rust-lang-nursery/reference#879) ## book 1 commits in e5ed97128302d5fa45dbac0e64426bc7649a558c..cb28dee95e5e50b793e6ba9291c5d1568d3ad72e 2020-08-31 12:53:40 -0500 to 2020-09-09 10:06:00 -0500 - Fixed the error message of invalid array element access in ch03.2 (rust-lang/book#2446)
2020-09-16Auto merge of #76420 - Gelbpunkt:aarch64-linux-musl, r=pietroalbinibors-1/+1
Add aarch64-unknown-linux-musl host builds This adds aarch64-unknown-linux-musl to the hosts list and adds the build to the dist-arm-linux builder as `@Mark-Simulacrum` suggested to me in Zulip. `@jyn514` requested to be mentioned :smile: I had to update the config for crosstool-ng as it had a prompt about the glibc version. I ran `src/ci/docker/run.sh dist-arm-linux` to test it. ``` Build completed successfully in 1:31:50 Compile requests 8180 Compile requests executed 8135 Cache hits 287 Cache misses 7848 Cache timeouts 0 Cache read errors 0 Forced recaches 0 Cache write errors 0 Compilation failures 0 Cache errors 0 Non-cacheable compilations 0 Non-cacheable calls 36 Non-compilation calls 9 Unsupported compiler calls 0 Average cache write 0.000 s Average cache read miss 6.389 s Average cache read hit 0.000 s Cache location Local disk: "/sccache" Cache size 202 MiB Max cache size 10 GiB == clock drift check == local time: Sun Sep 6 19:30:17 UTC 2020 network time: Sun, 06 Sep 2020 19:30:17 GMT == end clock drift check == ``` Only errors were in miri due to struct fields being private (already been reported [here](https://github.com/rust-lang/rust/issues/76337)) Edit: Maybe it is helpful if I add that it is a working compiler ```sh /rust-nightly-aarch64-unknown-linux-musl # ash install.sh install: creating uninstall script at /usr/local/lib/rustlib/uninstall.sh install: installing component 'rustc' install: installing component 'cargo' install: installing component 'rls-preview' install: installing component 'rust-analyzer-preview' install: installing component 'clippy-preview' install: installing component 'rustfmt-preview' install: installing component 'llvm-tools-preview' install: installing component 'rust-analysis-aarch64-unknown-linux-musl' install: installing component 'rust-std-aarch64-unknown-linux-musl' install: WARNING: failed to run ldconfig. this may happen when not installing as root. run with --verbose to see the error Rust is ready to roll. / # cat test.rs fn main() { println!("hello world"); } / # rustc test.rs / # ./test hello world # file test test: ELF 64-bit LSB executable, ARM aarch64, version 1 (SYSV), statically linked, not stripped ```
2020-09-16Rollup merge of #76675 - lzutao:asm_doc, r=AmanieuDylan DPC-3/+22
Small improvements to asm documentation Save people from searching and reading tons of comments in tracking issues.
2020-09-16Add link for `AnalysisDomain::NAME`Dylan MacKenzie-1/+2
2020-09-16Describe how to generate graphviz diagrams for dataflowDylan MacKenzie-0/+20
2020-09-16document how to use memory addresses as operandsLzu Tao-0/+19
Co-authored-by: Amanieu <amanieu@gmail.com>
2020-09-15Remove EN1Santiago Pastorino-4/+2
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-02-28 04:48:26 +0000