asm.rules.stack-below-sp is ambiguous
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
Research direction
Start with the Rust Reference inline-assembly section linked in the issue, especially the rule named asm.rules.stack-below-sp, and compare its wording with the SPARC stack-direction behavior mentioned. Clarify whether the rule is address-based or logical, specify the relevant direction or stack region, and ensure the resulting text explains what stack contents may be accessed.
Written by the indexing model from the issue text.
Description
Stacks can grow in different directions and diagrams can be top-to-bottom or bottom-to-top.
Apparently the SPARC arch can select whether the stack grows up or down.
This section of the reference talks about stack space below the stack pointer, but because of different models of how stacks can work, it's not entirely clear what that means.
- If the text is meant 'by address', then the rule changes based on the arch
- If the text is meant logically, then it should probably say so. And it should still specify the direction.
Instead of up and down, maybe it should be specified in terms of 'used' vs 'potential' stack? Or 'active' and 'inactive'?
Or maybe describe the contents you're allowed to interact with. For example, are you allowed to read the stack frame of the caller of the current function?
The more I read the current text, the less I'm sure what it actually says.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 609
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 7
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
rust-lang/reference#2371 · 3 comments ·
Maintainers usually reply within 1 day
-
A-const-eval A-undefined-behavior
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
rust-lang/reference#2266 · 1 comment ·
Maintainers usually reply within 1 day
-
A-resolve
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
All issues in rust-lang/reference
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day