Skip to content

Commit

Permalink
Unrolled build for rust-lang#130625
Browse files Browse the repository at this point in the history
Rollup merge of rust-lang#130625 - heiseish:issue-124028-fix, r=jieyouxu

Fix a few relative paths in rustc doc

## Changes

- Don't inline the doc for re-exporting some structs that have relative paths in doc.

## Context

See rust-lang#124028.

- Most of the relative links in rustdoc are there because of circular import (so syntax like `[MyType]: rustc_foo::bar` is difficult to achieve when we cannot import `rustc_xxx` due to circular import)
- Here, I disable new links for re-exports. I think it's fine for re-exported items in `hir::*`.
- There is a few more relative links in other `rustc` crates, however they are not addressed in this PR, as they are not re-exported and/so the relative paths are working.

Closes rust-lang#124028.

r​? `@fmease`

Let me know if I miss anything or there's any other way to address this issue.
  • Loading branch information
rust-timer authored Oct 10, 2024
2 parents de19f2b + ff86fa5 commit 2e3de05
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions compiler/rustc_hir/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ pub mod weak_lang_items;
#[cfg(test)]
mod tests;

#[doc(no_inline)]
pub use hir::*;
pub use hir_id::*;
pub use lang_items::{LangItem, LanguageItems};
Expand Down
1 change: 1 addition & 0 deletions compiler/rustc_index/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ mod vec;
pub use idx::Idx;
pub use rustc_index_macros::newtype_index;
pub use slice::IndexSlice;
#[doc(no_inline)]
pub use vec::IndexVec;

/// Type size assertion. The first argument is a type and the second argument is its expected size.
Expand Down

0 comments on commit 2e3de05

Please sign in to comment.