Skip to content

Update no_link to use the attribute template #1898

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.

Sign up for GitHub

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 4 commits into
base: master
Choose a base branch
from
Open

Update no_link to use the attribute template #1898

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e42ca9f
Unwrap no_link
ehuss Jun 20, 2025
3529ce9
Linkify "attribute" and add an intro rule name
ehuss Jun 21, 2025
b19c93f
Add a no_link example
ehuss Jun 21, 2025
28d177f
Update no_link to use the attribute template
ehuss Jun 21, 2025
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
29 changes: 26 additions & 3 deletions src/items/extern-crates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,32 @@ into the [`macro_use` prelude].
r[items.extern-crate.no_link]
## The `no_link` attribute

The *`no_link` attribute* may be specified on an `extern crate` item to
prevent linking the crate into the output. This is commonly used to load a
crate to access only its macros.
r[items.extern-crate.no_link.intro]
The *`no_link` [attribute][attributes]* may be specified on an `extern crate` item to prevent linking the crate into the output. This is commonly used to load a crate to access only its macros.

> [!EXAMPLE]
> <!-- ignore: requires external crates -->
> ```rust,ignore
> #[no_link]
> extern crate other_crate;
>
> other_crate::some_macro!();
> ```

r[items.extern-crate.no_link.syntax]
The `no_link` attribute uses the [MetaWord] syntax and thus does not take any inputs.

r[items.extern-crate.no_link.allowed-positions]
The `no_link` attribute may be specified on an `extern crate` declaration.

> [!NOTE]
> `rustc` currently warns on some positions where it is ignored, but this may become an error in the future.

r[items.extern-crate.no_link.duplicates]
Duplicate instances of the `no_link` attribute are ignored.

> [!NOTE]
> `rustc` currently warns about unused duplicate `no_link` attributes.

[identifier]: ../identifiers.md
[RFC 940]: https://github.com/rust-lang/rfcs/blob/master/text/0940-hyphens-considered-harmful.md
Expand Down