AbleOS/holey-bytes
3
3
Fork 5
Code Issues 2 Pull requests Packages Projects Releases Wiki Activity

Changed docs a bit

Browse source
This commit is contained in:
Erin 2023-11-23 16:25:06 +01:00
parent 5e6fdf4e80
commit 608ad1a724
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
hbvm/src/vmrun.rs
View file

@ -41,14 +41,14 @@ where
// Contribution guide: // Contribution guide:
// - Zero register shall never be overwitten. It's value has to always be 0. // - Zero register shall never be overwitten. It's value has to always be 0.
// - Prefer `Self::read_reg` and `Self::write_reg` functions // - Prefer `Self::read_reg` and `Self::write_reg` functions
// - Extract parameters using `param!` macro // - Try to use `handler!` macro for decoding and then bumping program counter
// - Prioritise speed over code size // - Prioritise speed over code size
// - Memory is cheap, CPUs not that much // - Memory is cheap, CPUs not that much
// - Do not heap allocate at any cost // - Do not heap allocate at any cost
// - Yes, user-provided trap handler may allocate, // - Yes, user-provided trap handler may allocate,
// but that is not our »fault«. // but that is not our »fault«.
// - Unsafe is kinda must, but be sure you have validated everything // - Unsafe is kinda must, but be sure you have validated everything
// - Your contributions have to pass sanitizers and Miri // - Your contributions have to pass sanitizers, fuzzer and Miri
// - Strictly follow the spec // - Strictly follow the spec
// - The spec does not specify how you perform actions, in what order, // - The spec does not specify how you perform actions, in what order,
// just that the observable effects have to be performed in order and // just that the observable effects have to be performed in order and