summary refs log tree commit diff
path: root/src/doc/book
AgeCommit message (Collapse)AuthorLines
2018-03-24update books for next releasesteveklabnik-0/+0
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-09Update books for next releaseMark Simulacrum-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
2017-12-30update books for next releasesteveklabnik-0/+0
2017-11-20Update books for next releasesteveklabnik-0/+0
Also includes a fix in std::ops
2017-10-28Update the book for a fix to the print buttonCarol (Nichols || Goulding)-0/+0
Fixes #45552.
2017-10-26Bump to 1.23 and update bootstrapAlex Crichton-0/+0
This commit updates the bootstrap compiler, bumps the version to 1.23, updates Cargo, updates books, and updates crates.io dependencies
2017-10-02update books for next releasesteveklabnik-0/+0
Also fixes some stdlib links to the reference which have changed.
2017-08-16Update the books for next releasesteveklabnik-0/+0
2017-08-05Bump 'src/doc/book' git submodule.Corey Farwell-0/+0
Primarily to pick up this change: https://github.com/rust-lang/book/pull/866 ...to move this PR forward: https://github.com/rust-lang/rust/pull/43641
2017-07-14Update the books.steveklabnik-0/+0
2017-06-14update book with redirect fixessteveklabnik-0/+0
Fixes #42632
2017-06-01Update various book repos for the next release.steveklabnik-0/+0
2017-05-16Update the various books to lateststeveklabnik-0/+0
This includes a draft of chapter 20 of the book!
2017-04-18Bump book and reference.Corey Farwell-0/+0
2017-04-13Update various bookshelf repositories.steveklabnik-0/+0
The book and the reference have both had changes lately; this integrates them upstream.
2017-03-27Update various book modulessteveklabnik-0/+0
This includes an important fix for rustc contributors in https://github.com/rust-lang/book/pull/571 I'm going to update the other ones as well here while we're at it; no need to spam PRs.
2017-03-22Update the book submodule and fix tidyVadim Petrochenkov-0/+0
2017-03-20Update book and reference submodulessteveklabnik-0/+0
Some links needed adjustment to support this new scheme.
2017-03-20Import submodule for the book.steveklabnik-0/+0
It's all in the external repository now.
2017-03-20Remove the existing booksteveklabnik-17500/+0
We'll bring this back in with the next commit, as a submodule.
2017-03-17Rollup merge of #40466 - projektir:outdated_docs_highlighting, r=steveklabnikCorey Farwell-19/+2
Remove doc about highlighting code in other languages #40301 This doesn't appear to be true any longer, so removing it to avoid confusion. See #40301 Thoughts: - may be a good idea to remove "Let's discuss the details of these code blocks.", as there's not much being discussed at this point; - does `text` still work? r? @steveklabnik
2017-03-17Rollup merge of #40457 - frewsxcv:frewsxcv-macos, r=steveklabnikCorey Farwell-1/+1
Update usages of 'OSX' (and other old names) to 'macOS'. As of last year with version 'Sierra', the Mac operating system is now called 'macOS'.
2017-03-13Remove function invokation parens from documentation links.Corey Farwell-5/+5
This was never established as a convention we should follow in the 'More API Documentation Conventions' RFC: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md
2017-03-13Adjust wording #40301projektir-2/+3
2017-03-13Remove doc about highlighting code in other languages #40301projektir-18/+0
2017-03-12Update usages of 'OSX' (and other old names) to 'macOS'.Corey Farwell-1/+1
As of last year with version 'Sierra', the Mac operating system is now called 'macOS'.
2017-03-02Rollup merge of #40194 - letmaik:patch-1, r=steveklabnikGuillaume Gomez-1/+1
Fix wrong word used in book page "const and static"
2017-03-02Rollup merge of #40175 - d-e-s-o:fix-inconsistency-in-guessing-game-readme, ↵Guillaume Gomez-8/+8
r=steveklabnik doc: fix inconsistency in error output in guessing-game.md The line '.expect("failed to read line");' is partly started with a lower case 'f' and partly with an uppercase one, adding additional spurious changes to otherwise clean diffs if each sample is copy-and-pasted over the previous. This change starts the string with an uppercase everywhere which is in line with the style of the other strings.
2017-03-02Rollup merge of #40170 - iKevinY:if-let-typo, r=frewsxcvGuillaume Gomez-1/+1
Fix link in `if let` docs r? @steveklabnik
2017-03-02Rollup merge of #40169 - MajorBreakfast:patch-8, r=steveklabnikGuillaume Gomez-1/+1
String docs: Add "the" r? @steveklabnik
2017-03-02Rollup merge of #40144 - MajorBreakfast:patch-7, r=frewsxcvGuillaume Gomez-2/+3
Unit-like structs doc: Improve code sample r? @steveklabnik BTW it seems that ```Rust let p = Proton {}; ``` compiles without an error. That's why I didn't add it to the example. It's about consistency anyway.
2017-03-01fix wrong word used (static vs const)Maik Riechert-1/+1
2017-03-01doc: fix inconsistency in error output in guessing-game.mddeso-8/+8
The line '.expect("failed to read line");' is partly started with a lower case 'f' and partly with an uppercase one, adding additional spurious changes to otherwise clean diffs if each sample is copy-and-pasted over the previous. This change starts the string with an uppercase everywhere which is in line with the style of the other strings.
2017-03-01Unit-like structs doc: Add compile fail tagJosef Brandl-1/+1
2017-03-01Fix link in `if let` docsKevin Yap-1/+1
2017-03-01String docs: Add "the"Josef Brandl-1/+1
2017-02-28Rollup merge of #40142 - MajorBreakfast:patch-4, r=steveklabnikSteve Klabnik-1/+1
Structs doc: Change "pointers" to "references" Let's call them "references" instead of "pointers". That's how they're called in chapter 4.9 "References and Borrowing". r? @steveklabnik
2017-02-28Rollup merge of #40131 - MajorBreakfast:patch-3, r=steveklabnikCorey Farwell-2/+2
Make lifetime elision docs clearer Previously it said "It's forbidden to allow reasoning about types based on the item signature alone." I think that sentence is wrong. Rust **uses** the item signatures to perform type inference within the body. I think what's meant is the other way around: It does not infer types for item signatures. r? @steveklabnik
2017-02-28Rollup merge of #40124 - koba-e964:patch-1, r=steveklabnikCorey Farwell-1/+1
Remove unnecessary "for"
2017-02-28Unit-like structs doc: Improve code sampleJosef Brandl-1/+2
2017-02-28Structs doc: Change "pointers" to "references"Josef Brandl-1/+1
2017-02-27Make lifetime elision docs clearerJosef Brandl-2/+2
2017-02-27Auto merge of #38165 - Yamakaky:better-backtrace, r=petrochenkovbors-1/+14
Improve backtrace formating while panicking. Fixes #37783. Done: - Fix alignment of file paths for better readability - `RUST_BACKTRACE=full` prints all the informations (current behaviour) - `RUST_BACKTRACE=(short|yes)` is the default and does: - Skip irrelevant frames at the beginning and the end - Remove function address - Remove the current directory from the absolute paths - Remove `::hfabe6541873` at the end of the symbols - `RUST_BACKTRACE=(0|no)` disables the backtrace. - `RUST_BACKTRACE=<everything else>` is equivalent to `short` for backward compatibility. - doc - More uniform printing across platforms. Removed, TODO in a new PR: - Remove path prefix for libraries and libstd Example of short backtrace: ```rust fn fail() { panic!(); } fn main() { let closure = || fail(); closure(); } ``` Short: ``` thread 'main' panicked at 'explicit panic', t.rs:2 Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace. stack backtrace: 0: t::fail at ./t.rs:2 1: t::main::{{closure}} at ./t.rs:6 2: t::main at ./t.rs:7 ``` Full: ``` thread 'main' panicked at 'This function never returns!', t.rs:2 stack backtrace: 0: 0x558ddf666478 - std::sys::imp::backtrace::tracing::imp::unwind_backtrace::hec84c9dd8389cc5d at /home/yamakaky/dev/rust/rust/src/libstd/sys/unix/backtrace/tracing/gcc_s.rs:49 1: 0x558ddf65d90e - std::sys_common::backtrace::_print::hfa25f8b31f4b4353 at /home/yamakaky/dev/rust/rust/src/libstd/sys_common/backtrace.rs:71 2: 0x558ddf65cb5e - std::sys_common::backtrace::print::h9b711e11ac3ba805 at /home/yamakaky/dev/rust/rust/src/libstd/sys_common/backtrace.rs:60 3: 0x558ddf66796e - std::panicking::default_hook::{{closure}}::h736d216e74748044 at /home/yamakaky/dev/rust/rust/src/libstd/panicking.rs:355 4: 0x558ddf66743c - std::panicking::default_hook::h16baff397e46ea10 at /home/yamakaky/dev/rust/rust/src/libstd/panicking.rs:371 5: 0x558ddf6682bc - std::panicking::rust_panic_with_hook::h6d5a9bb4eca42c80 at /home/yamakaky/dev/rust/rust/src/libstd/panicking.rs:559 6: 0x558ddf64ea93 - std::panicking::begin_panic::h17dc549df2f10b99 at /home/yamakaky/dev/rust/rust/src/libstd/panicking.rs:521 7: 0x558ddf64ec42 - t::diverges::he6bc43fc925905f5 at /tmp/p/t.rs:2 8: 0x558ddf64ec5a - t::main::h0ffc20356b8a69c0 at /tmp/p/t.rs:6 9: 0x558ddf6687f5 - core::ops::FnOnce::call_once::hce41f19c0db56f93 10: 0x558ddf667cde - std::panicking::try::do_call::hd4c8c97efb4291df at /home/yamakaky/dev/rust/rust/src/libstd/panicking.rs:464 11: 0x558ddf698d77 - __rust_try 12: 0x558ddf698c57 - __rust_maybe_catch_panic at /home/yamakaky/dev/rust/rust/src/libpanic_unwind/lib.rs:98 13: 0x558ddf667adb - std::panicking::try::h2c56ed2a59ec1d12 at /home/yamakaky/dev/rust/rust/src/libstd/panicking.rs:440 14: 0x558ddf66cc9a - std::panic::catch_unwind::h390834e0251cc9af at /home/yamakaky/dev/rust/rust/src/libstd/panic.rs:361 15: 0x558ddf6809ee - std::rt::lang_start::hb73087428e233982 at /home/yamakaky/dev/rust/rust/src/libstd/rt.rs:57 16: 0x558ddf64ec92 - main 17: 0x7fecb869e290 - __libc_start_main 18: 0x558ddf64e8b9 - _start 19: 0x0 - <unknown> ```
2017-02-28Remove unnecessary "for"Hiroki Kobayashi-1/+1
2017-02-27Auto merge of #40115 - MajorBreakfast:patch-2, r=steveklabnikbors-1/+2
Loop docs: Present perfect instead of simple past Sounds better with present perfect because there's a link to the present. I'm not a native speaker, though. So, plz check whether it really is better ;) r? @steveklabnik
2017-02-27Auto merge of #40102 - pmer:pmer/use-macos-term-in-docs, r=steveklabnikbors-4/+4
doc: Use "macOS" terminology consistently One line in the documentation used the term macOS while the other six used OSX. Be consistent and use the current product brand of macOS.
2017-02-26Loop docs: Present perfect instead of simple pastJosef Brandl-1/+2
2017-02-26Auto merge of #40078 - tclfs:patch-3, r=GuillaumeGomezbors-1/+1
Fix a typo