-
-
Notifications
You must be signed in to change notification settings - Fork 14.8k
rustdoc: Tracking issue for command-line flag --no-run #87022
Copy link
Copy link
Open
Labels
A-CLIArea: Command-line interface (CLI) to the compilerArea: Command-line interface (CLI) to the compilerA-doctestsArea: Documentation tests, run by rustdocArea: Documentation tests, run by rustdocB-unstableBlocker: Implemented in the nightly compiler and unstable.Blocker: Implemented in the nightly compiler and unstable.C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCS-tracking-needs-summaryStatus: It's hard to tell what's been done and what hasn't! Someone should do some investigation.Status: It's hard to tell what's been done and what hasn't! Someone should do some investigation.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Description
Metadata
Metadata
Assignees
Labels
A-CLIArea: Command-line interface (CLI) to the compilerArea: Command-line interface (CLI) to the compilerA-doctestsArea: Documentation tests, run by rustdocArea: Documentation tests, run by rustdocB-unstableBlocker: Implemented in the nightly compiler and unstable.Blocker: Implemented in the nightly compiler and unstable.C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCS-tracking-needs-summaryStatus: It's hard to tell what's been done and what hasn't! Someone should do some investigation.Status: It's hard to tell what's been done and what hasn't! Someone should do some investigation.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Projects
Status
No status
Note
Tracking issues are used to record the overall progress of implementation.
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
A tracking issue is however not meant for large scale discussion, questions, or bug reports.
Instead, open a dedicated issue for the specific matter or post in the #t-rustdoc Zulip channel.
Discussion comments will get marked as off-topic or deleted.
Repeated discussions on the tracking issue may lead to the tracking issue getting locked.
Steps
rustdoc --test --preserve-doctests --no-runproduces empty non-executable files #88110)src/doc/rustdoc.Unresolved Questions
--no-runthe right name?Implementation history
original issue text
The cargo issue here rust-lang/cargo#6424 points out that we don't have a tracking issue on the librustdoc side for how we can make doc examples compile when we run
cargo check --all-targetsorcargo build --all-targets. By hook or by crook it would be great to remove this surprising edge case.Also probably even more surprising
cargo test --no-runalso doesn't compile the doc tests.Maybe we need a
cargo test --sligtly-run-doctests?