about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2023-08-22Add additional licensing concerns to docsWesley Wiser-0/+33
Content included from https://github.com/rust-lang/compiler-team/issues/220.
2023-08-22avoid repetitionTshepang Mbambo-2/+2
2023-08-22Fix broken links formatyukang-3/+2
2023-08-22Auto merge of #115075 - workingjubilee:retier-sparc-none, r=compiler-errorsbors-1/+1
Reassign sparc-unknown-none-elf to tier 3 It should never have been moved to tier 2. It is a new platform and the maintainer has agreed to do tier 3 maintenance for it, not tier 2. r? `@jonathanpallant`
2023-08-22Auto merge of #115055 - Kriskras99:master, r=ehussbors-3/+4
Fix table issues in platform support documentation (closes #115047) mdBook needs an empty line before and after the table block. In addition, in the tier-3 list three targets forgot about the host column and therefore showed the notes in the host column. Closes #115047
2023-08-21Streamline description of versionsort (incorporate suggestion from Ralf)Josh Triplett-4/+3
2023-08-21Reassign sparc-unknown-none-elf to tier 3Jubilee Young-1/+1
It should never have been moved to tier 2. It is a new platform and the maintainer has agreed to do tier 3 maintenance for it, not tier 2.
2023-08-21Fix table issues in platform support documentationChristiaan Biesterbosch-3/+4
2023-08-21Clarify that version-sorting looks for the *longest* sequence of digitsJosh Triplett-3/+4
2023-08-21Make an implementation note on version-sorting accurateJosh Triplett-3/+3
2023-08-21Auto merge of #106561 - GuillaumeGomez:warning-block, r=rustdocbors-0/+13
Add warning block support in rustdoc Fixes https://github.com/rust-lang/rust/issues/79710. You can test it [here](https://rustdoc.crud.net/imperio/warning-block/foo/struct.Foo.html). It currently looks like this: ![image](https://user-images.githubusercontent.com/3050060/211413494-e1cf04e4-c081-4a9d-97db-27329405cfa7.png) So a few things to note: * Since it's a new add and it's changing the UI, we'll need to go through an FCP. * Does the UI looks good? * Is the way picked to add a warning block ok for everyone? The discussion on the issue seemed to be in favour of this solution but it doesn't hurt to double-check. cc `@rust-lang/rustdoc`
2023-08-21Use version-sorting for all sortingJosh Triplett-11/+56
Add a description of a version-sorting algorithm. (This algorithm does not precisely match `strverscmp`; it's intentionally simpler in its handling of leading zeroes, and produces a result easier for humans to easily understand and do by hand.) Change all references to sorting to use version-sorting. Change all references to "ASCIIbetically" to instead say "sort non-lowercase before lowercase".
2023-08-21fix linkTshepang Mbambo-1/+1
2023-08-21missing spaceTshepang Mbambo-1/+1
2023-08-21fix linkTshepang Mbambo-1/+1
2023-08-21avoid link rotTshepang Mbambo-1/+1
2023-08-21update internal terminology: Substs -> GenericArgsyukang-57/+57
2023-08-21Update suggested.mdAbsobel-1/+1
I imagine that the book meant that a full build isn't needed since it gave as an example the addition of a debug! statement
2023-08-20feat(docs): add cargo-pgo to PGO documentation šŸ“Meysam Azad-0/+22
2023-08-20Update outdated doc for types (#1768)Yukang-5/+7
2023-08-18Add dropck documentation (#1767)Santiago Pastorino-0/+155
2023-08-18Fix resolution cachingKyle Lin-7/+19
2023-08-18Add warn level lint `redundant_explicit_links`Kyle Lin-0/+22
- Currently it will panic due to the resolution's caching issue
2023-08-17Rollup merge of #113715 - kadiwa4:lang_items_doc, r=JohnTitorJosh Stone-252/+118
Unstable Book: update `lang_items` page and split it [`lang_items` rendered](https://github.com/kadiwa4/rust/blob/lang_items_doc/src/doc/unstable-book/src/language-features/lang-items.md), [`start` rendered](https://github.com/kadiwa4/rust/blob/lang_items_doc/src/doc/unstable-book/src/language-features/start.md) Closes #110274 Rustonomicon PR: rust-lang/nomicon#413, Rust Book PR: rust-lang/book#3705 A lot of information doesn't belong on the `lang_items` page. I added a separate page for the `start` feature and moved some text into the Rustonomicon because the `lang_items` page should not be a tutorial on how to build a `#![no_std]` executable. The list of existing lang items is too long/unstable, so I removed it. The doctests still don't work. :(
2023-08-17style-guide: Add guidance for defining formatting for specific macrosJosh Triplett-1/+6
2023-08-17doc: update lld-flavor refcui fliter-1/+1
Signed-off-by: cui fliter <imcusg@gmail.com>
2023-08-16Describe how to format trailing where clausesMichael Goulet-2/+25
2023-08-16bugfix: reflect how rustfmt formats type aliasesMichael Goulet-3/+3
2023-08-16rustc book: make more pleasant to searchTshepang Mbambo-0/+3
2023-08-16unstable-book: add quick-edit linkTshepang Mbambo-0/+1
2023-08-15Rollup merge of #114826 - xzmeng:fix-typos, r=JohnTitorMatthias Krüger-7/+7
Fix typos
2023-08-15Fix typos in rustc doc platform x86_64h-apple-darwinMeng Xiangzhuo-2/+2
2023-08-15Fix typos in rustc doc platform loongarch-linuxMeng Xiangzhuo-1/+1
2023-08-15Fix typos in rustc doc codegen-optionsMeng Xiangzhuo-1/+1
2023-08-15Fix typos in rustc doc platform aarch64-unknown-teeosMeng Xiangzhuo-1/+1
2023-08-15Fix typos in rustc doc platform netbsdMeng Xiangzhuo-1/+1
2023-08-15Fix typos in unstable-bookMeng Xiangzhuo-1/+1
2023-08-14Auto merge of #113658 - Dirreke:csky-unknown-linux-gunabiv2, r=bjorn3bors-0/+97
add a csky-unknown-linux-gnuabiv2 target This is the rustc side changes to support csky based Linux target(`csky-unknown-linux-gnuabiv2`). Tier 3 policy: > A tier 3 target must have a designated developer or developers (the "target maintainers") on record to be CCed when issues arise regarding the target. (The mechanism to track and CC such developers may evolve over time.) I pledge to do my best maintaining it. > Targets must use naming consistent with any existing targets; for instance, a target for the same CPU or OS as an existing Rust target should use the same name for that CPU or OS. Targets should normally use the same names and naming conventions as used elsewhere in the broader ecosystem beyond Rust (such as in other toolchains), unless they have a very good reason to diverge. Changing the name of a target can be highly disruptive, especially once the target reaches a higher tier, so getting the name right is important even for a tier 3 target. This `csky` section is the arch name and the `unknown-linux` section is the same as other linux target, and `gnuabiv2` is from the cross-compile toolchain of `gcc` > Target names should not introduce undue confusion or ambiguity unless absolutely necessary to maintain ecosystem compatibility. For example, if the name of the target makes people extremely likely to form incorrect beliefs about what it targets, the name should be changed or augmented to disambiguate it. I think the explanation in platform support doc is enough to make this aspect clear. > Tier 3 targets may have unusual requirements to build or use, but must not create legal issues or impose onerous legal terms for the Rust project or for Rust developers or users. It's using open source tools only. > The target must not introduce license incompatibilities. No new license > Anything added to the Rust repository must be under the standard Rust license (MIT OR Apache-2.0). Understood. > The target must not cause the Rust tools or libraries built for any other host (even when supporting cross-compilation to the target) to depend on any new dependency less permissive than the Rust licensing policy. This applies whether the dependency is a Rust crate that would require adding new license exceptions (as specified by the tidy tool in the rust-lang/rust repository), or whether the dependency is a native library or binary. In other words, the introduction of the target must not cause a user installing or running a version of Rust or the Rust tools to be subject to any new license requirements. There are no new dependencies/features required. > Compiling, linking, and emitting functional binaries, libraries, or other code for the target (whether hosted on the target itself or cross-compiling from another target) must not depend on proprietary (non-FOSS) libraries. Host tools built for the target itself may depend on the ordinary runtime libraries supplied by the platform and commonly used by other applications built for the target, but those libraries must not be required for code generation for the target; cross-compilation to the target must not require such libraries at all. For instance, rustc built for the target may depend on a common proprietary C runtime library or console output library, but must not depend on a proprietary code generation library or code optimization library. Rust's license permits such combinations, but the Rust project has no interest in maintaining such combinations within the scope of Rust itself, even at tier 3. As previously said it's using open source tools only. > "onerous" here is an intentionally subjective term. At a minimum, "onerous" legal/licensing terms include but are not limited to: non-disclosure requirements, non-compete requirements, contributor license agreements (CLAs) or equivalent, "non-commercial"/"research-only"/etc terms, requirements conditional on the employer or employment of any particular Rust developers, revocable terms, any requirements that create liability for the Rust project or its developers or users, or any requirements that adversely affect the livelihood or prospects of the Rust project or its developers or users. There are no such terms present/ > Neither this policy nor any decisions made regarding targets shall create any binding agreement or estoppel by any party. If any member of an approving Rust team serves as one of the maintainers of a target, or has any legal or employment requirement (explicit or implicit) that might affect their decisions regarding a target, they must recuse themselves from any approval decisions regarding the target's tier status, though they may otherwise participate in discussions. I'm not the reviewer here. > This requirement does not prevent part or all of this policy from being cited in an explicit contract or work agreement (e.g. to implement or maintain support for a target). This requirement exists to ensure that a developer or team responsible for reviewing and approving a target does not face any legal threats or obligations that would prevent them from freely exercising their judgment in such approval, even if such judgment involves subjective matters or goes beyond the letter of these requirements. I'm not the reviewer here. > Tier 3 targets should attempt to implement as much of the standard libraries as possible and appropriate (core for most targets, alloc for targets that can support dynamic memory allocation, std for targets with an operating system or equivalent layer of system-provided functionality), but may leave some code unimplemented (either unavailable or stubbed out as appropriate), whether because the target makes it impossible to implement or challenging to implement. The authors of pull requests are not obligated to avoid calling any portions of the standard library on the basis of a tier 3 target not implementing those portions. It supports for std > The target must provide documentation for the Rust community explaining how to build for the target, using cross-compilation if possible. If the target supports running binaries, or running tests (even if they do not pass), the documentation must explain how to run such binaries or tests for the target, using emulation if possible or dedicated hardware if necessary. I have added the documentation, and I think it's clear. > Tier 3 targets must not impose burden on the authors of pull requests, or other developers in the community, to maintain the target. In particular, do not post comments (automated or manual) on a PR that derail or suggest a block on the PR based on a tier 3 target. Do not send automated messages or notifications (via any medium, including via `@)` to a PR author or others involved with a PR regarding a tier 3 target, unless they have opted into such messages. Understood. > Backlinks such as those generated by the issue/PR tracker when linking to an issue or PR are not considered a violation of this policy, within reason. However, such messages (even on a separate repository) must not generate notifications to anyone involved with a PR who has not requested such notifications. Understood. > Patches adding or updating tier 3 targets must not break any existing tier 2 or tier 1 target, and must not knowingly break another tier 3 target without approval of either the compiler team or the maintainers of the other tier 3 target. I believe I didn't break any other target. > In particular, this may come up when working on closely related targets, such as variations of the same architecture with different features. Avoid introducing unconditional uses of features that another variation of the target may not have; use conditional compilation or runtime detection, as appropriate, to let each target run code supported by that target. I think there are no such problems in this PR.
2023-08-14Update booksrustbot-0/+0
2023-08-14add details for csky-unknown-linux-gnuabiv2 and add docsDirreke-13/+66
2023-08-14add `rustc_codegen_ssa` support for csky and correct some codeDirreke-1/+1
2023-08-14add a csky-unknown-linux-gnuabiv2 targetDirreke-0/+44
2023-08-14Add GUI test for warning blocksGuillaume Gomez-1/+2
2023-08-14Add documentation for warning blocks in rustdoc bookGuillaume Gomez-0/+12
2023-08-14fix: stabilize debugger_visualizerEmmanuel Ferdman-2/+2
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
2023-08-11refactor(parts): remove part numbers to be consistentİsmail Arılık-3/+3
2023-08-11revert(part-5-intro): revert 4806958İsmail Arılık-1/+1
I will remove part numbers after that.
2023-08-11revert(part-2-intro): revert 2f0aa1eİsmail Arılık-1/+1
I will remove part numbers after that.
2023-08-11fix(part-2-intro): remove the phrase "from Part 1" which is not existİsmail Arılık-1/+1
2023-08-11feat(part-5-intro): make "Part 5" obviousİsmail Arılık-1/+1