summary refs log tree commit diff
path: root/src/doc/book
AgeCommit message (Collapse)AuthorLines
2017-04-18Fix link to book repoSteve Klabnik-1/+1
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
2017-02-25doc: Use "macOS" terminology consistentlyPaul Merrill-4/+4
One line in the documentation used the term macOS while the other six used OSX. Be consistent and use the name current product brand of macOS.
2017-02-24Fix a typoTang Chenglong-1/+1
2017-02-24Rollup merge of #40071 - tomwhoiscontrary:pr-lets-apostrophes, r=GuillaumeGomezGuillaume Gomez-1/+1
Correct another typo in procedural macros chapter of the Book. Another (and the only remaining) instance of the lets/let's mistake fixed in c8292fc / 36b00cf. r? @steveklabnik
2017-02-24Rollup merge of #39845 - JDemler:master, r=steveklabnikGuillaume Gomez-0/+73
Add Documentation for Custom Attributes and Error Reporting in Procedural Macros This fixes #39821 . I'm not sure if the process of how to access custom attributes should be documented as well. But I feel, that this should rather be documented in `syn`
2017-02-24Rollup merge of #39777 - mina86:gib, r=steveklabnikGuillaume Gomez-1/+1
book: binary prefixed are defined by IEC and not in SI Binary prefixes (such as Gi for ‘gibi-’ in GiB) are defined by International Electrotechnical Commission (IEC) and not in the International System of Units (SI). Though to be honest I’d just reword the previous paragraph to use ‘1 GiB’.
2017-02-24Correct another typo in procedural macros chapter of the Book.Tom Anderson-1/+1
2017-02-21fix some linksSteve Klabnik-23/+6
2017-02-21TRPL Nightly -> Unstable BookSteve Klabnik-1239/+0
Port the chapters from TRPL's "Nightly Rust" section to the Unstable Book, and remove it from TRPL.
2017-02-21Get linkchecker cleanSteve Klabnik-15/+16
This affects the book, some missed things in the reference, the grammar, and the standard library. Whew!
2017-02-20Rollup merge of #39976 - steveklabnik:reenable-book-linkchecker, r=frewsxcvCorey Farwell-84/+84
Reenable linkchecker for books In some senses, this is a revert of https://github.com/rust-lang/rust/pull/39633/commits/cacb3bc9c741a7d41a1085af850cd3ff852307f5#diff-b64563d143f859565c8357a28ef81101R212; we disabled linkchecker for the book because the links were added by JavaScript. Now, that's fixed upstream, and so we can re-enable the checker. This also involves two other fixes: we have to check for `name`s as well as `id`s for links, and the linking algorithm of mdBook changed to the same as rustdoc's, so we change some links back. ~~~This isn't quite ready yet; it's [depending on a PR of mine to mdBook](https://github.com/azerupi/mdBook/pull/209). After that's released, this should be the last of these kinds of shenanigans~~~ 😄 This is good to go 😄
2017-02-20Auto merge of #39748 - Rufflewind:master, r=steveklabnikbors-6/+52
Rust Book: Generics: Resolving ambiguities - Add a small section to generics.md to explain how ambiguities in type inference can be resolved using the `::<>` syntax. - Add links from syntax-index.md and iterators.md. - Minor edits to iterators.md and structs.md.
2017-02-20Revert "Fix up links"Steve Klabnik-84/+84
This reverts commit 7f1d1c6d9a7be5e427bace30e740b16b25f25c92. The original commit was created because mdBook and rustdoc had different generation algorithms for header links; now with https://github.com/rust-lang/rust/pull/39966 , the algorithms are the same. So let's undo this change. ... when I came across this problem, I said "eh, this isn't fun, but it doesn't take that long." I probably should have just actually taken the time to fix upstream, given that they were amenable. Oh well!
2017-02-20Auto merge of #39923 - mattyw:patch-1, r=steveklabnikbors-1/+1
Variable Bindings possible nitpick Complete drive by nitpick I'm afraid
2017-02-19Rust Book: Generics: Resolving ambiguitiesPhil Ruffwind-6/+52
- Add a small section to generics.md to explain how ambiguities in type inference can be resolved using the ::<> syntax. - Add links from syntax-index.md and iterators.md. - Minor edits to iterators.md and structs.md.
2017-02-19Fixed some small issuesJakob Demler-8/+11
2017-02-18Rollup merge of #39847 - CBenoit:patch-1, r=frewsxcvGuillaume Gomez-1/+1
Correct a typo in procedural macros chapter of the Book. A simple and short correction for procedural macros chapter of the Rust Programming Language Book.
2017-02-18Variable Bindings possible nitpickMatt Williams-1/+1
Complete drive by nitpick I'm afraid
2017-02-16Correct a typo in procedural macros chapter of the Book. (fixup ↵Benoît CORTIER-1/+1
[c8292fcd6ad2a06d2529f5])
2017-02-16Auto merge of #39876 - frewsxcv:rollup, r=frewsxcvbors-9/+7
Rollup of 12 pull requests - Successful merges: #39775, #39793, #39804, #39834, #39836, #39839, #39840, #39843, #39844, #39846, #39857, #39861 - Failed merges:
2017-02-15Rollup merge of #39840 - DaseinPhaos:patch-2, r=frewsxcvCorey Farwell-1/+1
Update procedural-macros.md Fix typo
2017-02-15fixed whitespace issuesJakob Demler-1/+3
2017-02-15Improve backtrace formating while panicking.Yamakaky-1/+14
- `RUST_BACKTRACE=full` prints all the informations (old behaviour) - `RUST_BACKTRACE=(0|no)` disables the backtrace. - `RUST_BACKTRACE=<everything else>` (including `1`) shows a simplified backtrace, without the function addresses and with cleaned filenames and symbols. Also removes some unneded frames at the beginning and the end. Fixes #37783. PR is #38165.
2017-02-15book: binary prefixed are defined by IEC and not in SIMichal Nazarewicz-1/+1
Binary prefixes (such as Gi for ‘gibi-’ in GiB) are defined by International Electrotechnical Commission (IEC) and not in the International System of Units (SI).
2017-02-15book: don’t use GNU extensions in the example unnecessarilyMichal Nazarewicz-8/+6
The use of a GNU C extension for bloc expressions is immaterial to the actual problem with C macros that the section tries to show so don’t use it and instead use a plain C way of writing the macro.
2017-02-15add bash to error-messagesJakob Demler-2/+2
2017-02-15Correct a typo in procedural macros chapter of the Book.Benoît CORTIER-1/+1
2017-02-15custom attributes and error reporting docs for procedural macrosJakob Demler-1/+69
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-07-14 17:51:13 +0000