Skip to content

rustdoc: Don't mark #[target_feature] functions as ⚠ #142977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/librustdoc/html/render/print_item.rs
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,8 @@ fn item_module(cx: &Context<'_>, item: &clean::Item, items: &[clean::Item]) -> i

let unsafety_flag = match myitem.kind {
clean::FunctionItem(_) | clean::ForeignFunctionItem(..)
if myitem.fn_header(tcx).unwrap().is_unsafe() =>
if myitem.fn_header(tcx).unwrap().safety
== hir::HeaderSafety::Normal(hir::Safety::Unsafe) =>
{
"<sup title=\"unsafe function\">⚠</sup>"
}
Expand Down
38 changes: 38 additions & 0 deletions tests/rustdoc/target-feature.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
#![crate_name = "foo"]

//@ has 'foo/index.html'

//@ has - '//dl[@class="item-table"]/dt[1]//a' 'f1_safe'
//@ has - '//dl[@class="item-table"]/dt[1]//code' 'popcnt'
//@ count - '//dl[@class="item-table"]/dt[1]//sup' 0
//@ has - '//dl[@class="item-table"]/dt[2]//a' 'f2_not_safe'
//@ has - '//dl[@class="item-table"]/dt[2]//code' 'avx2'
//@ count - '//dl[@class="item-table"]/dt[2]//sup' 1
//@ has - '//dl[@class="item-table"]/dt[2]//sup' '⚠'

#[target_feature(enable = "popcnt")]
//@ has 'foo/fn.f1_safe.html'
//@ matches - '//pre[@class="rust item-decl"]' '^pub fn f1_safe'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test needs to use matches instead of has to catch check if there was a attribute printed before the function, e.g. to test for #142876 (comment)

//@ has - '//*[@id="main-content"]/*[@class="item-info"]/*[@class="stab portability"]' \
// 'Available with target feature popcnt only.'
pub fn f1_safe() {}

//@ has 'foo/fn.f2_not_safe.html'
//@ matches - '//pre[@class="rust item-decl"]' '^pub unsafe fn f2_not_safe()'
//@ has - '//*[@id="main-content"]/*[@class="item-info"]/*[@class="stab portability"]' \
// 'Available with target feature avx2 only.'
#[target_feature(enable = "avx2")]
pub unsafe fn f2_not_safe() {}

//@ has 'foo/fn.f3_multifeatures_in_attr.html'
//@ has - '//*[@id="main-content"]/*[@class="item-info"]/*[@class="stab portability"]' \
// 'Available on target features popcnt and avx2 only.'
#[target_feature(enable = "popcnt", enable = "avx2")]
pub fn f3_multifeatures_in_attr() {}

//@ has 'foo/fn.f4_multi_attrs.html'
//@ has - '//*[@id="main-content"]/*[@class="item-info"]/*[@class="stab portability"]' \
// 'Available on target features popcnt and avx2 only.'
#[target_feature(enable = "popcnt")]
#[target_feature(enable = "avx2")]
pub fn f4_multi_attrs() {}
Loading