about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2023-07-10Update booksrustbot-0/+0
2023-07-09fix: update link to function coverage (#1727)Emmanuel Ferdman-1/+1
2023-07-09Fix a bug in getting-started.md (#1726)İsmail Arılık-1/+1
2023-07-08Remove `default_free_fn` featureYuki Okushi-47/+0
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-07-08improve explanation of placing tests in separate file (#1721)Tshepang Mbambo-7/+6
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-07-08various fixes/improvements to Contributing chapter (#1723)Tshepang Mbambo-73/+69
2023-07-08ty::ConstKind has moved (#1724)Tshepang Mbambo-1/+1
2023-07-06Rollup merge of #113384 - joshtriplett:style-guide-grammar, r=compiler-errorsfee1-dead-11/+12
style-guide: Clarify grammar for small patterns (not a semantic change) The grammar as written feels ambiguous and confusing, in large part because it uses square brackets and commas in the names of non-terminals. Rewrite it to avoid symbols in the names of non-terminals, and to instead wrap terminals in backquotes. Also rename "smallntp" to "small_no_tuple" to make it self-describing.
2023-07-06Rollup merge of #113145 - ↵fee1-dead-2/+3
joshtriplett:style-guide-document-assignment-newlines, r=joshtriplett style-guide: Document newline rules for assignment operators The style guide gives general rules for binary operators including assignment, and one of those rules says to put the operator on the subsequent line; the style guide needs to explicitly state the exception of breaking *after* assignment operators rather than before. This is already what rustfmt does and what users do; this fixes the style guide to match the expected default style.
2023-07-05style-guide: Expand example of combinable expressions to include arraysJosh Triplett-0/+10
Arrays are allowed as combinable expressions, but none of the examples show that.
2023-07-05style-guide: Fix chain example to match rustfmt behaviorJosh Triplett-4/+3
The style guide gave an example of breaking a multi-line chain element and all subsequent elements to a new line, but that same example and the accompanying text also had several chain items stacked on the first line. rustfmt doesn't do this, except when the rule saying to combine ``` shrt .y() ``` into ``` shrt.y() ``` applies.
2023-07-05style-guide: Rename "smallntp" non-terminal to "small_no_tuple" for clarityJosh Triplett-4/+4
The meaning of "smallntp" was not immediately obvious at a glance. Rename it to the self-describing "small_no_tuple"
2023-07-05style-guide: Clarify grammar for small patterns (not a semantic change)Josh Triplett-11/+12
The grammar as written feels ambiguous and confusing, in large part because it uses square brackets and commas in the names of non-terminals. Rewrite it to avoid symbols in the names of non-terminals, and to instead wrap terminals in backquotes.
2023-07-05style-guide: Add chapter for nightly formattingJosh Triplett-3/+5
Co-authored-by: Michael Goulet <michael@errs.io>
2023-07-05Clarify that style guide does not cover nightly-only featuresMichael Goulet-0/+4
2023-07-05style-guide: Add section on bugs, and resolving bugsJosh Triplett-0/+13
2023-07-05Add support for NetBSD/riscv64 aka. riscv64gc-unknown-netbsd.Havard Eidnes-0/+2
2023-07-05document `.x test --rustc-args` optionRémy Rakic-0/+9
2023-07-03Update platform-support.mdJonathan Pallant (Ferrous Systems)-32/+32
Updates the descriptions of the various ARM targets in platform-support.md so they are a little more consistent. For example, all instances of ARMv7 changed to ARMv7-A (as opposed to ARMv7-R and ARMv7-M).
2023-07-03tests/run-make files have movedTshepang Mbambo-4/+3
2023-07-03replace dead link (#1717)Tshepang Mbambo-1/+1
2023-07-02fix linkTshepang Mbambo-2/+2
2023-07-03update linkTshepang Mbambo-1/+1
2023-07-02typoTshepang Mbambo-1/+1
2023-07-02Auto merge of #108537 - ↵bors-0/+5
GuillaumeGomez:rustdoc-search-whitespace-as-separator, r=notriddle rustdoc: Allow whitespace as path separator like double colon Fixes https://github.com/rust-lang/rust/issues/108447. I think it makes sense since it allows more common cases, however it also makes the syntax heavier. Not sure what the rest of the team thinks about it. In any case we'll need to go through FCP. Full explanation for the changes is available [here](https://github.com/rust-lang/rust/pull/108537#issuecomment-1589480564). r? `@notriddle`
2023-07-02OwningRef exists no moreTshepang Mbambo-2/+0
2023-07-01Document tracking issue for rustdoc `show-type-layout`Trevor Gross-0/+2
2023-07-01Try to avoid confusionsslime336-22/+29
2023-06-30typoTshepang Mbambo-1/+1
2023-06-30Fix line length out of limitsslime336-1/+2
2023-06-30Change `x.py` into `x`, add explanation for `x`sslime336-42/+67
2023-06-30Change `./x.py` into `./x`sslime336-157/+155
2023-06-29include rustc-dev-guide's own issues in suggested searchjyn-1/+1
2023-06-29Improve Windows docsjyn-2/+20
2023-06-29Inline alternate x.py invocations from the rust-lang/rust readmejyn-0/+25
I'm going to make a follow-up PR shortly linking from rust-lang/rust to the dev guide so this info isn't duplicated.
2023-06-29cleanup the "tracking issue" sectionjyn-18/+3
mostly this just suggests using a tracking issue instead of inlining the info from the issue template
2023-06-29fix broken linkjyn-1/+1
2023-06-29move the Breaking Changes section later in the guidejyn-1/+1
2023-06-29distinguish language and library processes more consistentlyjyn-7/+12
2023-06-29Move "Adding a new feature gate" to the "Implementing new features" chapterjyn-47/+52
Splitting the two was confusing and meant that similar information was in wildly different parts of the guide. Combine them into a single page.
2023-06-29Reword `messages.ftl` example.Eric Huss-5/+6
2023-06-29Fix some linksEric Huss-28/+28
2023-06-29Rollup merge of #113143 - ↵Matthias Krüger-1/+2
joshtriplett:style-guide-narrow-dereference-guidance, r=calebcartwright style-guide: Narrow guidance about references and dereferencing The style guide advises "prefer dereferencing to taking references", but doesn't give guidance on when that "preference" should get overridden by other considerations. Give an example of when it's fine to ignore that advice.
2023-06-29Rollup merge of #113140 - ↵Matthias Krüger-0/+5
joshtriplett:style-guide-example-multi-line-attribute, r=calebcartwright style-guide: Add an example of formatting a multi-line attribute We already say to format attributes like functions, but we didn't have an example of formatting a multi-line attribute.
2023-06-28style-guide: Document newline rules for assignment operatorsJosh Triplett-2/+3
The style guide gives general rules for binary operators including assignment, and one of those rules says to put the operator on the subsequent line; the style guide needs to explicitly state the exception of breaking *after* assignment operators rather than before. This is already what rustfmt does and what users do; this fixes the style guide to match the expected default style.
2023-06-28style-guide: Narrow guidance about references and dereferencingJosh Triplett-1/+2
The style guide advises "prefer dereferencing to taking references", but doesn't give guidance on when that "preference" should get overridden by other considerations. Give an example of when it's fine to ignore that advice.
2023-06-28style-guide: Add an example of formatting a multi-line attributeJosh Triplett-0/+5
We already say to format attributes like functions, but we didn't have an example of formatting a multi-line attribute.
2023-06-28syle-guide: Clarify let-else furtherJosh Triplett-2/+24
Give some additional examples with multi-line patterns. Make it clearer to go on to the next case if the conditions aren't met.
2023-06-28fix linkTshepang Mbambo-1/+1
2023-06-28Define more lint termsEric Huss-0/+77