rust-lang / rust-lang/rust

clean up and unify logic used by `rustdoc-js` and `rustdoc-js-std` test suites.

Open
#135,597 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-cleanup T-bootstrap T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

I cannot find the code that actually runs rustdoc on the rustdoc-js/*.rs files, and for some unknown reason, that code is not actually getting run (leading to issues about search-index.js not being found).

This code is quite a mess, rustdoc-js-std seems to be mostly implemented in bootstrap, while rustdoc-js is mostly implemented in compiletest.

This discrepancy leads to an ever increasing number of discrepancies between the exact behavior of the two test suites. Rather than trying to patch these up one by one, I would rather we take a big picture approach.

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 locating the code that runs rustdoc for the rustdoc-js/*.rs files, then compare the rustdoc-js and rustdoc-js-std test-suite implementations in compiletest and bootstrap. Investigate why search-index.js is not found and map the behavioral discrepancies. Done means the two suites use unified logic rather than accumulating separate fixes.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, compilers, testing-qa
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.