about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2020-06-23Small spelling fix.Drew Youngwerth-1/+1
2020-06-23address review commentsmark-5/+32
2020-06-23Add prerequisite pageFlorian Gilcher-1/+28
2020-06-23add suggestion style guideAndy Russell-0/+16
The guide is based on [existing rustdoc]. [existing rustdoc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_errors/struct.Diagnostic.html#method.span_suggestion
2020-06-23fix the rebase trickmark-1/+3
2020-06-23whitelist amazonWho? Me?!-1/+1
2020-06-23Fix links for now.Who? Me?!-1/+1
2020-06-22Add information about size for building the Rust CompilerThePuzzlemaker-0/+3
The Rust codebase is large, not to mention the submodules. It would be helpful for some to have a warning or note about storage required before they spend possible hours to build, only to get a message in some form that they are running out/already out of storage. I did a stage1 build incrementally and it produced a build directory of about 14 gigabytes.
2020-06-22Update asm! documentationAmanieu d'Antras-2/+6
2020-06-21Fix master branch links (#757)Who? Me?!-2/+6
* fix links * some debugging * more debugging * fix git checkout in ci * try again * already tests with a merge * Typo Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com> Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-06-20Clarify --extern documentation.Adrian Taylor-2/+10
Fixes #64731, #73531. See also #64402#issuecomment-530852886
2020-06-20Rollup merge of #73404 - ajpaverd:cfguard_syntax, r=Mark-SimulacrumRalf Jung-5/+5
Update CFGuard syntax Update the naming and syntax of the control-flow-guard option, as discussed in #68793. r? @Mark-Simulacrum
2020-06-19Rollup merge of #73347 - tmiasko:incompatible-sanitizers, r=nikicManish Goregaokar-2/+1
Diagnose use of incompatible sanitizers Emit an error when incompatible sanitizer are configured through command line options. Previously the last one configured prevailed and others were silently ignored. Additionally use a set to represent configured sanitizers, making it possible to enable multiple sanitizers at once. At least in principle, since currently all of them are considered to be incompatible with others.
2020-06-19Rollup merge of #73364 - joshtriplett:inline-asm, r=AmanieuManish Goregaokar-21/+36
asm: Allow multiple template string arguments; interpret them as newline-separated Allow the `asm!` macro to accept a series of template arguments, and interpret them as if they were concatenated with a '\n' between them. This allows writing an `asm!` where each line of assembly appears in a separate template string argument. This syntax makes it possible for rustfmt to reliably format and indent each line of assembly, without risking changes to the inside of a template string. It also avoids the complexity of having the user carefully format and indent a multi-line string (including where to put the surrounding quotes), and avoids the extra indentation and lines of a call to `concat!`. For example, rewriting the second example from the [blog post on the new inline assembly syntax](https://blog.rust-lang.org/inside-rust/2020/06/08/new-inline-asm.html) using multiple template strings: ```rust fn main() { let mut bits = [0u8; 64]; for value in 0..=1024u64 { let popcnt; unsafe { asm!( " popcnt {popcnt}, {v}", "2:", " blsi rax, {v}", " jz 1f", " xor {v}, rax", " tzcnt rax, rax", " stosb", " jmp 2b", "1:", v = inout(reg) value => _, popcnt = out(reg) popcnt, out("rax") _, // scratch inout("rdi") bits.as_mut_ptr() => _, ); } println!("bits of {}: {:?}", value, &bits[0..popcnt]); } } ``` Note that all the template strings must appear before all other arguments; you cannot, for instance, provide a series of template strings intermixed with the corresponding operands.
2020-06-19Rollup merge of #73214 - androm3da:hex_inline_asm_00, r=AmanieuManish Goregaokar-3/+10
Add asm!() support for hexagon
2020-06-19new tykind::error convention (#715)Who? Me?!-2/+16
2020-06-18fix line lengthmark-1/+2
2020-06-18address a bunch of review commentsmark-4/+31
2020-06-18LeSeulArtichaut wording/typo fixesWho? Me?!-5/+5
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18address review commentsmark-17/+24
2020-06-18Apply suggestions from code reviewWho? Me?!-6/+6
Co-authored-by: LeSeulArtichaut <leseulartichaut@gmail.com>
2020-06-18Better wordingWho? Me?!-1/+1
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18Slightly reorganize to first present the slow command then the fast commandsmark-29/+74
2020-06-18add a note about disk spacemark-3/+4
2020-06-18python 3 alsomark-1/+1
2020-06-18Apply suggestions from code reviewWho? Me?!-6/+24
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com> Co-authored-by: Joshua Nelson <joshua@yottadb.com> Co-authored-by: Phil Hansch <dev@phansch.net>
2020-06-18add forgemark-0/+1
2020-06-18Apply suggestions from code reviewWho? Me?!-4/+4
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18add note on submodulesmark-1/+10
2020-06-18add a bit moremark-4/+62
2020-06-18fix linkmark-1/+1
2020-06-18mention incremental disk spacemark-0/+5
2020-06-18a couple more small changesmark-2/+3
2020-06-18some minor updatesmark-3/+11
2020-06-18write about processesmark-6/+102
2020-06-18address some review commentsmark-4/+9
2020-06-18Typo fixesWho? Me?!-4/+4
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-06-18start a getting started guidemark-0/+224
2020-06-18Add a link to the forge procedure on adding new options. (#754)Eric Huss-0/+4
2020-06-18Don't give `x.py clean` as the first x.py exampleJoshua Nelson-2/+2
This command shouldn't be used very often, and it has its own whole section below anyway.
2020-06-17Document rustdoc behaviorJoshua Nelson-0/+16
- `RUSTDOC_LOG` - `// aux-build:filename.rs` - `// build-aux-docs`
2020-06-16Add some more detail on compiletest normalization.Eric Huss-13/+47
2020-06-16Update CFGuard syntaxAndrew Paverd-5/+5
2020-06-16Add initial asm!() support for hexagonBrian Cain-3/+10
GPRs only
2020-06-15asm: Update chapter in unstable book for multiple template string argumentsJosh Triplett-21/+36
Update all examples to use the new formatting, and update explanations to document it.
2020-06-14Diagnose use of incompatible sanitizersTomasz Miąsko-2/+1
Emit an error when incompatible sanitizer are configured through command line options. Previously the last one configured prevailed and others were silently ignored. Additionally use a set to represent configured sanitizers, making it possible to enable multiple sanitizers at once. At least in principle, since currently all of them are considered to be incompatible with others.
2020-06-11Rollup merge of #73230 - Amanieu:asm-unused2, r=petrochenkovDylan DPC-2/+4
Suggest including unused asm arguments in a comment to avoid error We require all arguments to an `asm!` to be used in the template string, just like format strings. However in some cases (e.g. `black_box`) it may be desirable to have `asm!` arguments that are not used in the template string. Currently this is a hard error rather than a lint since `#[allow]` does not work on macros (#63221), so this PR suggests using the unused arguments in an asm comment as a workaround. r? @petrochenkov
2020-06-11Rollup merge of #73080 - ertos-rs:sean.wilson/devel/external_doc-ref-fix, ↵Dylan DPC-1/+1
r=ollie27 doc/rustdoc: Fix incorrect external_doc feature flag
2020-06-11tag/niche terminology (#747)Ralf Jung-1/+4
2020-06-10Fix CI rebase (#745)Who? Me?!-1/+1
* Fix CI rebase