about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2020-10-29Rollup merge of #78492 - ehuss:update-books, r=ehussYuki Okushi-0/+0
Update books ## nomicon 7 commits in 6e57e64501f61873ab80cb78a07180a22751a5d6..69333eddb1de92fd17e272ce4677cc983d3bd71d 2020-09-14 11:40:23 -0400 to 2020-10-17 15:44:12 -0700 - Tweak GHA config (rust-lang-nursery/nomicon#240) - Fix link for `[T]` (rust-lang-nursery/nomicon#239) - Update casts.md (rust-lang-nursery/nomicon#232) - [WIP] Add more links (rust-lang-nursery/nomicon#180) - Data Race definition should be more precise (rust-lang-nursery/nomicon#219) - Update the diagnostic of `error[E0597]` in dropck.md (rust-lang-nursery/nomicon#157) - fix typo in Lifetimes mutable reference aliasing section (rust-lang-nursery/nomicon#225) ## reference 3 commits in 1b78182e71709169dc0f1c3acdc4541b6860e1c4..10c16caebe475d0d11bec0531b95d7697856c13c 2020-10-11 13:53:47 -0700 to 2020-10-25 20:51:26 -0700 - Add `unsafe` for `mod` and `extern`. (rust-lang-nursery/reference#898) - mention how unions interact with dropping (rust-lang-nursery/reference#897) - Add `move_ref_pattern` docs (rust-lang-nursery/reference#881) ## book 2 commits in 451a1e30f2dd137aa04e142414eafb8d05f87f84..13e1c05420bca86ecc79e4ba5b6d02de9bd53c62 2020-10-05 09:11:18 -0500 to 2020-10-20 14:57:32 -0500 - Referencing to Appendix B (rust-lang/book#2481) - Use GITHUB_PATH instead of add-path (rust-lang/book#2477) ## rust-by-example 2 commits in 152475937a8d8a1f508d8eeb57db79139bc803d9..99eafee0cb14e6ec641bf02a69d7b30f6058349a 2020-10-09 09:29:50 -0300 to 2020-10-21 14:21:55 -0300 - Formatting footer items. (rust-lang/rust-by-example#1385) - Add partial moves example for `move_ref_pattern` stabilization (rust-lang/rust-by-example#1377) ## edition-guide 3 commits in 81f16863014de60b53de401d71ff904d163ee030..7bc9b7a5e800f79df62947cb7d566fd2fbaf19fe 2020-08-27 13:56:31 -0700 to 2020-10-23 18:31:23 -0500 - A few small updates. (rust-lang/edition-guide#221) - Clarify the limitation of ? in main and tests (rust-lang/edition-guide#219) - Update deprecated GitHub Actions commands. (rust-lang/edition-guide#220)
2020-10-28Update booksEric Huss-0/+0
2020-10-28Fix typo "compiltest"Guillaume Gomez-1/+1
2020-10-27Fix unstable-book doc testsSantiago Pastorino-3/+4
2020-10-25Rollup merge of #78320 - phil-opp:patch-5, r=GuillaumeGomez,alexcrichtonYuki Okushi-1/+1
Link to cargo's `build-std` feature instead of `xargo` in custom target docs The `xargo` tool is in maintenance mode since 2018 and the `build-std` feature of cargo already works reasonably well for most use cases.
2020-10-24Link directly to `#build-std` anchorPhilipp Oppermann-1/+1
Co-authored-by: Jonas Schievink <jonasschievink@gmail.com>
2020-10-24Link to cargo's `build-std` feature instead of `xargo` in custom target docsPhilipp Oppermann-1/+1
The `xargo` tool is in maintenance mode since 2018 and the `build-std` feature of cargo already works reasonably well for most use cases.
2020-10-24Rollup merge of #78250 - camelid:document-inline-const, r=spastorinoJonas Schievink-0/+45
Document inline-const Part of #76001. r? @spastorino
2020-10-22Document inline-const in the Unstable BookCamelid-0/+45
2020-10-21Clean up and improve some docsCamelid-13/+15
* compiler docs * Don't format list as part of a code block * Clean up some other formatting * rustdoc book * Update CommonMark spec version to latest (0.28 -> 0.29) * Clean up some various wording and formatting
2020-10-18Auto merge of #76885 - dylni:move-slice-check-range-to-range-bounds, r=KodrAusbors-10/+10
Move `slice::check_range` to `RangeBounds` Since this method doesn't take a slice anymore (#76662), it makes more sense to define it on `RangeBounds`. Questions: - Should the new method be `assert_len` or `assert_length`?
2020-10-15Update submodules for link fixesJoshua Nelson-0/+0
- [rust-embedded](https://github.com/rust-embedded/book/compare/79ab7776929c66db83203397958fa7037d5d9a30...ca8169e69b479f615855d0eece7e318138fcfc00) - [cargo](https://github.com/rust-lang/cargo/compare/12db56cdedbc2c26a9aa18f994c0188cdcc67df5...79b397d72c557eb6444a2ba0dc00a211a226a35a)
2020-10-15Deny broken intra-doc links in linkcheckerJoshua Nelson-0/+2
Since rustdoc isn't warning about these links, check for them manually.
2020-10-15Rollup merge of #77951 - ehuss:update-books, r=ehussYuki Okushi-0/+0
Update books ## reference 5 commits in 56a13c082ee90736c08d6abdcd90462517b703d3..1b78182e71709169dc0f1c3acdc4541b6860e1c4 2020-09-14 23:20:16 -0700 to 2020-10-11 13:53:47 -0700 - Specify that SSE4.1 includes SSSE3 instead of SSE3 (rust-lang-nursery/reference#892) - Fix mutable expressions that can be dereferenced (rust-lang-nursery/reference#890) - Fix grammar in memory model (rust-lang-nursery/reference#889) - Add style checks. (rust-lang-nursery/reference#886) - Add description for LUB Coercion (rust-lang-nursery/reference#808) ## book 1 commits in cb28dee95e5e50b793e6ba9291c5d1568d3ad72e..451a1e30f2dd137aa04e142414eafb8d05f87f84 2020-09-09 10:06:00 -0500 to 2020-10-05 09:11:18 -0500 - clarify description of when ? can be used (rust-lang/book#2471) ## rust-by-example 1 commits in 7d3ff1c12db08a847a57a054be4a7951ce532d2d..152475937a8d8a1f508d8eeb57db79139bc803d9 2020-09-28 15:54:25 -0300 to 2020-10-09 09:29:50 -0300 - Add 1.45.0 cast documentation (rust-lang/rust-by-example#1384) ## embedded-book 2 commits in dd310616308e01f6cf227f46347b744aa56b77d9..79ab7776929c66db83203397958fa7037d5d9a30 2020-09-26 08:54:08 +0000 to 2020-10-12 08:00:05 +0000 - llvm-objdump: Use two hyphens in flags to objdump (rust-embedded/book#270) - Start/hardware: clarify which file needs tweaking (rust-embedded/book#266)
2020-10-14Update booksEric Huss-0/+0
2020-10-14Update codegen-backend.mdXAMPPRocky-0/+3
2020-10-14Update codegen-backend.mdXAMPPRocky-2/+2
2020-10-14Update src/doc/unstable-book/src/compiler-flags/codegen-backend.mdXAMPPRocky-1/+1
2020-10-14Document -Z codegen-backend in the unstable bookErin Power-0/+28
2020-10-14Rollup merge of #77239 - shepmaster:silicon-ci-plus, r=pietroalbiniYuki Okushi-1/+1
Enable building Cargo for aarch64-apple-darwin r? @ghost
2020-10-13aarch64-apple-darwin now includes CargoJake Goulding-1/+1
2020-10-13Auto merge of #76830 - Artoria2e5:tune, r=nagisabors-2/+18
Pass tune-cpu to LLVM I think this is how it should work... See https://internals.rust-lang.org/t/expose-tune-cpu-from-llvm/13088 for the background. Or the documentation diff.
2020-10-12Auto merge of #75914 - arlosi:aarch64-ci, r=pietroalbinibors-1/+1
Promote aarch64-pc-windows-msvc to Tier 2 Development Platform Adds a GitHub Actions CI build for `aarch64-pc-windows-msvc` via 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 r? `@pietroalbini`
2020-10-11Auto merge of #75991 - shepmaster:silicon-ci, r=pietroalbinibors-3/+3
Set up CI for aarch64-apple-darwin
2020-10-10Auto merge of #76934 - camelid:rustdoc-allow-generic-params, r=jyn514bors-13/+42
Allow generic parameters in intra-doc links Fixes #62834. --- The contents of the generics will be mostly ignored (except for warning if fully-qualified syntax is used, which is currently unsupported in intra-doc links - see issue #74563). * Allow links like `Vec<T>`, `Result<T, E>`, and `Option<Box<T>>` * Allow links like `Vec::<T>::new()` * Warn on * Unbalanced angle brackets (e.g. `Vec<T` or `Vec<T>>`) * Missing type to apply generics to (`<T>` or `<Box<T>>`) * Use of fully-qualified syntax (`<Vec as IntoIterator>::into_iter`) * Invalid path separator (`Vec:<T>:new`) * Too many angle brackets (`Vec<<T>>`) * Empty angle brackets (`Vec<>`) Note that this implementation *does* allow some constructs that aren't valid in the actual Rust syntax, for example `Box::<T>new()`. That may not be supported in rustdoc in the future; it is an implementation detail.
2020-10-10Auto merge of #77337 - lzutao:asm-mips64, r=Amanieubors-14/+13
Add asm! support for mips64 - [x] Updated `src/doc/unstable-book/src/library-features/asm.md`. - [ ] No vector type support. I don't know much about those types. cc #76839
2020-10-09Link to GitHub issue re macro resolutionCamelid-1/+3
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-08Update rustdoc intra-doc link docsCamelid-13/+40
* Describe generic parameters feature * Make general improvements to the docs
2020-10-07Auto merge of #77119 - GuillaumeGomez:unclosed-html-tag-lint, r=jyn514bors-0/+35
Unclosed html tag lint Part of #67799. I think `@ollie27` will be interested (`@Manishearth` too since they opened the issue ;) ). r? `@jyn514`
2020-10-06Rollup merge of #76855 - jyn514:platform-specific, r=ollie27Yuki Okushi-21/+50
Revamp rustdoc docs about documentation using `cfg` - Move `cfg(doc)` out of `unstable-features`. It's not unstable. - Remove outdated reference to `everybody_loops`. - Improve wording in various places - Give an example of code this allows (and does not allow) - Link to `cfg(doc)` in `doc(cfg)` documentation. Since one is stable and the other is not, don't combine them. - Cleanup wording for `doc(cfg)` - Incorporate changes from #76849 - Mention that `doc(cfg)` is also for features Addresses https://github.com/rust-lang/rust/pull/76849#issuecomment-694516199. Obsoletes https://github.com/rust-lang/rust/pull/76849 (I made sure to fix the weird dashes too). r? @steveklabnik
2020-10-05Revamp rustdoc docs about documentation using `cfg`Joshua Nelson-21/+50
- Move `cfg(doc)` out of `unstable-features`. It's not unstable. - Remove outdated reference to `everybody_loops`. - Improve wording in various places - Give an example of code this allows (and does not allow) - Link to `cfg(doc)` in `doc(cfg)` documentation. Since one is stable and the other is not, don't combine them. - Cleanup wording for `doc(cfg)` - Incorporate changes from #76849 - Mention that `doc(cfg)` is also for features
2020-10-05Pass tune-cpu to LLVMMingye Wang-2/+18
I think this is how it should work...
2020-10-04Removes reg aliases since there are many ABIs: o32/n32/n64Lzu Tao-3/+0
2020-10-04Add asm! support for mips64Lzu Tao-10/+12
2020-10-04mips32: Add f64 hard-float supportLzu Tao-1/+1
co-authored-by: Amanieu <amanieu@gmail.com>
2020-10-03Make invalid_html_tags lint only run on nightly and being allowed by defaultGuillaume Gomez-2/+4
2020-10-03Add doc for invalid_html_tag lintGuillaume Gomez-0/+33
2020-10-02Rollup merge of #76811 - GuillaumeGomez:doc-alias-name-restriction, ↵Jonas Schievink-0/+2
r=oli-obk,ollie27 Doc alias name restriction Fixes #76705.
2020-10-02Update doc alias documentationGuillaume Gomez-0/+2
2020-10-01Move aarch64-apple-darwin to tier 2Jake Goulding-3/+3
Drive-by fixes to update the naming of "OSX" [sic] to "macOS".
2020-10-01Rollup merge of #77202 - ehuss:defer-apple-sdkroot, r=petrochenkovDylan DPC-9/+8
Defer Apple SDKROOT detection to link time. This defers the detection of the SDKROOT for Apple iOS/tvOS targets to link time, instead of when the `Target` is defined. This allows commands that don't need to link to work (like `rustdoc` or `rustc --print=target-list`). This also makes `--print=target-list` a bit faster. This also removes the note in the platform support documentation about these targets being missing. When I wrote it, I misunderstood how the SDKROOT stuff worked. Notes: * This means that JSON spec targets can't explicitly override these flags. I think that is probably fine, as I believe the value is generally required, and can be set with the SDKROOT environment variable. * This changes `x86_64-apple-tvos` to use `appletvsimulator`. I think the original code was wrong (it was using `iphonesimulator`). Also, `x86_64-apple-tvos` seems broken in general, and I cannot build it locally. The `data_layout` does not appear to be correct (it is a copy of the arm64 layout instead of the x86_64 layout). I have not tried building Apple's LLVM to see if that helps, but I suspect it is just wrong (I'm uncertain since I don't know how the tvOS simulator works with its bitcode-only requirements). * I'm tempted to remove the use of `Result` for built-in target definitions, since I don't think they should be fallible. This was added in https://github.com/rust-lang/rust/pull/34980, but that only relates to JSON definitions. I think the built-in targets shouldn't fail. I can do this now, or not. Fixes #36156 Fixes #76584
2020-09-30Auto merge of #77372 - jonas-schievink:rollup-e5bdzga, r=jonas-schievinkbors-0/+8
Rollup of 12 pull requests Successful merges: - #77037 (more tiny clippy cleanups) - #77233 (BTreeMap: keep an eye out on the size of the main components) - #77280 (Ensure that all LLVM components requested by tests are available on CI) - #77284 (library: Forward compiler-builtins "mem" feature) - #77296 (liveness: Use Option::None to represent absent live nodes) - #77322 (Add unstable book docs for `-Zunsound-mir-opts`) - #77328 (Use `rtassert!` instead of `assert!` from the child process after fork() in std::sys::unix::process::Command::spawn()) - #77331 (Add test for async/await combined with const-generics.) - #77338 (Fix typo in alloc vec comment) - #77340 (Alloc vec use imported path) - #77345 (Add test for issue #74761) - #77348 (Update books) Failed merges: r? `@ghost`
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-29Update booksEric Huss-0/+0
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.