rustdoc: Tracking issue for --no-run · Issue #87022 · rust-lang/rust (original) (raw)

About tracking issues

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 about a feature.
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.

Steps

• Add the flag (added --no-run option for rustdoc #83857)
• Update libtest not to say "ok" for tests which aren't run (added --no-run option for rustdoc #83857 (comment))
• Fix the flag to actually work (rustdoc --test --preserve-doctests --no-run produces empty non-executable files #88110)
• Adjust documentation (see instructions on rustc-dev-guide) - rustdoc's documentation lives in src/doc/rustdoc.
• Stabilization PR (see instructions on rustc-dev-guide)

Unresolved Questions

• Is --no-run the right name?

Implementation history

• Initial implementation (added --no-run option for rustdoc #83857) 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-targets or cargo 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-run also doesn't compile the doc tests.

Maybe we need a cargo test --sligtly-run-doctests?