Skip to content

[rustdoc] Display unsafe attrs with edition 2024 unsafe() wrappers. #143662

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
6 changes: 3 additions & 3 deletions src/librustdoc/clean/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -767,15 +767,15 @@ impl Item {
.iter()
.filter_map(|attr| {
if let hir::Attribute::Parsed(AttributeKind::LinkSection { name, .. }) = attr {
Some(format!("#[link_section = \"{name}\"]"))
Some(format!("#[unsafe(link_section = \"{name}\")]"))
}
// NoMangle is special cased, as it appears in HTML output, and we want to show it in source form, not HIR printing.
// It is also used by cargo-semver-checks.
else if let hir::Attribute::Parsed(AttributeKind::NoMangle(..)) = attr {
Some("#[no_mangle]".to_string())
Some("#[unsafe(no_mangle)]".to_string())
} else if let hir::Attribute::Parsed(AttributeKind::ExportName { name, .. }) = attr
{
Some(format!("#[export_name = \"{name}\"]"))
Some(format!("#[unsafe(export_name = \"{name}\")]"))
} else if let hir::Attribute::Parsed(AttributeKind::NonExhaustive(..)) = attr {
Some("#[non_exhaustive]".to_string())
} else if is_json {
Expand Down
4 changes: 2 additions & 2 deletions src/rustdoc-json-types/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ pub type FxHashMap<K, V> = HashMap<K, V>; // re-export for use in src/librustdoc
// will instead cause conflicts. See #94591 for more. (This paragraph and the "Latest feature" line
// are deliberately not in a doc comment, because they need not be in public docs.)
//
// Latest feature: Pretty printing of no_mangle attributes changed
pub const FORMAT_VERSION: u32 = 53;
// Latest feature: Added edition 2024 style `unsafe()` wrappers around attrs
pub const FORMAT_VERSION: u32 = 54;

/// The root of the emitted JSON blob.
///
Expand Down
2 changes: 1 addition & 1 deletion tests/rustdoc-json/attrs/export_name_2021.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//@ edition: 2021
#![no_std]

//@ is "$.index[?(@.name=='example')].attrs" '["#[export_name = \"altered\"]"]'
//@ is "$.index[?(@.name=='example')].attrs" '["#[unsafe(export_name = \"altered\")]"]'
#[export_name = "altered"]
pub extern "C" fn example() {}
5 changes: 1 addition & 4 deletions tests/rustdoc-json/attrs/export_name_2024.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
//@ edition: 2024
#![no_std]

// The representation of `#[unsafe(export_name = ..)]` in rustdoc in edition 2024
// is still `#[export_name = ..]` without the `unsafe` attribute wrapper.

//@ is "$.index[?(@.name=='example')].attrs" '["#[export_name = \"altered\"]"]'
//@ is "$.index[?(@.name=='example')].attrs" '["#[unsafe(export_name = \"altered\")]"]'
#[unsafe(export_name = "altered")]
pub extern "C" fn example() {}
2 changes: 1 addition & 1 deletion tests/rustdoc-json/attrs/link_section_2021.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//@ edition: 2021
#![no_std]

//@ is "$.index[?(@.name=='example')].attrs" '["#[link_section = \".text\"]"]'
//@ is "$.index[?(@.name=='example')].attrs" '["#[unsafe(link_section = \".text\")]"]'
#[link_section = ".text"]
pub extern "C" fn example() {}
5 changes: 1 addition & 4 deletions tests/rustdoc-json/attrs/link_section_2024.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
//@ edition: 2024
#![no_std]

// Since the 2024 edition the link_section attribute must use the unsafe qualification.
// However, the unsafe qualification is not shown by rustdoc.

//@ is "$.index[?(@.name=='example')].attrs" '["#[link_section = \".text\"]"]'
//@ is "$.index[?(@.name=='example')].attrs" '["#[unsafe(link_section = \".text\")]"]'
#[unsafe(link_section = ".text")]
pub extern "C" fn example() {}
2 changes: 1 addition & 1 deletion tests/rustdoc-json/attrs/no_mangle_2021.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//@ edition: 2021
#![no_std]

//@ is "$.index[?(@.name=='example')].attrs" '["#[no_mangle]"]'
//@ is "$.index[?(@.name=='example')].attrs" '["#[unsafe(no_mangle)]"]'
#[no_mangle]
pub extern "C" fn example() {}
5 changes: 1 addition & 4 deletions tests/rustdoc-json/attrs/no_mangle_2024.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
//@ edition: 2024
#![no_std]

// The representation of `#[unsafe(no_mangle)]` in rustdoc in edition 2024
// is still `#[no_mangle]` without the `unsafe` attribute wrapper.

//@ is "$.index[?(@.name=='example')].attrs" '["#[no_mangle]"]'
//@ is "$.index[?(@.name=='example')].attrs" '["#[unsafe(no_mangle)]"]'
#[unsafe(no_mangle)]
pub extern "C" fn example() {}
6 changes: 3 additions & 3 deletions tests/rustdoc/attribute-rendering.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#![crate_name = "foo"]

//@ has 'foo/fn.f.html'
//@ has - //*[@'class="rust item-decl"]' '#[export_name = "f"] pub fn f()'
#[export_name = "\
f"]
//@ has - //*[@'class="rust item-decl"]' '#[unsafe(export_name = "f")] pub fn f()'
#[unsafe(export_name = "\
f")]
pub fn f() {}
14 changes: 14 additions & 0 deletions tests/rustdoc/attributes-2021-edition.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
//@ edition: 2021
#![crate_name = "foo"]

//@ has foo/fn.f.html '//pre[@class="rust item-decl"]' '#[unsafe(no_mangle)]'
#[no_mangle]
pub extern "C" fn f() {}

//@ has foo/fn.g.html '//pre[@class="rust item-decl"]' '#[unsafe(export_name = "bar")]'
#[export_name = "bar"]
pub extern "C" fn g() {}

//@ has foo/fn.example.html '//pre[@class="rust item-decl"]' '#[unsafe(link_section = ".text")]'
#[link_section = ".text"]
pub extern "C" fn example() {}
13 changes: 13 additions & 0 deletions tests/rustdoc/attributes-re-export-2021-edition.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// Tests that attributes are correctly copied onto a re-exported item.
//@ edition:2024
#![crate_name = "re_export"]

//@ has 're_export/fn.thingy2.html' '//pre[@class="rust item-decl"]' '#[unsafe(no_mangle)]'
pub use thingymod::thingy as thingy2;

mod thingymod {
#[unsafe(no_mangle)]
pub fn thingy() {

}
}
2 changes: 1 addition & 1 deletion tests/rustdoc/attributes-re-export.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//@ edition:2021
#![crate_name = "re_export"]

//@ has 're_export/fn.thingy2.html' '//pre[@class="rust item-decl"]' '#[no_mangle]'
//@ has 're_export/fn.thingy2.html' '//pre[@class="rust item-decl"]' '#[unsafe(no_mangle)]'
pub use thingymod::thingy as thingy2;

mod thingymod {
Expand Down
13 changes: 9 additions & 4 deletions tests/rustdoc/attributes.rs
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
//@ edition: 2024
#![crate_name = "foo"]

//@ has foo/fn.f.html '//pre[@class="rust item-decl"]' '#[no_mangle]'
#[no_mangle]
//@ has foo/fn.f.html '//pre[@class="rust item-decl"]' '#[unsafe(no_mangle)]'
#[unsafe(no_mangle)]
pub extern "C" fn f() {}

//@ has foo/fn.g.html '//pre[@class="rust item-decl"]' '#[export_name = "bar"]'
#[export_name = "bar"]
//@ has foo/fn.g.html '//pre[@class="rust item-decl"]' '#[unsafe(export_name = "bar")]'
#[unsafe(export_name = "bar")]
pub extern "C" fn g() {}

//@ has foo/fn.example.html '//pre[@class="rust item-decl"]' '#[unsafe(link_section = ".text")]'
#[unsafe(link_section = ".text")]
pub extern "C" fn example() {}

//@ has foo/struct.Repr.html '//pre[@class="rust item-decl"]' '#[repr(C, align(8))]'
#[repr(C, align(8))]
pub struct Repr;
Loading