Commit Graph

38 Commits

Author SHA1 Message Date
León Orell Valerian Liehr b80083b5c0 Update rustdoc build instructions 2024-09-24 20:47:22 +02:00
Michael Howell 6bf7f54861 Clean up misleading language 2024-09-15 14:53:28 -04:00
Michael Howell 953292a349 Add docs for JS tests 2024-09-15 14:53:28 -04:00
onur-ozkan 06ca6d1e6e use "bootstrap" instead of "rustbuild"
Let's stick with the single name "bootstrap" to refer to the bootstrap project to avoid confusion.

Signed-off-by: onur-ozkan <work@onurozkan.dev>
2024-07-06 23:28:20 +02:00
sslime336 e2487ebdc4 Change `x.py` into `x`, add explanation for `x` 2023-06-30 23:11:14 +02:00
sslime336 a04ad82e3c Change `./x.py` into `./x` 2023-06-30 23:11:14 +02:00
Joshua Nelson 1fd8ddbdc2 add a few more TOC sections 2023-04-03 06:42:31 -05:00
Albert Larsan d4ec98736e Change `src/test` to `tests` (#1547) 2023-01-13 07:31:47 +09:00
Joshua Nelson bd26e3aae5 Replace `$TARGET` with `host`
This avoids having to manually modify the configuration in the docs.
2022-12-31 18:23:52 -06:00
Joshument 14d6444fe5 fix typo and make paragraph consistent (#1474) 2022-10-03 19:38:52 +09:00
Joshua Nelson d7ead280b4 Update the build instructions for the standard library
Since https://github.com/rust-lang/rust/pull/95503, `library/std` means
"build just std and its dependencies"; to get the old behavior that built
`proc_macro` and `test`, you need `x build library`.

- Update `library/std` to `library`
- Remove the `-i` suggestions; `incremental = true` is already the default for most profiles, in
  which case `-i` does nothing. If you don't have incremental enabled, I still think suggesting `-i`
  is bad idea, because it's easy to forget once, at which point you'll end up rebuilding the whole
  compiler / standard library.
- Remove a few repetitive sections and don't discuss incremental in such detail
  Incremental works well enough that it should "just work" for most people;
  I don't think it needs multiple paragraphs of explanation so early in the guide.
- Clarify that `test library/std` *only* tests libstd in a few places
2022-07-11 07:22:24 +02:00
Nicholas Nethercote 08019e25d1 Address more review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote 940fbb5f7a Address review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote e3512c8cd8 Streamline "Getting Started" some more.
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-05 23:26:43 -06:00
Jacob Hoffman-Andrews ddccb87b0d Update rustdoc internals
Use current paths when discussing source files.
Update cheat sheet section with download-rustc.
Add "use cases" section.
2021-12-09 16:05:48 -06:00
Justus K da1c7b423c Remove `--stage 1` argument from `doc` invocations (#1125) 2021-05-18 19:10:39 +02:00
二手掉包工程师 98c50aacd2 Fix rustdocs test command typo (#1103) 2021-04-04 01:41:35 +09:00
Yuki Okushi 3a25c80892 Fix a link about Rustdoc internals 2021-04-02 05:25:14 -04:00
Camelid a959fee323 Cleanup rustdoc chapters a bit
* Rename "The walking tour of rustdoc" to "Rustdoc overview",
  which I think is a more accurate name
* Use same name in sidebar TOC as in chapter text
* Make links between the two chapters prominent
* Convert a few `.html` links to `.md`

Probably we should just merge the chapters, but leaving that for later.
2021-02-28 16:35:20 -05:00
Joshua Nelson 903f6277f4 Link to the Rustdoc book in the rustdoc chapter (#981)
This makes a) makes it easier to find info about rustdoc's features and
b) redirects people in the wrong place to where they should be looking.
2020-12-04 18:23:46 +01:00
Yuki Okushi 68a2b034c5 Rename `src/libstd` to `library/std` etc. (#815) 2020-07-30 22:47:22 +09:00
Joshua Nelson 879ca582de Update docs to match the new x.py defaults (#813) 2020-07-29 04:20:00 +09:00
Joshua Nelson 541f88e8dd Move x.py commands to overview 2020-06-23 17:40:16 -05:00
Joshua Nelson bf38f1b6f8 Split up rustdoc page 2020-06-23 17:40:16 -05:00
Joshua Nelson 7e3da5c2ee Document rustdoc behavior
- `RUSTDOC_LOG`
- `// aux-build:filename.rs`
- `// build-aux-docs`
2020-06-17 09:24:41 -05:00
Yuki Okushi 078820613f Fix links and paths 2020-01-10 13:12:39 -05:00
Who? Me?! 9f20c802b7 Revert "website has disappeared"
This reverts commit 0930e773f1.
2019-11-26 21:00:47 -06:00
Mark Mansi 4b391fa7fd website has disappeared 2019-11-26 17:05:11 -06:00
Philipp Hansch 32abc8af93 Fix typos
These were fixed using [codespell](https://github.com/codespell-project/codespell).
2018-09-12 07:32:18 +02:00
Zack M. Davis 2a82c7666d don't mention new rustdoc
Steve says it's not ready
(https://github.com/rust-lang-nursery/rustc-guide/pull/150#issuecomment-395783504).
2018-06-25 21:18:50 -05:00
Zack M. Davis e39c13d458 include `./` in example x.py commands for smoother copy-paste experience
The current directory is typically not on the user's $PATH.
2018-06-25 21:18:50 -05:00
varkor ad35712ddc Consolidate and fix code blocks 2018-04-06 14:18:08 -05:00
Philip Munksgaard 7a3cf36d65 Fix typo in rustdoc.md 2018-04-03 10:15:57 -05:00
Mark Mansi 22d5d6e212 reformat basically the whole rustdoc.md 2018-03-26 20:28:00 -05:00
Who? Me?! 80fa5ad68d Updated parenthetical 2018-03-15 15:00:10 -05:00
Mark Mansi 474bdb566c address review comments 2018-03-15 15:00:10 -05:00
Mark Mansi 4026b02fc8 Address review comments 2018-03-15 15:00:10 -05:00
Mark Mansi 5d70b9aae5 Add the rustdoc readme 2018-03-15 15:00:10 -05:00