about summary refs log tree commit diff
path: root/src/doc/book
AgeCommit message (Collapse)AuthorLines
2016-01-25Fix link to hello-cargo in the bookOliver Middleton-1/+1
It was moved in #29538.
2016-01-23Clarify when `Cargo.lock` is created by `cargo build` in the bookDirk Gadsden-3/+5
Also remove a "finally" in the section about building for release to make it feel a bit friendlier.
2016-01-23Rollup merge of #31145 - D101101:patch-1, r=steveklabnikSteve Klabnik-0/+1
r? @steveklabnik
2016-01-23Rollup merge of #31128 - kamalmarhubi:book-trait-impl-clarify, r=steveklabnikSteve Klabnik-5/+11
2016-01-23Rollup merge of #31113 - steveklabnik:master, r=alexcrichtonSteve Klabnik-7/+8
r? @alexcrichton
2016-01-23Rollup merge of #31111 - apasel422:issue-31103, r=steveklabnikSteve Klabnik-1/+1
Closes #31103 r? @steveklabnik
2016-01-23Rollup merge of #31061 - brson:bib, r=steveklabnikSteve Klabnik-0/+1
2016-01-23Fix the missing line in the guessing-game.mdSergey Veselkov-0/+1
r? @steveklabnik
2016-01-23Auto merge of #30807 - kolloch:patch-1, r=steveklabnikbors-0/+3
When I read the book, the following sentence of the reference documentation helped me greatly to understand slices: "Slices are a view into a block of memory represented as a pointer and a length." In this commit, I tried to integrate the gist of that into the slice section inside of "primitive-types.md". I am not a native speaker, so feel very free to improve the wording. r? @steveklabnik
2016-01-22Forward reference crates and modules chapterKamal Marhubi-1/+3
2016-01-22book: Clarify that trait or type must be in same crate as implKamal Marhubi-5/+9
2016-01-22update link to unwind in bookSteve Klabnik-7/+8
2016-01-22Fix typo in "Getting Started" section of the bookAndrew Paseltiner-1/+1
Closes #31103
2016-01-20Add Alexis thesis to bibliographyBrian Anderson-0/+1
2016-01-20Fixed line wrapping.Sandeep Datta-4/+13
2016-01-19Rollup merge of #30988 - bluss:doc-space-t-bound, r=apasel422Manish Goregaokar-2/+2
Fix spacing style of `T: Bound` in docs The space between `T` and `Bound` is the typical style used in code and produced by rustdoc's rendering. Fixed first in Reflect's docs and then I fixed all occurrences in docs I could find.
2016-01-17Fix spacing style of `T: Bound` in docsUlrik Sverdrup-2/+2
The space between `T` and `Bound` is the typical style used in code and produced by rustdoc's rendering. Fixed first in Reflect's docs and then I fixed all occurrences in docs I could find.
2016-01-17Fix C macro exampleStephen (Ziyun) Li-3/+5
2016-01-17Showed the difference between `map` and `and_then` with an example.Sandeep Datta-5/+17
2016-01-16Auto merge of #30567 - steffengy:master, r=alexcrichtonbors-0/+2
Add support to use functions exported using vectorcall. This essentially only allows to pass a new LLVM calling convention from rust to LLVM. ```rust extern "vectorcall" fn abc(param: c_void); ``` references ---- http://llvm.org/docs/doxygen/html/CallingConv_8h_source.html https://msdn.microsoft.com/en-us/library/dn375768.aspx
2016-01-15Clarify what a crate is, within the "Getting Started" chapter.Luke Jones-4/+6
* ref: Issue #30825 Small punctuation change in "Crates and Modules".
2016-01-14Rollup merge of #30911 - tshepang:missing-word, r=ManishearthSteve Klabnik-4/+3
Also, whitespace fixes
2016-01-14Rollup merge of #30903 - steveklabnik:no_std_stable, r=alexcrichtonSteve Klabnik-89/+52
This feature is partially stabilized, so describe each part in the appropriate place. r? @alexcrichton @brson It would be nice to backport this to beta, since this is the first release where this is true. I try really hard to not do doc backports, but this isn't very large, and might be worth making an exception, I dunno.
2016-01-14Rollup merge of #30712 - LawrenceWoodman:patch-3, r=steveklabnikSteve Klabnik-2/+15
This also repeats the case analysis used.
2016-01-14doc: add missing wordTshepang Lekhonkhobe-4/+3
Also, whitespace fixes
2016-01-14Move some #[no_std] info to stable book.Steve Klabnik-89/+52
This feature is partially stabilized, so describe each part in the appropriate place.
2016-01-14Rollup merge of #30869 - D101101:patch-3, r=huonwManish Goregaokar-1/+1
r? @steveklabnik
2016-01-14Rollup merge of #30821 - steveklabnik:gh30819, r=nikomatsakisManish Goregaokar-2/+2
Fixes #30819
2016-01-13Fix typo in bibliography.mdSergey Veselkov-1/+1
2016-01-11add feature gate "abi_vectorcall" for the vectorcall calling conventionSteffen-0/+1
2016-01-11Be a bit more correct about segfault causalitySteve Klabnik-2/+2
Fixes #30819
2016-01-11Rollup merge of #30812 - D101101:patch-2, r=steveklabnikSimonas Kazlauskas-4/+4
r? @steveklabnik
2016-01-11Fix link in getting-started.mdSergey Veselkov-4/+4
2016-01-10Book on slices: Mention internal representationPeter Kolloch-0/+3
When I read the book, the following sentence of the reference documentation helped me greatly to understand slices: "Slices are a view into a block of memory represented as a pointer and a length." In this commit, I tried to integrate the gist of that into the slice section inside of "primitive-types.md".
2016-01-09Rollup merge of #30789 - D101101:patch-1, r=steveklabnikSteve Klabnik-1/+0
2016-01-09Remove many instances of 'just'Steve Klabnik-106/+106
Doing so is considered weaker writing. Thanks @Charlotteis! Fixes #28810
2016-01-09Remove unused link from enums.mdSergey Veselkov-1/+0
2016-01-08Rollup merge of #30755 - datagrok:master, r=steveklabnikSteve Klabnik-27/+41
I'm working my way through TRPL beginning at "Syntax and Semantics" as was recommended in a previous version. I'm expecting the chapter to incrementally build up my knowledge of the language section by section, assuming no prior Rust experience. So it was a bit of a speed-bump to encounter references and the vector type in a code example long before they had been defined and explained. Another commit in this PR tries to make consistent what is a "chapter" of TRPL versus a "section." Just a nit-pick, but not thinking about that stuff keeps my focus on the important material. My background: Python programmer since ~2000, with moderate exposure to C, C++, assembly, operating systems, and system architecture in university several years ago. For your kind consideration, feel welcome to use or drop or rework any part of this.
2016-01-07Remove extraneous [], replace accidental removed link to heap sectionMichael F. Lamb-8/+8
2016-01-06Be consistent about what is a "chapter" versus a "section"Michael F. Lamb-17/+17
2016-01-06Link to section on references when we use the term prior to defining itMichael F. Lamb-2/+4
2016-01-06Link to references section when they first appearMichael F. Lamb-2/+5
In a straight-through read of "Syntax and Semantics," the concept of a "reference" is used here before it is explained. Mention that and link to the section explaining references.
2016-01-06Explain surprising new syntax appearing in example codeMichael F. Lamb-6/+15
In a straight-through read of "Syntax and Semantics," the first time we meet a generic, and the first time we meet a vector, is when a Vec<T> shows up in this example. I'm not sure that I could argue that the whole section should appear later in the book than the ones on vectors and generics, so instead just give the reader a brief introduction to both and a promise to follow up later.
2016-01-06Rollup merge of #30720 - BChip:patch-1, r=steveklabnikSteve Klabnik-1/+1
Declare what LIFO stands for
2016-01-06Rollup merge of #30699 - steveklabnik:gh30254, r=apasel422Steve Klabnik-0/+29
Fixes #30254
2016-01-06Rollup merge of #30683 - LawrenceWoodman:patch-1, r=steveklabnikSteve Klabnik-2/+2
I noticed the alignment was off in the error handling part of the book. This was caused because two tabs had crept into the file. I have changed these for spaces.
2016-01-06Add missing semi-colonLawrence Woodman-1/+1
2016-01-05Clarify What LIFO IsBChip-1/+1
Declare what LIFO stands for
2016-01-05Add correct use for Error and ioLawrence Woodman-2/+15
This also repeated the case analysis used.
2016-01-05Auto merge of #30595 - steveklabnik:remove_learn_rust, r=gankrobors-1086/+14
Some history: While getting Rust to 1.0, it was a struggle to keep the book in a working state. I had always wanted a certain kind of TOC, but couldn't quite get it there. At the 11th hour, I wrote up "Rust inside other langauges" and "Dining Philosophers" in an attempt to get the book in the direction I wanted to go. They were fine, but not my best work. I wanted to further expand this section, but it's just never going to end up happening. We're doing the second draft of the book now, and these sections are basically gone already. Here's the issues with these two sections, and removing them just fixes it all: // Philosophers There was always controversy over which ones were chosen, and why. This is kind of a perpetual bikeshed, but it comes up every once in a while. The implementation was originally supposed to show off channels, but never did, due to time constraints. Months later, I still haven't re-written it to use them. People get different results and assume that means they're wrong, rather than the non-determinism inherent in concurrency. Platform differences aggrivate this, as does the exact amount of sleeping and printing. // Rust Inside Other Languages This section is wonderful, and shows off a strength of Rust. However, it's not clear what qualifies a language to be in this section. And I'm not sure how tracking a ton of other languages is gonna work, into the future; we can't test _anything_ in this section, so it's prone to bitrot. By removing this section, and making the Guessing Game an initial tutorial, we will move this version of the book closer to the future version, and just eliminate all of these questions. In addition, this also solves the 'split-brained'-ness of having two paths, which has endlessly confused people in the past. I'm sad to see these sections go, but I think it's for the best. Fixes #30471 Fixes #30163 Fixes #30162 Fixes #25488 Fixes #30345 Fixes #29590 Fixes #28713 Fixes #28915 And probably others. This lengthy list alone is enough to show that these should have been removed. RIP.