summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2016-03-01Auto merge of #31713 - alexcrichton:rustbuild-docs, r=brsonbors-1/+3
This commit implements documentation generation of the nomicon, the book, the style guide, and the standalone docs. New steps were added for each one as well as appropriate makefile targets for each one as well.
2016-02-29std: Stabilize APIs for the 1.8 releaseAlex Crichton-3/+0
This commit is the result of the FCPs ending for the 1.8 release cycle for both the libs and the lang suteams. The full list of changes are: Stabilized * `braced_empty_structs` * `augmented_assignments` * `str::encode_utf16` - renamed from `utf16_units` * `str::EncodeUtf16` - renamed from `Utf16Units` * `Ref::map` * `RefMut::map` * `ptr::drop_in_place` * `time::Instant` * `time::SystemTime` * `{Instant,SystemTime}::now` * `{Instant,SystemTime}::duration_since` - renamed from `duration_from_earlier` * `{Instant,SystemTime}::elapsed` * Various `Add`/`Sub` impls for `Time` and `SystemTime` * `SystemTimeError` * `SystemTimeError::duration` * Various impls for `SystemTimeError` * `UNIX_EPOCH` * `ops::{Add,Sub,Mul,Div,Rem,BitAnd,BitOr,BitXor,Shl,Shr}Assign` Deprecated * Scoped TLS (the `scoped_thread_local!` macro) * `Ref::filter_map` * `RefMut::filter_map` * `RwLockReadGuard::map` * `RwLockWriteGuard::map` * `Condvar::wait_timeout_with` Closes #27714 Closes #27715 Closes #27746 Closes #27748 Closes #27908 Closes #29866
2016-02-29Auto merge of #31958 - teoryn:patch-3, r=nagisabors-1/+1
2016-02-29Auto merge of #31960 - aidanhs:aphs-tweak-aliasing-docs, r=Manishearthbors-1/+1
See https://doc.rust-lang.org/book/unsafe.html#what-does-safe-mean for the book version of these points which already contain the T.
2016-02-29Add the 'T' present in the rust bookAidan Hobson Sayers-1/+1
2016-02-28Fix typo (an Result)Kevin Stock-1/+1
2016-02-28Fix typo (!#[no_std])Kevin Stock-1/+1
2016-02-27Auto merge of #31931 - Luke-Nukem:master, r=steveklabnikbors-9/+9
Refinement of paragraph referenced by [this issue](https://github.com/rust-lang/rust/issues/31927). The paragraph in question had been adjusted already, but I've made some further clarifications which should help with readability and not leave the reader any `dangling pointers`.
2016-02-27Resolve ambiguous documentationKevin Stock-4/+4
See http://www.ietf.org/rfc/rfc2119.txt
2016-02-27Rollup merge of #31909 - benaryorg:patch-2, r=ManishearthManish Goregaokar-1/+1
`continue` expression's description mentioned `break` instead of `continue`
2016-02-27Refinement of paragraph referenced by [thisLuke Jones-9/+9
issue](https://github.com/rust-lang/rust/issues/31927)
2016-02-26Rollup merge of #31883 - birkenfeld:doc-null-escape, r=blussManish Goregaokar-0/+4
It appears in the examples, but is not covered by any of the cases in the prose description.
2016-02-26documentation fixKatze-1/+1
`continue` expression's description mentioned `break` instead of `continue` Signed-off-by: benaryorg <binary@benary.org>
2016-02-25Rollup merge of #31827 - teoryn:patch-1, r=brsonManish Goregaokar-1/+1
2016-02-25Document the null-char/null-byte escape in the referenceGeorg Brandl-0/+4
It appears in the examples, but is not covered by any of the cases in the prose description.
2016-02-25Rollup merge of #31870 - ivan:filter-explain, r=steveklabnikManish Goregaokar-4/+6
As a Rust newbie, I found the book's explanation for why the `filter` closure gets a reference very confusing, and tried to figure out why `filter` is somehow less consumptive than `map` -- but it isn't; that's controlled by `iter`/`into_iter`. I flailed around for a while until @habnabit explained it to me, and in retrospect it is quite obvious :-)
2016-02-25Rollup merge of #31868 - fhahn:capitalize-Rust, r=steveklabnikManish Goregaokar-3/+3
2016-02-25Rollup merge of #31863 - matklad:clarify-reference, r=steveklabnikManish Goregaokar-2/+2
Reference implied that use declarations may appear *only* at the top of blocks and modules, but it is not the case, and the following is valid: ```Rust fn foo() { let x = 92; use baz::bar; } ``` r? @steveklabnik
2016-02-25Rollup merge of #31677 - ivan:doc-vtable, r=steveklabnikManish Goregaokar-2/+3
I sure hope this fix is right cc @steveklabnik
2016-02-24book: Explain better why the filter closure gets a referenceIvan Kozik-4/+6
2016-02-24Capitalize some occurences of Rust in documentationFlorian Hahn-3/+3
2016-02-24reference: clarify use declaration locationAleksey Kladov-2/+2
2016-02-22Fix warn(unused_mut) in exampleKevin Stock-1/+1
2016-02-20Fix number of lines and methods in guessing gameChad Shaffer-2/+2
2016-02-18reference: vtable entries: copy @nikomatsakis's wordingIvan Kozik-2/+3
2016-02-17Rollup merge of #31565 - SDX2000:docfixes4, r=steveklabnikSteve Klabnik-9/+53
See title and diff for more information.
2016-02-17Made v2 mutable so that we can actually truncate it.Sandeep Datta-2/+2
2016-02-16rustbuild: Add rustbook/standalone doc supportAlex Crichton-1/+3
This commit implements documentation generation of the nomicon, the book, the style guide, and the standalone docs. New steps were added for each one as well as appropriate makefile targets for each one as well.
2016-02-16Clarify contiguous memory array structure of vectors in documentationDirk Gadsden-2/+9
Closes #31554. Contributes to #29380.
2016-02-15reference: vtable entries are resolved at runtimeIvan Kozik-1/+1
2016-02-14Rollup merge of #31658 - felgru:master, r=steveklabnikSteve Klabnik-1/+1
In the Rust code above this block of compiler output, the function is called print_sum, so use the same function name in the error message.
2016-02-14doc: fix compiler outputFelix Gruber-1/+1
In the Rust code above, the function is called print_sum, so use the same function name in the error message.
2016-02-14doc: Remove trailing whitespacefbergr-1/+1
2016-02-14Rollup merge of #31638 - rkruppe:rm-tex, r=alexcrichtonManish Goregaokar-2/+0
This file is unused since #27789
2016-02-14Rollup merge of #31612 - raindev:grammar, r=steveklabnikManish Goregaokar-1/+1
I feel sorry for bothering you with such a literally one character changes. If it is counter productive feel free to point it out in the comments, that would be totally understandable. I could try to pack such a changes together in one PR to make them less distractive. r? @steveklabnik
2016-02-14Rollup merge of #31610 - Manishearth:doc-clarify-txrx, r=steveklabnikManish Goregaokar-0/+2
Not everyone knows this convention. We could just rename the variables in the example, but since this notation is commonly used it's a good opportunity to introduce it. r? @steveklabnik
2016-02-14Rollup merge of #31563 - SDX2000:docfixes1, r=steveklabnikManish Goregaokar-4/+6
This is a minor change. Please see title. IMO this is important since this is the first instance when we talk about allocating a vector. Not saying that it is allocated on the stack here leaves room for speculation and this might put off some people (they might not even read the later sections which go into more detail about this).
2016-02-13Remove the last remaining .tex fileRobin Kruppe-2/+0
2016-02-13Fixed build error as per steveklabnik's suggestion and expanded on the ills ↵Sandeep Datta-1/+5
of doing out of bounds accesses.
2016-02-12Remove unnecessary articleAndrew Barchuk-1/+1
2016-02-13Clarify what tx/rx mean in concurrency docsManish Goregaokar-0/+2
2016-02-11Minor change.Sandeep Datta-7/+7
2016-02-11Minor change.Sandeep Datta-2/+2
2016-02-11Explained the data race with an example.Sandeep Datta-10/+30
2016-02-11Clarified move semantics in "the details" section.Sandeep Datta-7/+27
2016-02-11Added a few words to indicate where the vector object is created.Sandeep Datta-4/+6
2016-02-10Fix documentation example in the bookOliver Middleton-3/+3
The code sections shouldn't be inside a ```text block.
2016-02-09Rollup merge of #31514 - cgar:spelling, r=alexcrichtonSteve Klabnik-1/+1
2016-02-09Minor spelling fixesCarlos E. Garcia-1/+1
2016-02-07Clean up Error Handling case study examplesAndrew Barchuk-45/+44
Remove unnecessary cloning and conversions. Expand tabs left in examples.