From dd4de9674260c2e89cf103a06b73abbc43858833 Mon Sep 17 00:00:00 2001
From: doyle <doyle.github.2ifxi@simplelogin.com>
Date: Mon, 28 Aug 2023 23:41:57 +1000
Subject: [PATCH] Merge header codeblock from <sanitizer/asan_interface.h>

---
 asan_example.cpp | 10 +++-------
 readme.md        | 10 +++-------
 2 files changed, 6 insertions(+), 14 deletions(-)

diff --git a/asan_example.cpp b/asan_example.cpp
index c272c59..a2165ee 100644
--- a/asan_example.cpp
+++ b/asan_example.cpp
@@ -85,25 +85,21 @@ int main()
         "\n"
         "ASAN provides a way to manually markup ranges of bytes to\n"
         "prohibit or permit reads to those addresses. In\n"
-        "`<sanitizer/asan_interface.h>` there's a brief mention for the poison\n"
-        "and unpoison API respectively:\n"
+        "`<sanitizer/asan_interface.h>` there's a vague brief mention to\n"
+        "alignment requirements for the poison API:\n"
         "\n"
         "```cpp\n"
         "/// ... This function is not guaranteed to poison the entire region -\n"
         "/// it could poison only a subregion of <c>[addr, addr+size)</c> due to ASan\n"
         "/// alignment restrictions.\n"
         "void __asan_poison_memory_region(void const volatile *addr, size_t size);\n"
-        "```\n"
         "\n"
-        "and:\n"
-        "\n"
-        "```cpp\n"
         "/// ... This function could unpoison a super-region of <c>[addr, addr+size)</c> due\n"
         "/// to ASan alignment restrictions.\n"
         "void __asan_unpoison_memory_region(void const volatile *addr, size_t size);\n"
         "```\n"
         "\n"
-        "There's another brief foot-note in Google's "
+        "There's another small foot-note in Google's "
         "[AddressSanitizerManualPoisoning](https://github.com/google/"
         "sanitizers/wiki/AddressSanitizerManualPoisoning)\n"
         "documentation that states:\n"
diff --git a/readme.md b/readme.md
index f2bdbbc..db49cd4 100644
--- a/readme.md
+++ b/readme.md
@@ -26,25 +26,21 @@ marked-up memory that may lead to undetected read/writes.
 
 ASAN provides a way to manually markup ranges of bytes to
 prohibit or permit reads to those addresses. In
-`<sanitizer/asan_interface.h>` there's a brief mention for the poison
-and unpoison API respectively:
+`<sanitizer/asan_interface.h>` there's a vague brief mention to
+alignment requirements for the poison API:
 
 ```cpp
 /// ... This function is not guaranteed to poison the entire region -
 /// it could poison only a subregion of <c>[addr, addr+size)</c> due to ASan
 /// alignment restrictions.
 void __asan_poison_memory_region(void const volatile *addr, size_t size);
-```
 
-and:
-
-```cpp
 /// ... This function could unpoison a super-region of <c>[addr, addr+size)</c> due
 /// to ASan alignment restrictions.
 void __asan_unpoison_memory_region(void const volatile *addr, size_t size);
 ```
 
-There's another brief foot-note in Google's [AddressSanitizerManualPoisoning](https://github.com/google/sanitizers/wiki/AddressSanitizerManualPoisoning)
+There's another small foot-note in Google's [AddressSanitizerManualPoisoning](https://github.com/google/sanitizers/wiki/AddressSanitizerManualPoisoning)
 documentation that states:
 
 ```