(rustdoc) [src] link for types defined by macros shows invocation, not defintion

[liketechnik]

Previously the [src] link on types defined by a macro pointed to the macro definition.

This pr makes the Clean-Implementation for Spans aware of macro defined types, so that the link points to the invocation instead.

I'm not totally sure if it's okay to add the 'macro awareness' in the Clean-Implementation, because it erases that knowledge for all following code. Maybe it would be more sensible to add the check only for the link generation at

rust/src/librustdoc/html/render/mod.rs

Line 1619 in 25f6938

fn src_href(&self, item: &clean::Item, cache: &Cache) -> Option<String> {

Closes #39726.

[rust-highfive]

r? @GuillaumeGomez

(rust_highfive has picked a reviewer for you, use r? to override)

[GuillaumeGomez]

I'm not totally sure if it's okay to add the 'macro awareness' in the Clean-Implementation, because it erases that knowledge for all following code.

I don't see why not? :)

[jyn514]

Could you also add some tests for the new behavior? They'd go in src/test/rustdoc; there's examples there and instructions in https://rustc-dev-guide.rust-lang.org/rustdoc-internals.html#dotting-is-and-crossing-ts.

[jyn514]

Actually, it looks like just updating the existing tests should be enough:

---- [rustdoc] rustdoc/external-macro-src.rs stdout ----
------------------------------------------
12: @has check failed
	`XPATH PATTERN` did not match
	// @has - '//a[@href="https://example.com/src/external_macro_src/external-macro-src.rs.html#8"]' '[src]'
13: @has check failed
	`XPATH PATTERN` did not match
	// @has - '//a[@href="https://example.com/src/external_macro_src/external-macro-src.rs.html#9-13"]' '[src]'
14: @has check failed
	`XPATH PATTERN` did not match
	// @has - '//a[@href="https://example.com/src/external_macro_src/external-macro-src.rs.html#10-12"]' '[src]'

Encountered 3 errors

------------------------------------------


---- [rustdoc] rustdoc/issue-26606.rs stdout ----

error: htmldocck failed!
status: exit code: 1
command: "/usr/bin/python2.7" "/checkout/src/etc/htmldocck.py" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc/issue-26606" "/checkout/src/test/rustdoc/issue-26606.rs"
stdout:
------------------------------------------

------------------------------------------
stderr:
------------------------------------------
10: @has check failed
	`XPATH PATTERN` did not match
	// @has - '//a/@href' '../src/issue_26606_macro/issue-26606-macro.rs.html#3'

Encountered 1 errors

------------------------------------------


---- [rustdoc] rustdoc/thread-local-src.rs stdout ----

error: htmldocck failed!
status: exit code: 1
command: "/usr/bin/python2.7" "/checkout/src/etc/htmldocck.py" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc/thread-local-src" "/checkout/src/test/rustdoc/thread-local-src.rs"
stdout:
------------------------------------------

------------------------------------------
stderr:
------------------------------------------
5: @has check failed
	`XPATH PATTERN` did not match
	// @has foo/constant.FOO.html '//a/@href' 'https://doc.rust-lang.org/nightly/src/std/'

Encountered 1 errors

------------------------------------------



failures:
    [rustdoc] rustdoc/external-macro-src.rs
    [rustdoc] rustdoc/issue-26606.rs
    [rustdoc] rustdoc/thread-local-src.rs

[jyn514]

@bors r+

Thanks for working on this! I actually wanted this just tonight while looking at documentation :)

[bors]

📌 Commit 7beb0da has been approved by jyn514