Default link name of items in extern blocks is not documented

Open
#658 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Find the extern block section in the Rust Reference and review how it currently describes link_name for functions and statics. Reproduce or inspect the linked playground example to confirm that the default is the unmangled name regardless of ABI. Done means the section explicitly documents this default behavior.

Written by the indexing model from the issue text.

Description

The extern block section does not document the "default" link_name used for items (functions and statics) in extern blocks. @RalfJung shows here (https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=6f976fe163c70645529ae6e1b15fd82a) that independently of the ABI used the unmangled name is chosen, which makes sense as the intended behavior (what else could we do?). cc @eddyb

Dominant language
Rust
Stars
1.6k
Forks
607
Avg merge
1d 1h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-lang/reference

All issues in rust-lang/reference

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.