rustdoc is responsible for both compiling doc examples and executing them as tests. Cargo current has no way to control the behavior. There are a handful of issues around this:

Doctests are not cached and always recompile
- Running doc tests are slow due to being always being recompiled cargo#2944
Doctests generate a binary per test, causing a lot of extra linking
- Rustdoc should run all doctests in one binary rust#75341
- cargo test renders device unresponsive due to MSVC linker RAM usage cargo#12916
Doctests are treated separately and often forgot to test
- cargo test --all-targets does not run doc tests cargo#6669
Compiling and running doc examples require different set of shared libs
- cargo test --doc not load same shared libraries as cargo test --lib cargo#8531
Configurations in Cargo are not respected
- target.runner — RUSTC, RUSTC_WRAPPER are not respected for doctests cargo#12532
- codegen options — Doctests do not set profile codegen options cargo#6570
Doctests don't work on bin's, non-pub items
- Doctests don't work in bin targets, non-public items rust#50784

Bonus

Warnings/clippy on doctests
- Oh rust doctest lints, where art þou? (Add a way to run clippy on doctests) rust#56232

I propose to the team to looking into the possibility for rustdoc to delegate test executions to Cargo.

Uh oh!

doctests #5

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions