Expand `no_builtins` documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
Research direction
Review the Reference documentation for the no_builtins attribute and the rustc Book as proposed. Clarify its purpose, behavior, examples, and LTO interaction, then decide which details belong in each location and add a link between them. Done means the documentation answers the stated usage and behavior questions without cataloguing every builtin.
Written by the indexing model from the issue text.
Description
Should there be more documentation explaining what the no_builtins attribute does?
I gather it disables LLVM builtin functions, but it's not clear to me what it uses instead. Does it use libc? Does it fail to compile?
I suspect it's not worth documenting the list of builtins, but maybe some examples would be helpful. Perhaps along with some indication why it would be used?
When enabled, it also prevents the crate from participating in LTO.
Some of this seems like implementation details, so I'm not sure what should be documented. I think optimization or backend codegen details should probably be kept in The rustc Book, so maybe it could be documented there, and just have a link to it from the reference?
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 12
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from rust-lang/reference
-
A-const-eval A-undefined-behavior
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
A-resolve
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
A-coercions
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
All issues in rust-lang/reference
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
kwakseongjae/auto-hwp#319 ·
-
area:cli bug filter-quality good first issue priority:medium
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bevyengine/bevy#25861 ·
-
comp-datalake
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/ClickHouse#121222 ·
-
enhancement remote
Difficulty 2/5 1-3 hours Newbie friendliness 68/100