Rustdoc: include crate name in links for local primitives

[gurry]

Fixes #121106.

This change makes links to primitives easier to use when the path of the page where they will be embedded is not known beforehand such as when we generate impls dynamically from the register_type_impls method in main.js, which is exactly what is happening in #121106.

An example to show the effect of this change: earlier, if the current page in cx.current inside primitive_link_fragment() was std::simd::prelude::Simd the generated path would be ../../primitive.<prim>.html. Now it would be ../../../std/primitive.<prim>.html instead.

A side effect of the change is that local primitive links everywhere will now contain the crate name, even outside of the dynamic situation mentioned above. I'm not sure if there are any major downsides of that other than making the links a bit longer. Ideally I wanted to restrict this behaviour change to only the dynamic cases. We could have achieved that by passing an additional bool arg to primitive_link_fragment(), but it felt awkward to do so. Any alternative suggestions are welcome.

[rustbot]

r? @fmease

rustbot has assigned @fmease.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

[gurry]

cc @notriddle

[notriddle]

Ideally I wanted to restrict this behaviour change to only the dynamic cases.

To avoid making the regular standard library docs bigger, could this be done based on when cx.current.len() == 0?

match m.primitive_locations.get(&prim) {
    Some(&def_id) if def_id.is_local() && cx.current.is_empty() => {
        write!(
            f,
            "<a class=\"primitive\" href=\"{}/primitive.{}.html{fragment}\">",
            ExternalCrate { crate_num: def_id.krate }.name(cx.tcx()),
            prim.as_sym()
        )?;
        needs_termination = true;
    }
    Some(&def_id) if def_id.is_local() => {
        write!(
            f,
            "<a class=\"primitive\" href=\"{}primitive.{}.html{fragment}\">",
            "../".repeat(cx.current.len() - 1),
            prim.as_sym()
        )?;
        needs_termination = true;
    }

[gurry]

Ideally I wanted to restrict this behaviour change to only the dynamic cases.

To avoid making the regular standard library docs bigger, could this be done based on when cx.current.len() == 0?

match m.primitive_locations.get(&prim) {
    Some(&def_id) if def_id.is_local() && cx.current.is_empty() => {
        write!(
            f,
            "<a class=\"primitive\" href=\"{}/primitive.{}.html{fragment}\">",
            ExternalCrate { crate_num: def_id.krate }.name(cx.tcx()),
            prim.as_sym()
        )?;
        needs_termination = true;
    }
    Some(&def_id) if def_id.is_local() => {
        write!(
            f,
            "<a class=\"primitive\" href=\"{}primitive.{}.html{fragment}\">",
            "../".repeat(cx.current.len() - 1),
            prim.as_sym()
        )?;
        needs_termination = true;
    }

Thanks for the suggestion. I'll make the change.

[gurry]

Thanks for the suggestion. I'll make the change.

Done

[notriddle]

@bors r+ rollup

[bors]

📌 Commit e0bfa5c has been approved by notriddle

It is now in the queue for this repository.

[bors]

🌲 The tree is currently closed for pull requests below priority 50. This pull request will be tested once the tree is reopened.