f5e1a73fb5
rustdoc: Further improve chapters and sections on testing
2025-06-07 18:35:40 +02:00
655367d8b8
Fix some old `// <directive>` to `//@ <directive>`
2025-05-28 20:32:56 +01:00
374f53e02b
Fix minor typo in rustdoc-internals.md
2025-05-09 15:50:49 +03:00
cbd5436e1d
Fix rustc-related links that are 404 right now ( #2112 )
2024-11-02 20:53:31 +08:00
2f7e0ceb36
Update rustdoc-internals.md ( #1911 )
...
* Update rustdoc-internals.md
Minor updates to syntax and some clarifications.
* updates
* Update rustdoc-internals.md
2024-03-13 18:56:14 -03:00
384ac6ebbb
update internal terminology: Substs -> GenericArgs
2023-08-21 07:28:56 +02:00
a04ad82e3c
Change `./x.py` into `./x`
2023-06-30 23:11:14 +02:00
1b6f93987d
Fix some links
2023-06-29 06:43:19 +02:00
82a5c6d47b
alert when date gets stale (by using date-check annotation)
2023-03-14 05:50:20 +02:00
1ffcb23bbc
fix date-check annotation some more
2023-03-14 05:50:20 +02:00
fa092136c0
fix date-check annotation
2023-03-14 05:50:20 +02:00
ea585370c8
typo
2023-03-14 05:50:20 +02:00
ba285c2370
Update rustdoc-internals.md
2023-03-14 05:50:20 +02:00
d4ec98736e
Change `src/test` to `tests` ( #1547 )
2023-01-13 07:31:47 +09:00
010ab13460
Triage some date-check items ( #1513 )
2022-11-26 22:25:58 +09:00
8194045511
make date-check more lightweight ( #1394 )
...
* make date-check lightweight
This avoids having to write the date twice when updating date-check.
Before "As of <-- 2022-07 --> July 2022"
After "As of July 2022"
* please clippy
* update date-check docs
* accept review suggestion
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
* address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1394#pullrequestreview-1042163557
* accept review suggestion
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
* address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1394#pullrequestreview-1042167261
* address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1394#issuecomment-1189105017
* this breaks markdown
* address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018268
This led to a more robust regex, though making the tool more picky.
It also found a wrong date format that was missed.
* address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018419
* address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018816
* accept review suggestion
This was reverted by mistake
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
* address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934019395
* use a more simple fn
* address review comment
https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018981
Much more clean
* nit
* accept review suggestion
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
* avoid a failed regex
Also, test new shape
* adjust to new regex (which uses named groups)
New regex was introduced by 456008cc35
2022-08-02 13:50:32 -07:00
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
de938b00e2
Cleanup rustdoc-internals
2022-05-24 17:15:35 -07:00
924c1fa136
Move date-check comment to fix Markdown syntax
...
The inline code wasn't being rendered correctly.
2021-12-15 11:59:46 -08:00
b1f655d972
Update some date-check comments
...
I removed one of them because it doesn't seem necessary.
2021-11-04 09:33:03 -07:00
81201b80eb
Update some docs from 2021-10 date triage ( #1224 )
2021-10-05 17:24:24 -03:00
d789b1c701
Trailing date comments in a line inside of a paragraph caused beginning of a new paragraph. ( #1196 )
...
This PR fixes the 2 occurrences of that.
(I'm not sure if there's an underlying issue with mdbook or if this is working as intended.)
2021-08-28 08:26:16 -03:00
c98c707872
Fix a code block containing ```rust
...
This wasn't displayed correctly.
Changing `` ```rust `` to `` ```rust`` made it a code block again,
but the leading space was rendered as-well.
(This may be an issue in mdbook, but I'm not sure.)
This commit changes it to use HTML-syntax in order to get the desired result.
2021-08-27 15:13:38 -05:00
da1c7b423c
Remove `--stage 1` argument from `doc` invocations ( #1125 )
2021-05-18 19:10:39 +02:00
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
9539f6c271
Fix formatting of more date references ( #1067 )
2021-02-22 18:22:23 +09:00
7f5a39d318
Update docs from date triage for 2021-02 ( #1048 )
...
The biggest change was updating the list of rustdoc passes. Several new
ones have been added since that documentation was written, so I added
those, and I also sorted the list so it is roughly alphabetical (except
for the part for the `strip-*` passes, which I left in the same order
since one of the list items has two passes so there's no "correct"
order).
2021-02-20 19:27:24 -08:00
6e02970f7f
Add lots of date-check annotations
...
Also added dates for things that previously said "as of now" or "as of
this writing" and cleaned up a couple of things along the way.
2021-02-03 19:29:07 -05:00
7a80b01e01
Add mdbook-toc, markers, and documentation ( #1028 )
...
* Add mdbook-toc to travis, book.toml and documentation
* Add toc markers
* Whitespace cleanup and some punctuation
* Addressed comments
2021-01-20 14:33:11 -03:00
b2d6a16e58
Fix typo ( #1027 )
2021-01-17 11:50:04 -03:00
a801509b43
All links to rustdoc-internals.md
2020-12-10 14:51:04 -05:00
4b00bfb892
Links to htmldocck/@has/matches for searchability
2020-11-11 19:02:37 -05:00
ee849ff66e
Revert "Remove outdated build rustdoc --stage 1"
...
This reverts commit cd35d2b594
2020-10-19 23:17:17 -04:00
e4a7be5779
Remove outdated build rustdoc --stage 1
...
It builds with stage 1 by default.
2020-10-19 22:23:59 -04:00
a49fce9a12
Add new section to have a local HTTP server easily ( #833 )
2020-08-23 14:36:45 +02:00
68a2b034c5
Rename `src/libstd` to `library/std` etc. ( #815 )
2020-07-30 22:47:22 +09:00
541f88e8dd
Move x.py commands to overview
2020-06-23 17:40:16 -05:00
bf38f1b6f8
Split up rustdoc page
2020-06-23 17:40:16 -05:00
León Orell Valerian Liehr
Alona Enraght-Moony
Stan Manilov
Martin Liška
Tbkhi
yukang
sslime336
Eric Huss
Tshepang Mbambo
Michael Howell
Albert Larsan
Noah Lev
Joshua Nelson
Yuki Okushi
Frank Steffahn
Justus K
Iñaki Garay
Martin Geisler
Nixon Enraght-Moony
Alexis Bourget
Joshua Nelson
Ivan Tham
Guillaume Gomez
Yuki Okushi
Joshua Nelson