]> www.infradead.org Git - users/jedix/linux-maple.git/commit
rust: enable rustdoc's `--generate-link-to-definition`
authorMiguel Ojeda <ojeda@kernel.org>
Sun, 18 Aug 2024 14:12:49 +0000 (16:12 +0200)
committerMiguel Ojeda <ojeda@kernel.org>
Sun, 25 Aug 2024 16:37:40 +0000 (18:37 +0200)
commit6e6efc5fef4a1cdcccca3cffd5b73fd25d093352
treed66b2671e5d2fc096bee85a0d4cb13922865909f
parentb2bf463ed9a8131ad4e91a11af8c9a4ec84b876a
rust: enable rustdoc's `--generate-link-to-definition`

In Rust 1.56.0 [1], rustdoc introduced the "jump to definition"
feature [2], i.e. the unstable flag `--generate-link-to-definition`.
It adds links to the source view of the documentation.

For instance, in the source view of `rust/kernel/sync.rs`, for this code:

    impl Default for LockClassKey {
        fn default() -> Self {
            Self::new()
        }
    }

It will add three hyperlinks:

  - `Default` points to the rendered "Trait `core::default::Default`"
    page (not the source view, since it goes to another crate, though
    this may change).

  - `LockClassKey` points to the `pub struct LockClassKey(...);` line
    in the same page, highlighting the line number.

  - `Self::new()` points to the `pub const fn new() -> Self { ... }`
    associated function, highlighting its line numbers (i.e. for the
    full function).

This makes the source view more useful and a bit closer to the experience
in e.g. the Elixir Cross Referencer [3].

I have provisionally enabled it for rust.docs.kernel.org [4] -- one can
take a look at the source view there for an example of how it looks like.

Thus enable it.

Cc: Guillaume Gomez <guillaume1.gomez@gmail.com>
Link: https://github.com/rust-lang/rust/pull/84176
Link: https://github.com/rust-lang/rust/issues/89095
Link: https://elixir.bootlin.com
Link: https://rust.docs.kernel.org
Reviewed-by: Gary Guo <gary@garyguo.net>
Link: https://lore.kernel.org/r/20240818141249.387166-1-ojeda@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
rust/Makefile