about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2022-01-18Spelling: Rename `rust` to `Rust` (#1288)Georgiy Komarov-35/+35
2022-01-18Clean up section about FCPs (#1287)Noah Lev-23/+20
* I've never heard the term "pFCP" used before, so spell it out as "proposed final comment period" * Fix some unclear things (like implying that you need `r+` rights to start an FCP) * Improve the chapter's title, and make it consistent with its TOC entry * Make some other assorted minor cleanups and improvements
2022-01-17Rollup merge of #90498 - joshtriplett:target-tier-policy-draft-updates, ↵Matthias Krüger-16/+80
r=Mark-Simulacrum Clarifications in the target tier policy We've added several targets since the introduction of the target tier policy. Based on experiences of those adding such targets, and discussions around such additions, clarify the target tier policy to make it easier to follow and work with. None of these changes substantively change the requirements on targets. (In some cases the changes do direct target submitters to follow specific process requirements for the addition of a target, such as how to respond to requirements, where to put target-specific documentation, or what should appear in that documentation. Those changes are procedural in nature and document the procedures we already direct people to follow.) - Clarify how to quote and respond to the target tier policy requirements. Several times, people have seemed unclear on how to respond to some of the policy requirements, particularly those that just state things the target developers must *not* do (e.g. not posting to PRs that break the target). Add a note that such requirements just need acknowledgement, nothing more. - Clarify dependency requirements in the face of cross-compilation. I previously phrased this confusingly in terms of "host tools", since that is the case where an exception applies (allowing proprietary target libraries commonly used by binaries for the target). Rephrase it to apply equally to cross-compilation. This doesn't change the net effect of the requirements, since other requirements already cover the dependencies of the Rust toolchain. - Clarify documentation about running binaries. The requirement for target documentation talks about "running tests", but tier 3 targets often don't support running the full testsuite, and in practice the documentation for how to run an individual binary may be more useful. Change "running tests" to "running binaries, or running tests". - Explain where to place target-specific documentation (a subdirectory of platform-support, with a link from the platform-support entry for the target). - Add a template for target-specific documentation.
2022-01-17Auto merge of #92816 - tmiasko:rm-llvm-asm, r=Amanieubors-190/+0
Remove deprecated LLVM-style inline assembly The `llvm_asm!` was deprecated back in #87590 1.56.0, with intention to remove it once `asm!` was stabilized, which already happened in #91728 1.59.0. Now it is time to remove `llvm_asm!` to avoid continued maintenance cost. Closes #70173. Closes #92794. Closes #87612. Closes #82065. cc `@rust-lang/wg-inline-asm` r? `@Amanieu`
2022-01-14Rollup merge of #92818 - GuillaumeGomez:update-doc-cfg-doc, r=camelidMatthias Krüger-0/+33
Update documentation for doc_cfg feature Fixes #92484.
2022-01-13Update documentation for doc_cfgGuillaume Gomez-0/+33
2022-01-12Remove LLVM-style inline assembly from unstable bookTomasz Miąsko-190/+0
2022-01-09Extended the note on the use of `no_run` attributeDmitrii - Demenev-1/+2
2022-01-09Document `--print link-args`Josh Triplett-0/+6
The documentation makes it clear that the *exact* format of the output is not a stable guarantee.
2022-01-07Update location from a relative path to absoluteavborhanian-1/+1
2022-01-05Address more review comments in #1286.Nicholas Nethercote-2/+2
2022-01-05Address review comments in #1286.Nicholas Nethercote-10/+4
2022-01-05Streamline "Getting Started" some more.Nicholas Nethercote-182/+58
This is a follow-up to #1279. The "Getting Started" chapter is, TBH, pretty bad when it comes to the stuff about building and testing. It has far too much detail and lots of repetition, which would be overwhelming to a newcomer. This commit removes most of it, leaving behind just quick mentions of the most common `x.py` commands: `check`, `build`, `test`, `fmt`, with links to the appropriate chapters for details. There were a few interesting details that weren't covered elsewhere, so I moved those into other chapters.
2022-01-03Update booksEric Huss-0/+0
2022-01-01Require `-Zunstable-options` for `-C instrument-coverage=except-*` optionsJosh Triplett-2/+2
These options primarily exist to work around bugs, and those bugs have largely been fixed. Avoid stabilizing them, so that we don't have to support them indefinitely.
2022-01-01Clarify stability expectations for llvm-tools-previewJosh Triplett-1/+1
Co-authored-by: Mark Rousskov <mark.simulacrum@gmail.com>
2022-01-01Update instrument-coverage documentation to document stability and LLVM versionsJosh Triplett-3/+7
The instrument-coverage option is stable; the details of the profile data format are not. Recommend llvm-tools-preview as the preferred alternative to obtain a compatible version of the LLVM tools, rather than finding LLVM tools elsewhere.
2022-01-01Rewrite instrument-coverage documentation to use LLVM tools directlyJosh Triplett-24/+14
llvm-tools-preview is still experimental, so document it as such, and don't use it in the examples.
2022-01-01Stabilize -Z instrument-coverage as -C instrument-coverageJosh Triplett-36/+32
Continue supporting -Z instrument-coverage for compatibility for now, but show a deprecation warning for it. Update uses and documentation to use the -C option. Move the documentation from the unstable book to stable rustc documentation.
2022-01-01Update references to `-Z symbol-mangling-version` to use `-C`Josh Triplett-1/+1
Replace `-Z symbol-mangling-version=v0` with `-C symbol-mangling-version=v0`. Replace `-Z symbol-mangling-version=legacy` with `-Z unstable-options -C symbol-mangling-version=legacy`.
2021-12-29Auto merge of #88354 - Jmc18134:hint-space-pauth-opt, r=nagisabors-0/+18
Add codegen option for branch protection and pointer authentication on AArch64 The branch-protection codegen option enables the use of hint-space pointer authentication code for AArch64 targets.
2021-12-28Update link to moved section (#1282)Noah Lev-1/+1
The section was removed in #1030 and re-added in a different place in 2d42cf7.
2021-12-27Fix link in contributing.md (#1280)Ben Reeves-2/+2
2021-12-24Streamline "Getting Started" (#1279)Nicholas Nethercote-138/+89
* Move `x.py` intro section before first use, and shorten it. * Improve `x.py setup` docs. In "Getting Started", strip it back to the bare minimum. Some of this is moved into the later section. In the later section, add notable details like config.toml.example how and `profile` works. Also make the config.toml example more concise. * Move details about the repository. Less detail in "Getting Started", more in the later sections. * Move details about the prereqs. Less detail in "Getting Started", more in the later sections.
2021-12-23Update booksEric Huss-0/+0
2021-12-20Update linker-plugin-lto.mdNicolas-1/+1
2021-12-20Update linker-plugin-lto.mdNicolas-3/+3
2021-12-20Add x86_64-pc-windows-msvc linker-plugin-lto instructionsNicolas-0/+42
2021-12-20remove rustfix item in test intro (#1277)Wang Qilin-3/+0
2021-12-19add platform-support/openbsd.md in SUMMARY.mdSébastien Marie-0/+1
2021-12-19add OpenBSD platform-support pageSébastien Marie-4/+60
2021-12-15Move date-check comment to fix Markdown syntaxNoah Lev-2/+2
The inline code wasn't being rendered correctly.
2021-12-15Update humor docs for special-casing ferris emojiMaxwell Elliot Heiber-0/+1
update for: https://github.com/rust-lang/rust/pull/91476/files
2021-12-13Fix some broken links (#1274)Badel2-2/+2
2021-12-12Address review feedbackAmanieu d'Antras-0/+1
2021-12-12Stabilize asm! and global_asm!Amanieu d'Antras-1027/+1
They are also removed from the prelude as per the decision in https://github.com/rust-lang/rust/issues/87228. stdarch and compiler-builtins are updated to work with the new, stable asm! and global_asm! macros.
2021-12-11Rollup merge of #91310 - hi-rustin:rustin-patch-rustdoc, r=jyn514Matthias Krüger-2/+2
Add --out-dir flag for rustdoc part of https://github.com/rust-lang/rust/issues/91260 Add --out-dir flag for rustdoc and change the `-o` option to point to out-dir. I'm not quite sure if it should be stable, also I'm not sure if this parameter priority is appropriate? Or should I just refuse to pass both parameters at the same time? r? `@jyn514`
2021-12-09Update rustdoc internalsJacob Hoffman-Andrews-10/+121
Use current paths when discussing source files. Update cheat sheet section with download-rustc. Add "use cases" section.
2021-12-09Update HIR chapter to use `HirId` instead of `NodeId`Noah Lev-12/+7
`NodeId`s are no longer used in the HIR. See #50928 for more information.
2021-12-09Fix some broken linksNoah Lev-3/+3
2021-12-09Update src/getting-started.mdLucas Kent-1/+1
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-12-09Improve documentation on r?Lucas Kent-8/+23
2021-12-09Add unstable book entries for parts of asm that are not being stabilizedAmanieu d'Antras-0/+150
2021-12-09Rollup merge of #90796 - Amanieu:remove_reg_thumb, r=joshtriplettMatthias Krüger-5/+1
Remove the reg_thumb register class for asm! on ARM Also restricts r8-r14 from being used on Thumb1 targets as per #90736. cc ``@Lokathor`` r? ``@joshtriplett``
2021-12-08Rollup merge of #91610 - aDotInTheVoid:patch-2, r=GuillaumeGomezMatthias Krüger-1/+1
Link to rustdoc_json_types docs instead of rustdoc-json RFC The JSON format has had [many changes](https://github.com/rust-lang/rust/commits/master/src/rustdoc-json-types) since the RFC, so the rustdoc output is the only up to date reference ```@rustdoc``` modify labels: +A-rustdoc-json +A-docs
2021-12-07Remove the reg_thumb register class for asm! on ARMAmanieu d'Antras-5/+1
Also restricts r8-r14 from being used on Thumb1 targets as per #90736.
2021-12-07Auto merge of #91224 - couchand:2021-11/avr-asm, r=Amanieubors-1/+18
Support AVR for inline asm! A first pass at support for the AVR platform in inline `asm!`. Passes the initial compiler tests, have not yet done more complete verification. In particular, the register classes could use a lot more fleshing out, this draft PR so far only includes the most basic. cc `@Amanieu` `@dylanmckay`
2021-12-06Update booksEric Huss-0/+0
2021-12-06Link to rustdoc_json_types docs instead of rustdoc-json RFCNixon Enraght-Moony-1/+1
2021-12-06Implement inline asm! for AVR platformAndrew Dona-Couch-1/+18