rust-lang / rust-lang/rust

rustdoc source tests fail when remap-debuginfo is enabled

Open
#150,287 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-testsuite C-bug T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Code

#![crate_name = "foo"]

// This test ensures that the [src] link is present on traits items.

//@ has foo/trait.Iterator.html '//*[@id="method.zip"]//a[@class="src"]' "Source"
pub use std::iter::Iterator;

Reproduction Steps

./x t --stage 1 tests/rustdoc/{source-code-pages/src-links-auto-impls.rs,ensure-src-link.rs}

Expected Outcome

Test should pass.

Actual Output

failures:

---- [rustdoc] tests/rustdoc/source-code-pages/src-links-auto-impls.rs stdout ----
------python3.13 stdout------------------------------

------python3.13 stderr------------------------------
9: has check failed
        `XPATH PATTERN` did not match
        //@ has - '//*[@id="impl-Any-for-T"]//a[@class="src rightside"]' 'Source'

Encountered 1 errors

---- [rustdoc] tests/rustdoc/ensure-src-link.rs stdout ----
------python3.13 stdout------------------------------

------python3.13 stderr------------------------------
5: has check failed
	`XPATH PATTERN` did not match
	//@ has foo/trait.Iterator.html '//*[@id="method.zip"]//a[@class="src"]' "Source"

Encountered 1 errors
Image

Version

cec70080fd441d16e9fb08a0d1d1a04c72d1ed25

Additional Details

bootstrap.toml:

profile = "compiler"
change-id = "ignore"

[build]
profiler = true
description = "by Ferrous Systems"

[llvm]
download-ci-llvm = true

[rust]
remap-debuginfo = true
channel = "beta"
lld = true
deny-warnings = false
debug-assertions = true
debug-assertions-std = true
new-symbol-mangling = true

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 running the reproduced command against tests/rustdoc/{source-code-pages/src-links-auto-impls.rs,ensure-src-link.rs} with remap-debuginfo enabled in bootstrap.toml. Inspect the failing source-link checks and generated rustdoc output; done means both tests pass under that configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.