summaryrefslogtreecommitdiff
path: root/src/itree.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/itree.h')
-rw-r--r--src/itree.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/itree.h b/src/itree.h
index 8d33ef223b5..b0f7a1d193b 100644
--- a/src/itree.h
+++ b/src/itree.h
@@ -149,7 +149,8 @@ struct interval_node *itree_iterator_next (struct itree_iterator *);
it is cheap a pure.
- Only a single iteration can happen at a time, so make sure none of the
code within the loop can start another tree iteration, i.e. it shouldn't
- be able to run ELisp code (or GC for that matter).
+ be able to run ELisp code, nor GC since GC can run ELisp by way
+ of `post-gc-hook`.
- If you need to exit the loop early, you *have* to call `ITREE_ABORT`
just before exiting (e.g. with `break` or `return`).
- Non-local exits are not supported within the body of the loop.