rust-lang / rust-lang/reference

inline assembly doesn't document `.arm` as a guaranteed directive

Open
#1,234 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-asm Help Wanted
Dominant language
Rust
Stars
1.6k
Forks
607
PR merge metrics
PR metrics pending

Description

the .thumb directive is in the ARM-specific list of guaranteed directives. If .thumb is, then .arm should also be as well. Otherwise we should tell people to exclusively stick to the .code directive.

cc @Amanieu

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.

Research direction

Start in the Rust Reference section documenting ARM-specific guaranteed inline-assembly directives and compare the entries for .thumb and .code. Resolve whether .arm should be documented as guaranteed or guidance should require .code, then update that documentation accordingly.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.