Skip to content

rustdoc: Tracking issue for command-line flag --no-capture #148116

@fmease

Description

@fmease

A command line option to prevent rustdoc from capturing the stdout/stderr output from doctests.

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

  • Implementation PR
  • Stabilization PR

Unresolved questions

  • Should we reject --no-capture if --test wasn't passed? Note that we don't so for similar flags (e.g., --test-args), so it's probably moot. We could/should however at least warn in such cases.
  • If we rename --nocapture to --no-capture (rustdoc: Rename unstable option --nocapture to --no-capture in accordance with libtest #148115), should we keep around the old version for a while in a soft-deprecated then hard-deprecated state?
  • I think the original intention was to update Cargo to use this flag instead of --test-args --no-capture / --test-args --nocapture. However the relevant PR was closed (Rustdoc nocapture cargo#9705). How should we proceed?

Implementation history

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-CLIArea: Command-line interface (CLI) to the compilerA-doctestsArea: Documentation tests, run by rustdocB-unstableBlocker: Implemented in the nightly compiler and unstable.C-tracking-issueCategory: 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.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions