about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2018-02-28Rollup merge of #48359 - jsgf:remap-path-prefix, r=sanxiynManish Goregaokar-37/+10
Fixes #47311. r? @nrc
2018-02-25Rollup merge of #48166 - ↵kennytm-77/+0
hedgehog1024:hedgehog1024-stabilize-entry_and_modify, r=alexcrichton Stabilize 'entry_and_modify' feature Stabilize `entry_and_modify` feature introduced by #44734. Closes #44733
2018-02-22Implement --remap-path-prefixJeremy Fitzhardinge-37/+10
Remove experimental -Zremap-path-prefix-from/to, and replace it with the stabilized --remap-path-prefix=from=to variant. This is an implementation for issue of #41555.
2018-02-21Update the book to promote second editionsteveklabnik-0/+0
This updates the book repository, but mostly to include https://github.com/rust-lang/book/pull/1180 TL;DR: the second edition is close enough to done that we should universally recommend it over the first edition.
2018-02-17Fix unstable bookGuillaume Gomez-0/+3
2018-02-17Update to last repository versionGuillaume Gomez-0/+0
2018-02-12Delete information about 'entry_and_modify' from Unstable bookhedgehog1024-77/+0
2018-02-11Auto merge of #47752 - mark-i-m:at-most-once-rep, r=nikomatsakisbors-0/+17
Implement `?` macro repetition See rust-lang/rfcs#2298 (with disposition merge)
2018-02-09Update books for next releaseMark Simulacrum-0/+0
2018-02-06Rollup merge of #47948 - pietroalbini:use-nested-groups-stabilize, ↵kennytm-90/+0
r=petrochenkov Stabilize use_nested_groups As requested in #44494. Documentation PRs already sent.
2018-02-06Rollup merge of #47753 - steveklabnik:update-book, r=alexcrichtonkennytm-0/+0
Update book This PR does two things: 1. update the book to include https://github.com/rust-lang/book/pull/1088 2. update to mdbook 0.1 Both of these things are big changes, so I want to land them now, well before the next branch, so we can kick the tires. ------------------------------ Locally, I'm seeing some weirdness around the reference and this: ![image](https://user-images.githubusercontent.com/27786/35411917-8dcbb31a-01e8-11e8-8c30-0bd280d93b9d.png) Putting this PR up so others can try and build and see if it reproduces for them.
2018-02-05Stabilize use_nested_groupsPietro Albini-90/+0
2018-02-04update referencesteveklabnik-0/+0
2018-02-04update trplsteveklabnik-0/+0
Includes https://github.com/rust-lang/book/pull/1088 and https://github.com/rust-lang/book/commit/62210e326c27697e94ce429c1683dcea4e4887e4
2018-02-04Rollup merge of #47947 - goodmanjonathan:stabilize_match_beginning_vert, ↵kennytm-23/+0
r=petrochenkov Stabilize feature(match_beginning_vert) With this feature stabilized, match expressions can optionally have a `|` at the beginning of each arm. Reference PR: rust-lang-nursery/reference#231 Closes #44101
2018-02-01Fix lang items box example codeVolker Mische-13/+8
The `exchange_free` lang item is gone in favour of `box_free` [1]. Some warnings are also fixed by this commit. [1]: https://github.com/rust-lang/rust/commit/ca115dd083a1fe1d2b4892c5e50e49eb83ff1f3
2018-01-30stabilize match_beginning_vertJonathan Goodman-23/+0
2018-01-30Add ? to unstable bookMark Mansi-0/+17
2018-01-30Rollup merge of #47515 - jimmantooth:patch-1, r=QuietMisdreavuskennytm-3/+3
Punctuation and clarity fixes.
2018-01-24fix for documentation error issue 47716evelynmitchell-1/+1
2018-01-22Auto merge of #47158 - rkruppe:repr-transparent, r=eddybbors-0/+176
Implement repr(transparent) r? @eddyb for the functional changes. The bulk of the PR is error messages and docs, might be good to have a doc person look over those. cc #43036 cc @nox
2018-01-20Rollup merge of #47508 - QuietMisdreavus:rbe-bookshelf, r=steveklabnikGuillaume Gomez-0/+2
add Rust By Example to the bookshelf cc #46194 With #46196 freshly merged, we should add a link to the main docs distribution so people can find it! We discussed this at the docs team meeting today and decided to go ahead with adding it to the bookshelf.
2018-01-20Mark Unique as perma-unstable, with the feature renamed to ptr_internals.Simon Sapin-0/+0
2018-01-17Punctuation and clarity fixes.James Mantooth-3/+3
2018-01-16add Rust By Example to the bookshelfQuietMisdreavus-0/+2
2018-01-16Implement repr(transparent)Robin Kruppe-0/+176
2018-01-15Reexport -> re-export in documentation section headingsCarol (Nichols || Goulding)-3/+3
2018-01-15Rollup merge of #47414 - est31:master, r=alexcrichtonkennytm-0/+0
Enforce dashes in the unstable book file names Also rename the existing underscore using files to use dashes. Fixes #47394.
2018-01-13Adding RBE as a submodule #46194projektir-0/+0
2018-01-13Enforce dashes in the unstable book file namesest31-0/+0
Also rename the existing underscore using files to use dashes. Fixes #47394.
2018-01-09Rollup merge of #47301 - GuillaumeGomez:fix-error-index-display, ↵Corey Farwell-223/+266
r=QuietMisdreavus Fix error index display Fixes #47284. r? @QuietMisdreavus
2018-01-09Fix error index displayGuillaume Gomez-223/+266
2018-01-03Add docs for `crate_in_paths`, `extern_in_paths` and `extern_absolute_paths` ↵Vadim Petrochenkov-0/+137
into the unstable book
2018-01-03Rollup merge of #47117 - tinaun:no_more_dups, r=frewsxcvkennytm-7/+0
[unstable book] remove duplicate entries if a unstable feature is a language feature, it shouldn't also have a library feature stub generated
2018-01-01Auto merge of #46895 - ricochet1k:macro-lifetimes, r=jseyfriedbors-0/+14
Allow lifetimes in macros This is a resurrection of PR #41927 which was a resurrection of #33135, which is intended to fix #34303. In short, this allows macros_rules! to use :lifetime as a matcher to match 'lifetimes. Still to do: - [x] Feature gate
2017-12-30update books for next releasesteveklabnik-0/+0
2017-12-28Add an entry in the unstable bookMatt Peterson-0/+14
2017-12-07fix markdown file differencesGuillaume Gomez-7/+7
2017-12-04template month/year, version into man pages while building dist tarballZack M. Davis-2/+2
This is meant to resolve #25689.
2017-12-03Fix invalid link to lint_plugin_test.rsKenjiro Nakayama-1/+1
2017-11-30Implement RFC 2128 (use_nested_groups)Pietro Albini-0/+90
This commit adds support for nested groups inside `use` declarations, such as `use foo::{bar, sub::{baz::Foo, *}};`.
2017-11-28Rollup merge of #46174 - stjepang:stabilize-spinloophint, r=sfacklerkennytm-41/+0
Stabilize spin_loop_hint Stabilize `spin_loop_hint` in release `1.23.0`. I've also renamed feature `hint_core_should_pause` to `spin_loop_hint`. cc #41196
2017-11-22Remove spin-loop-hint from the unstable bookStjepan Glavina-41/+0
2017-11-22Auto merge of #44781 - QuietMisdreavus:doc-include, r=GuillaumeGomezbors-0/+40
rustdoc: include external files in documentation (RFC 1990) Part of https://github.com/rust-lang/rfcs/pull/1990 (needs work on the error reporting, which i'm deferring to after this initial PR) cc #44732 Also fixes #42760, because the prep work for the error reporting made it easy to fix that at the same time.
2017-11-22Stabilize spin_loop_hintStjepan Glavina-4/+4
2017-11-21allow loading external files in documentationQuietMisdreavus-0/+40
Partial implementation of https://github.com/rust-lang/rfcs/pull/1990 (needs error reporting work) cc #44732
2017-11-21fix some typosMartin Lindhe-5/+5
2017-11-21Auto merge of #45039 - QuietMisdreavus:doc-spotlight, ↵bors-0/+30
r=GuillaumeGomez,QuietMisdreavus show in docs whether the return type of a function impls Iterator/Read/Write Closes #25928 This PR makes it so that when rustdoc documents a function, it checks the return type to see whether it implements a handful of specific traits. If so, it will print the impl and any associated types. Rather than doing this via a whitelist within rustdoc, i chose to do this by a new `#[doc]` attribute parameter, so things like `Future` could tap into this if desired. ### Known shortcomings ~~The printing of impls currently uses the `where` class over the whole thing to shrink the font size relative to the function definition itself. Naturally, when the impl has a where clause of its own, it gets shrunken even further:~~ (This is no longer a problem because the design changed and rendered this concern moot.) The lookup currently just looks at the top-level type, not looking inside things like Result or Option, which renders the spotlights on Read/Write a little less useful: <details><summary>`File::{open, create}` don't have spotlight info (pic of old design)</summary> ![image](https://user-images.githubusercontent.com/5217170/31209495-e59d027e-a950-11e7-9998-ceefceb71c07.png) </details> All three of the initially spotlighted traits are generically implemented on `&mut` references. Rustdoc currently treats a `&mut T` reference-to-a-generic as an impl on the reference primitive itself. `&mut Self` counts as a generic in the eyes of rustdoc. All this combines to create this lovely scene on `Iterator::by_ref`: <details><summary>`Iterator::by_ref` spotlights Iterator, Read, and Write (pic of old design)</summary> ![image](https://user-images.githubusercontent.com/5217170/31209554-50b271ca-a951-11e7-928b-4f83416c8681.png) </details>
2017-11-20Update books for next releasesteveklabnik-0/+0
Also includes a fix in std::ops
2017-11-18Rollup merge of #45767 - QuietMisdreavus:who-docs-the-doc-tool, r=frewsxcvGuillaume Gomez-6/+28
rustdoc book: talk about #![doc(test(no_crate_inject))] and #![doc(test(attr(...)))] While investigating https://github.com/rust-lang/rust/issues/45750 i noticed that `#![doc(test(attr(...)))]` wasn't documented at all. Since this is useful for making your examples follow the same coding guidelines as your code, i wanted to add it to the Rustdoc Book. I also added `#![doc(test(no_crate_inject))]` since it's used in the same place and might be useful for macro-heavy crates. I added mentions for these to "The `doc` attribute" as well as "Documentation tests" since it's useful information in both places. Technically the step reordering in the second commit is gated on https://github.com/rust-lang/rust/pull/45764, since before that lands attributes from the doctest come before the ones from `#![doc(test(attr(...)))]`.