rust-lang / rust-lang/rust

rustdoc does not forward lint settings to the doctest builds

Open
#142,149 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-doctests A-lints C-enhancement needs-fcp T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

TIL that while a bunch of flags are forwarded to doctests builds (including --cfg and --check-cfg), this is not true for --cap-lints as well as -A/-D and the other lint flags. This caught me by surprise when I tried to suppress a deny(warnings) in a doctest. See Zulip for the surrounding discussion.

Would it make sense to also forward the lint flags to the test build? That would seem to make things more consistent.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how rustdoc forwards --cfg and --check-cfg into doctest builds, then compare that path with --cap-lints and the -A/-D lint flags described in the issue. Review the linked Zulip discussion for context. Done means the relevant lint settings are forwarded consistently and the doctest behavior is covered by validation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.