about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2018-09-10fix linkNiko Matsakis-1/+3
2018-09-10add a note about the collector executableNiko Matsakis-3/+29
2018-09-10update with njn's insightNiko Matsakis-5/+5
2018-09-10don't write `rust-prof` bur rather `<toolchain>Niko Matsakis-5/+9
2018-09-10link to build-and-run, fix em-dashNiko Matsakis-2/+10
2018-09-10say function, not fnNiko Matsakis-3/+3
2018-09-10be consistent about bash snippetsNiko Matsakis-7/+7
2018-09-10fix long linesNiko Matsakis-2/+4
2018-09-10switch to em-dashNiko Matsakis-9/+10
2018-09-10various nits from mark-i-mNiko Matsakis-18/+20
2018-09-10add a section about profiling with perfNiko Matsakis-1/+306
2018-09-09remove #[used] from the unstable bookJorge Aparicio-157/+0
it'll be documented in the reference
2018-09-08docs: Use dollar sign for all bash promptsBehnam Esfahbod-7/+10
Making it consistent across the board, as most of them already use `$`. Also split one continues bash run into two, to make it easier see different runs: one with warning and another with error.
2018-09-09Stabilize the 2018 editionMark Rousskov-13/+14
2018-09-08Rollup merge of #54040 - steveklabnik:update-books, r=Mark-Simulacrumkennytm-0/+0
update books for next release
2018-09-07update books for next releasesteveklabnik-0/+0
2018-09-07Write in EnglishDale Wijnand-1/+1
2018-09-07No copyright notices on new testsDale Wijnand-1/+0
2018-09-07Rollup merge of #53550 - brson:recurring, r=estebankkennytm-2/+2
librustc_lint: In recursion warning, change 'recurring' to 'recursing' The existing wording seems incorrect. Aside: This warning, 'function cannot return without recursing' is not perfectly clear - it implies that the function _can_ return, it's just got to recurse. But really the fn cannot return period. Clearer wording: 'function recurses infinitely; it cannot return'; or 'function is infinitely self-recursive; it cannot return, and this is probably an error'. I like that.
2018-09-04Document #[test_case] and #![test_runner]John Renner-0/+33
2018-09-01Rollup merge of #53076 - QuietMisdreavus:cfg-rustdoc, r=GuillaumeGomezkennytm-13/+15
set cfg(rustdoc) when rustdoc is running on a crate When using `#[doc(cfg)]` to document platform-specific items, it's a little cumbersome to get all the platforms' items to appear all at once. For example, the standard library adds `--cfg dox` to rustdoc's command line whenever it builds docs, and the documentation for `#![feature(doc_cfg)]` suggests using a Cargo feature to approximate the same thing. This is a little awkward, because you always need to remember to set `--features dox` whenever you build documentation. This PR proposes making rustdoc set `#[cfg(rustdoc)]` whenever it runs on a crate, to provide an officially-sanctioned version of this that is set automatically. This way, there's a standardized way to declare that a certain version of an item is specifically when building docs. To try to prevent the spread of this feature from happening too quickly, this PR also restricts the use of this flag to whenever `#![feature(doc_cfg)]` is active. I'm sure there are other uses for this, but right now i'm tying it to this feature. (If it makes more sense to give this its own feature, i can easily do that.)
2018-08-31note about discussion channelsNiko Matsakis-0/+10
2018-08-31includ some notes on finding bugsNiko Matsakis-1/+4
2018-08-31fix various minor pointsNiko Matsakis-6/+6
2018-08-31adjust long linesNiko Matsakis-15/+21
2018-08-31add a section about the compiler teamNiko Matsakis-0/+101
2018-08-31feature(doc_cfg): add docs for cfg(rustdoc)QuietMisdreavus-13/+15
2018-08-31Auto merge of #51384 - QuietMisdreavus:extern-version, r=GuillaumeGomezbors-0/+15
rustdoc: add flag to control the html_root_url of dependencies The `--extern-html-root-url` flag in this PR allows one to override links to crates whose docs are not already available locally in the doc bundle. Docs.rs currently uses a version of this to make sure links to other crates go into that crate's docs.rs page. See the included test for intended use, but the idea is as follows: Calling rustdoc with `--extern-html-root-url crate=https://some-url.com` will cause rustdoc to override links that point to that crate to instead be replaced with a link rooted at `https://some-url.com/`. (e.g. for docs.rs this would be `https://docs.rs/crate/0.1.0` or the like.) Cheekily, rustup could use these options to redirect links to std/core/etc to instead point to locally-downloaded docs, if it so desired. Fixes https://github.com/rust-lang/rust/issues/19603
2018-08-31tweak long lineNiko Matsakis-5/+6
2018-08-31sprinkle links to rustdoc through the HIR explanationNiko Matsakis-29/+58
2018-08-26Auto merge of #53619 - japaric:panic-handler, r=SimonSapinbors-3/+3
add #[panic_handler]; deprecate #[panic_implementation] r? @SimonSapin cc #44489
2018-08-24Auto merge of #53662 - kennytm:rollup, r=kennytmbors-0/+0
Rollup of 16 pull requests Successful merges: - #53311 (Window Mutex: Document that we properly initialize the SRWLock) - #53503 (Discourage overuse of mem::forget) - #53545 (Fix #50865: ICE on impl-trait returning functions reaching private items) - #53559 (add macro check for lint) - #53562 (Lament the invincibility of the Turbofish) - #53563 (use String::new() instead of String::from(""), "".to_string(), "".to_owned() or "".into()) - #53592 (docs: minor stylistic changes to str/string docs) - #53594 (Update RELEASES.md to include clippy-preview) - #53600 (Fix a grammatical mistake in "expected generic arguments" errors) - #53614 (update nomicon and book) - #53617 (tidy: Stop requiring a license header) - #53618 (Add missing fmt examples) - #53636 (Prefer `.nth(n)` over `.skip(n).next()`.) - #53644 (Use SmallVec for SmallCStr) - #53664 (Remove unnecessary closure in rustc_mir/build/mod.rs) - #53666 (Added rustc_codegen_llvm to compiler documentation.)
2018-08-24Rollup merge of #53614 - RalfJung:nomicon, r=kennytmkennytm-0/+0
update nomicon and book
2018-08-23address review commentSébastien Duquette-2/+2
2018-08-23Fix lines over 80 columns.Sébastien Duquette-6/+7
2018-08-23Rename CodeMap and FileMap to SourceMap and SourceFile.Sébastien Duquette-17/+17
Those types were renamed in https://github.com/rust-lang/rust/pull/52953
2018-08-23Stabilize 'attr_literals' feature.Sergio Benitez-30/+0
2018-08-23update the unstable bookJorge Aparicio-3/+3
2018-08-23Auto merge of #52602 - scottmcm:tryblock-expr, r=nikomatsakisbors-7/+9
Implement try block expressions I noticed that `try` wasn't a keyword yet in Rust 2018, so... ~~Fix​es https://github.com/rust-lang/rust/issues/52604~~ That was fixed by PR https://github.com/rust-lang/rust/pull/53135 cc https://github.com/rust-lang/rust/issues/31436 https://github.com/rust-lang/rust/issues/50412
2018-08-23Stabilize a few secondary macro featuresVadim Petrochenkov-26/+0
`tool_attributes`, `proc_macro_path_invoc`, partially `proc_macro_gen`
2018-08-22update nomicon and bookRalf Jung-0/+0
2018-08-21Rollup merge of #53496 - matthiaskrgr:codespell_08_2018, r=varkorkennytm-9/+9
Fix typos found by codespell.
2018-08-20librustc_lint: In recursion warning, change 'recurring' to 'recursing'Brian Anderson-2/+2
2018-08-20add rust,ignore to code snippetsNiko Matsakis-2/+2
2018-08-20Update existential-types.mdOliver Schneider-3/+3
2018-08-20Explain existential typesOliver Schneider-0/+49
2018-08-20Update copyright guidance to omit notices for new files.Josh Triplett-32/+5
Previously approved in https://github.com/rust-lang/rust/pull/43498 ; update the guide to match.
2018-08-19Rename `catch_expr` feature to `try_blocks`Scott McMurray-3/+3
2018-08-19Fix the unstable bookScott McMurray-5/+7
I ignored the code block as I didn't see a way to run the doctest in 2018 -- I noticed the edition guide is also not testing its 2018 code snippits.
2018-08-19Stabilize macro_vis_matcherJakub Kozlowski-15/+0