From 1ed45ec50fc393c49e3d4b65772419e6b7c42467 Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Thu, 4 Sep 2025 12:05:45 +0200 Subject: Update README on asan:ignore also affecting instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miquel Sabaté Solà --- crates/nasm/README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) (limited to 'crates') diff --git a/crates/nasm/README.md b/crates/nasm/README.md index 5e2fa69..4b4cf50 100644 --- a/crates/nasm/README.md +++ b/crates/nasm/README.md @@ -112,21 +112,18 @@ zp_bad = $22 ; NOTE: The address sanitizer will mark it as a *conflict*. If you want to ignore this (e.g. you are using a variable that shadows other ones), then you can explicitely tell the address sanitizer to ignore a given -assignment: +assignment or instruction: ```asm zp_buffer = $20 ; asan:reserve $0F zp_good = $22 ; asan:ignore +lda $200 ; asan:ignore ``` -TODO: NOTE asan:ignore also takes care of lda $200 ; asan:ignore - - - -In order for the address sanitizer to be successful, it will warn programmers -whenever an access to memory is being done without using variables. This allows -for the address sanitizer to be more thorough, even if there is never the -guarantee that memory accesses will be safe. For example: +That is, in order for the address sanitizer to be successful, it will also warn +programmers whenever an access to memory is being done without using +variables. This allows for the address sanitizer to be more thorough, even if +there is never the guarantee that memory accesses will be safe. For example: ```asm zp_variable = $20 -- cgit v1.2.3