From 608ad1a724c22ead1326073905db17070c9fb5c3 Mon Sep 17 00:00:00 2001 From: Erin Date: Thu, 23 Nov 2023 16:25:06 +0100 Subject: [PATCH] Changed docs a bit --- hbvm/src/vmrun.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/hbvm/src/vmrun.rs b/hbvm/src/vmrun.rs index d2e7f77..8062612 100644 --- a/hbvm/src/vmrun.rs +++ b/hbvm/src/vmrun.rs @@ -41,14 +41,14 @@ where // Contribution guide: // - Zero register shall never be overwitten. It's value has to always be 0. // - 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 // - Memory is cheap, CPUs not that much // - Do not heap allocate at any cost // - Yes, user-provided trap handler may allocate, // but that is not our »fault«. // - 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 // - The spec does not specify how you perform actions, in what order, // just that the observable effects have to be performed in order and