-
Notifications
You must be signed in to change notification settings - Fork 170
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #256 from rust-embedded/csr-write-rfc
RFC template for nominating CSRs to be write-safe
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
23 changes: 23 additions & 0 deletions
23
.github/ISSUE_TEMPLATE/-riscv---nominate-csr-to-be--write--safe.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: "`riscv`: Nominate CSR to be `write` safe" | ||
about: Suggest to make writes of a given CSR safe | ||
title: "`riscv`: make [CSR] write-safe" | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Which CSR do you want to nominate as `write` safe?** | ||
Indicate which CSR you want to be `write` safe. Ex. `mepc` | ||
|
||
**Does a CSR write introduce potential memory safety issues in safe code? Please describe.** | ||
A clear and concise justification on why writing to this CSR will **never** introduce memory safety issues in safe code. | ||
|
||
**Does a CSR write introduce potential undefined behavior in safe code? Please describe.** | ||
A clear and concise justification on why writing to this CSR will **never** lead to undefined behavior in safe code. | ||
|
||
**Does a CSR write invalidate invariants in safe code?** | ||
A clear and concise justification on why writing to this CSR will **never** invalidate invariants in safe code. | ||
|
||
**Additional context** | ||
Please feel free to add any other context or screenshots about your request here. |