Skip to content

add xtask doctest#2255

Merged
ehuss merged 3 commits into
rust-lang:masterfrom
tlyu:xtask-doctest
May 21, 2026
Merged

add xtask doctest#2255
ehuss merged 3 commits into
rust-lang:masterfrom
tlyu:xtask-doctest

Conversation

@tlyu
Copy link
Copy Markdown
Contributor

@tlyu tlyu commented May 4, 2026 •
edited by rustbot
Loading

Add a new xtask`` command doctestthat runsmdbook test. This ensures that rustdoc, when run from mdbook`, will use the toolchain override.

fixes #2251

@tlyu
add xtask doctest
c2ac774 
Add a new `xtask`` command `doctest` that runs `mdbook test`. This
ensures that `rustdoc`, when run from `mdbook`, will use the toolchain
override.

fixes rust-lang#2251
@rustbot rustbot added the S-waiting-on-review Status: The marked PR is awaiting review from a maintainer label May 4, 2026
ehuss
ehuss reviewed May 4, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ehuss ehuss left a comment •
edited by rustbot
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we add this, then I think we should also update the documentation to guide users towards the preferred command/workflow. So for example:

  • reference/dev-guide/src/examples.md

    Line 32 in e6b3010

    The Rust code blocks are tested in CI. You can verify that the samples pass by running [`mdbook test`].

  • reference/dev-guide/src/tests.md

    Line 6 in e6b3010

    - [`mdbook test`](#inline-tests) --- Tests the inline Rust code blocks.

  • reference/dev-guide/src/tests.md

    Lines 22 to 28 in e6b3010

    ## Inline tests
    ```sh
    mdbook test
    ```
    This command runs all tests that are inline in the Markdown. Internally, this uses [`rustdoc`](https://doc.rust-lang.org/rustdoc/) to run the tests and supports all the same features. Any code block with the `rust` language will be compiled unless it is ignored. See [Examples] for more.

View changes since this review

Comment thread tools/xtask/src/main.rs Outdated
Comment thread tools/xtask/src/main.rs Outdated
@tlyu
Copy link
Copy Markdown
Contributor Author

tlyu commented May 4, 2026

Thanks for the review! Oops, I had some edits in progress before I saw your comments. Will incorporate them soon.

@tlyu
update for review comments
ffe4cfd 
Rename the xtask command to `mdbook-test`.

Adjust documentation accordingly. Adjust `OPTIONS`` in xtask.
@tlyu
Copy link
Copy Markdown
Contributor Author

tlyu commented May 4, 2026

I think the latest revision addresses your comments. Please let me know what you think!

@tlyu
Copy link
Copy Markdown
Contributor Author

tlyu commented May 7, 2026

@rustbot label Meta "Authoring guide"

@rustbot
Copy link
Copy Markdown
Collaborator

rustbot commented May 7, 2026

Error: Label Meta can only be set by Rust team members

Please file an issue on GitHub at triagebot if there's a problem with this bot, or reach out on #triagebot on Zulip.

@tlyu
Copy link
Copy Markdown
Contributor Author

tlyu commented May 7, 2026

@rustbot label "Authoring guide"

@rustbot
Copy link
Copy Markdown
Collaborator

rustbot commented May 7, 2026

Error: Label Authoring guide can only be set by Rust team members

Please file an issue on GitHub at triagebot if there's a problem with this bot, or reach out on #triagebot on Zulip.

@tlyu
Copy link
Copy Markdown
Contributor Author

tlyu commented May 9, 2026

I think the commit messages and PR title should be adjusted to reflect the changed command name. Please let me know if you're OK with me squashing and rewording accordingly.

ehuss
ehuss approved these changes May 21, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ehuss ehuss left a comment •
edited by rustbot
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

View changes since this review

@ehuss ehuss added this pull request to the merge queue May 21, 2026
Merged via the queue into rust-lang:master with commit 5d5be50 May 21, 2026
6 checks passed
@rustbot rustbot removed the S-waiting-on-review Status: The marked PR is awaiting review from a maintainer label May 21, 2026
@rustbot rustbot mentioned this pull request Jun 1, 2026
Merged
jhpratt added a commit to jhpratt/rust that referenced this pull request Jun 2, 2026
@jhpratt
Rollup merge of rust-lang#157265 - rustbot:docs-update, r=ehuss
19ac29f 
Update books

## rust-lang/reference

10 commits in ad35aca481751a06afeb23820a672b0f3b11a476..01b0ee707f4571e803c8b2c471d8335a448f5d60
2026-05-31 18:52:24 UTC to 2026-05-20 14:06:08 UTC

- Update `naked` to use the attribute template (rust-lang/reference#1908)
- Update link_name for updated restrictions (rust-lang/reference#2268)
- parens are not optional in guard chains that have || operators (rust-lang/reference#2224)
- Document `target_has_atomic_primitive_alignment` (rust-lang/reference#2273)
- Fix grammar rules pertaining to obsolete range patterns (rust-lang/reference#2259)
- Unwrap a few remaining chapters (rust-lang/reference#2276)
- Guarantee alignment of `repr(C)` structs with no fields (rust-lang/reference#2264)
- avoid using 'place projection' for only some of the projections (rust-lang/reference#2253)
- add xtask doctest (rust-lang/reference#2255)
- Grammar: Don't allow inner attrs in certain block expressions (rust-lang/reference#2269)

## rust-lang/rust-by-example

7 commits in 898f0ac1479223d332309e0fce88d44b39927d28..d3117f6c873acbbf331c1d510371d061dfcc975c
2026-06-01 14:19:19 UTC to 2026-05-25 13:19:23 UTC

- Fix Spanish translation typos in es.po (rust-lang/rust-by-example#2018)
- Match comment module & file order (rust-lang/rust-by-example#2009)
- Fix Spanish translation typos in es.po (rust-lang/rust-by-example#2011)
- Update expression.md: renamed variable x_cube to x_cubed (rust-lang/rust-by-example#2012)
- Update comment.md - Fixed comments related to asterisk column (rust-lang/rust-by-example#2013)
- Minor typo in meta.md (rust-lang/rust-by-example#2016)
- Fix erroroneous implication (rust-lang/rust-by-example#2017)
jhpratt added a commit to jhpratt/rust that referenced this pull request Jun 2, 2026
@jhpratt
Rollup merge of rust-lang#157265 - rustbot:docs-update, r=ehuss
8b2e28f 
Update books

## rust-lang/reference

10 commits in ad35aca481751a06afeb23820a672b0f3b11a476..01b0ee707f4571e803c8b2c471d8335a448f5d60
2026-05-31 18:52:24 UTC to 2026-05-20 14:06:08 UTC

- Update `naked` to use the attribute template (rust-lang/reference#1908)
- Update link_name for updated restrictions (rust-lang/reference#2268)
- parens are not optional in guard chains that have || operators (rust-lang/reference#2224)
- Document `target_has_atomic_primitive_alignment` (rust-lang/reference#2273)
- Fix grammar rules pertaining to obsolete range patterns (rust-lang/reference#2259)
- Unwrap a few remaining chapters (rust-lang/reference#2276)
- Guarantee alignment of `repr(C)` structs with no fields (rust-lang/reference#2264)
- avoid using 'place projection' for only some of the projections (rust-lang/reference#2253)
- add xtask doctest (rust-lang/reference#2255)
- Grammar: Don't allow inner attrs in certain block expressions (rust-lang/reference#2269)

## rust-lang/rust-by-example

7 commits in 898f0ac1479223d332309e0fce88d44b39927d28..d3117f6c873acbbf331c1d510371d061dfcc975c
2026-06-01 14:19:19 UTC to 2026-05-25 13:19:23 UTC

- Fix Spanish translation typos in es.po (rust-lang/rust-by-example#2018)
- Match comment module & file order (rust-lang/rust-by-example#2009)
- Fix Spanish translation typos in es.po (rust-lang/rust-by-example#2011)
- Update expression.md: renamed variable x_cube to x_cubed (rust-lang/rust-by-example#2012)
- Update comment.md - Fixed comments related to asterisk column (rust-lang/rust-by-example#2013)
- Minor typo in meta.md (rust-lang/rust-by-example#2016)
- Fix erroroneous implication (rust-lang/rust-by-example#2017)
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Jun 2, 2026
@JonathanBrouwer
Rollup merge of rust-lang#157265 - rustbot:docs-update, r=ehuss
a8ae0b7 
Update books

## rust-lang/reference

10 commits in ad35aca481751a06afeb23820a672b0f3b11a476..01b0ee707f4571e803c8b2c471d8335a448f5d60
2026-05-31 18:52:24 UTC to 2026-05-20 14:06:08 UTC

- Update `naked` to use the attribute template (rust-lang/reference#1908)
- Update link_name for updated restrictions (rust-lang/reference#2268)
- parens are not optional in guard chains that have || operators (rust-lang/reference#2224)
- Document `target_has_atomic_primitive_alignment` (rust-lang/reference#2273)
- Fix grammar rules pertaining to obsolete range patterns (rust-lang/reference#2259)
- Unwrap a few remaining chapters (rust-lang/reference#2276)
- Guarantee alignment of `repr(C)` structs with no fields (rust-lang/reference#2264)
- avoid using 'place projection' for only some of the projections (rust-lang/reference#2253)
- add xtask doctest (rust-lang/reference#2255)
- Grammar: Don't allow inner attrs in certain block expressions (rust-lang/reference#2269)

## rust-lang/rust-by-example

7 commits in 898f0ac1479223d332309e0fce88d44b39927d28..d3117f6c873acbbf331c1d510371d061dfcc975c
2026-06-01 14:19:19 UTC to 2026-05-25 13:19:23 UTC

- Fix Spanish translation typos in es.po (rust-lang/rust-by-example#2018)
- Match comment module & file order (rust-lang/rust-by-example#2009)
- Fix Spanish translation typos in es.po (rust-lang/rust-by-example#2011)
- Update expression.md: renamed variable x_cube to x_cubed (rust-lang/rust-by-example#2012)
- Update comment.md - Fixed comments related to asterisk column (rust-lang/rust-by-example#2013)
- Minor typo in meta.md (rust-lang/rust-by-example#2016)
- Fix erroroneous implication (rust-lang/rust-by-example#2017)
rust-timer added a commit to rust-lang/rust that referenced this pull request Jun 2, 2026
@rust-timer
Unrolled build for #157265
dd61c5d 
Rollup merge of #157265 - rustbot:docs-update, r=ehuss

Update books

## rust-lang/reference

10 commits in ad35aca481751a06afeb23820a672b0f3b11a476..01b0ee707f4571e803c8b2c471d8335a448f5d60
2026-05-31 18:52:24 UTC to 2026-05-20 14:06:08 UTC

- Update `naked` to use the attribute template (rust-lang/reference#1908)
- Update link_name for updated restrictions (rust-lang/reference#2268)
- parens are not optional in guard chains that have || operators (rust-lang/reference#2224)
- Document `target_has_atomic_primitive_alignment` (rust-lang/reference#2273)
- Fix grammar rules pertaining to obsolete range patterns (rust-lang/reference#2259)
- Unwrap a few remaining chapters (rust-lang/reference#2276)
- Guarantee alignment of `repr(C)` structs with no fields (rust-lang/reference#2264)
- avoid using 'place projection' for only some of the projections (rust-lang/reference#2253)
- add xtask doctest (rust-lang/reference#2255)
- Grammar: Don't allow inner attrs in certain block expressions (rust-lang/reference#2269)

## rust-lang/rust-by-example

7 commits in 898f0ac1479223d332309e0fce88d44b39927d28..d3117f6c873acbbf331c1d510371d061dfcc975c
2026-06-01 14:19:19 UTC to 2026-05-25 13:19:23 UTC

- Fix Spanish translation typos in es.po (rust-lang/rust-by-example#2018)
- Match comment module & file order (rust-lang/rust-by-example#2009)
- Fix Spanish translation typos in es.po (rust-lang/rust-by-example#2011)
- Update expression.md: renamed variable x_cube to x_cubed (rust-lang/rust-by-example#2012)
- Update comment.md - Fixed comments related to asterisk column (rust-lang/rust-by-example#2013)
- Minor typo in meta.md (rust-lang/rust-by-example#2016)
- Fix erroroneous implication (rust-lang/rust-by-example#2017)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ehuss ehuss ehuss approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

dev-guide instructions for running tests are incomplete

3 participants

@tlyu @rustbot @ehuss