aboutsummaryrefslogtreecommitdiff
path: root/CODE_STYLE.md
diff options
context:
space:
mode:
authorJessica Clarke <jrtc27@jrtc27.com>2023-06-12 20:32:50 +0100
committerGitHub <noreply@github.com>2023-06-12 20:32:50 +0100
commit2d214136ce4da767d926bc18ff53478181bc729b (patch)
treeb5fbcd82162d0df8df11a4352f48f9cbab6b9d34 /CODE_STYLE.md
parent17a9929821470e119a6d5b4359d0a51d6dae6679 (diff)
downloadsail-riscv-2d214136ce4da767d926bc18ff53478181bc729b.zip
sail-riscv-2d214136ce4da767d926bc18ff53478181bc729b.tar.gz
sail-riscv-2d214136ce4da767d926bc18ff53478181bc729b.tar.bz2
CODE_STYLE: Explicitly ban strings for non-text
Apparently this needs stating and isn't obvious. Signed-off-by: Jessica Clarke <jrtc27@jrtc27.com>
Diffstat (limited to 'CODE_STYLE.md')
-rw-r--r--CODE_STYLE.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/CODE_STYLE.md b/CODE_STYLE.md
index 48df5ad..9483b01 100644
--- a/CODE_STYLE.md
+++ b/CODE_STYLE.md
@@ -81,6 +81,8 @@ Implementation
* Prefer `bool` over `bits(1)` when a value logically represents true or false
rather than being a single bit with a numeric meaning, and vice-versa
+* Do not use strings for anything that is not text
+
* No new compile-time warnings from the Sail compiler should be introduced
(this does not include C or OCaml warnings for the code generated by the Sail
compiler)