rust-lang / rust-lang/mdBook

mdbook@0.4.40 ignores rust-toolchain when running rustdoc

Open
#2,501 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

C-bug
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

mdbook@0.4.40 ignores rust-toolchain when running rustdoc.

This is problematic when running mdbook test -L PATH where PATH contains compiled crates -- likely compiled in a way that doesn't ignore rust-toolchain.

mdbook@0.4.37 is still fine.

Steps

Let me know if you need actual repro steps. I used our own repository. See the CI runs on the commits of https://github.com/linera-io/linera-documentation/pull/171

Possible Solution(s)

No response

Notes

No response

Version

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 reproducing mdbook test -L PATH with mdBook 0.4.37 and 0.4.40, using the linked CI runs as reference, and trace the rustdoc invocation. Done means the current version respects rust-toolchain when running rustdoc, with a regression test covering compiled crates in PATH.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.