peter/spectre-meltdown-checker
1
0
Fork 0
mirror of https://github.com/speed47/spectre-meltdown-checker.git synced 2026-04-01 12:47:07 +02:00
Code Issues Projects Releases Wiki Activity

use global readonly vars for common paths/basedirs

Browse Source
This commit is contained in:
Stéphane Lesimple
2026-03-30 19:31:22 +02:00
parent 2b2478b8ef
commit fd9d0999af
2 changed files with 64 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
DEVELOPMENT.md
View File

@@ -54,7 +54,7 @@ The entire tool is a single bash script with no external script dependencies. Ke
This script uses the following naming rules for variables:
`UPPER_SNAKE_CASE` : Constants and enums (e.g. READ_MSR_RET_OK, EAX), declared as `readonly`.
`UPPER_SNAKE_CASE` : Constants and enums (e.g. READ_MSR_RET_OK, EAX), declared with `readonly` on the assignment line (e.g. `readonly FOO="bar"`).
When they're used as values affected to "Out-parameters" of a function, they should follow the `<FUNC>_RET_*` pattern.
Such variables should be declared right above the definition of the function they're dedicated to.
Other general constants go at the top of the file, below the `VERSION` affectation.