Tweak wording of readme

This commit is contained in:
doyle 2023-08-28 23:41:56 +10:00
parent d2e3722772
commit 6cbd672a3e
2 changed files with 6 additions and 8 deletions

View File

@ -105,12 +105,11 @@ int main()
"\n" "\n"
"We use a stack-allocated 16 byte array and test un/poisoning\n" "We use a stack-allocated 16 byte array and test un/poisoning\n"
"various ranges of bytes from different alignments to clarify the\n" "various ranges of bytes from different alignments to clarify the\n"
"poisoning behaviour of the API.\n" "poisoning behaviour of the API. This reveals that calling the API\n"
"\n" "haphazardly, unaligned or straddling boundaries can lead to gaps in\n"
"This reveals that calling the API haphazardly, unaligned or\n" "poisoned memory and hide potential leaks (as also demonstrated in\n"
"straddling boundaries can lead to gaps in poisoned memory and hide\n" "[Manual ASAN poisoning and alignment]"
"potential leaks (as also demonstrated in [Manual ASAN poisoning and\n" "(https://github.com/mcgov/asan_alignment_example)).\n"
"alignment](https://github.com/mcgov/asan_alignment_example)).\n"
"\n" "\n"
"## References\n" "## References\n"
"\n" "\n"

View File

@ -47,8 +47,7 @@ poisoning behaviour of the API.
This reveals that calling the API haphazardly, unaligned or This reveals that calling the API haphazardly, unaligned or
straddling boundaries can lead to gaps in poisoned memory and hide straddling boundaries can lead to gaps in poisoned memory and hide
potential leaks (as also demonstrated in [Manual ASAN poisoning and potential leaks (as also demonstrated in [Manual ASAN poisoning and
alignment](https://github.com/mcgov/asan_alignment_example) example alignment](https://github.com/mcgov/asan_alignment_example)).
by `mcgov`.
## References ## References