Welcome to little lamb

Code » limb » commit bb6a3c3

doc: Mention how escall_scan() supports overlapping memory locations.

author Olivier Brunel
2023-12-16 20:55:27 UTC
committer Olivier Brunel
2024-01-01 19:10:12 UTC
parent a3dd65fe0e3f3b232cffe198533b5745311622e4

doc: Mention how escall_scan() supports overlapping memory locations.

src/doc/esc.h/escall_fmt.3.md +6 -0

diff --git a/src/doc/esc.h/escall_fmt.3.md b/src/doc/esc.h/escall_fmt.3.md
index a69c5b4..eabfcc2 100644
--- a/src/doc/esc.h/escall_fmt.3.md
+++ b/src/doc/esc.h/escall_fmt.3.md
@@ -49,6 +49,12 @@ accordingly.
 The `esc_scan`() function is similar to `escall_scan`() only without the `r` and
 `w` argument, and different return values.
 
+! NOTE:
+! The `escall_scan`() function supports the same memory location given in `sce`
+! and `dst` with different offsets in `r` and `w`.
+! Similarly, the `esc_scan`() function supports overlapping memory locations in
+! `sce` and `dst`.
+
 # ESCAPING
 
 The escaping performed is intended to have the written value inside