From 820eb0cbd98c3a5e8b7199951aefaa1b50e55d30 Mon Sep 17 00:00:00 2001
From: Vesa Karvonen <vesa.a.j.k@gmail.com>
Date: Tue, 26 Dec 2023 15:29:40 +0200
Subject: [PATCH] Note on local/stack allocation

---
 src/kcas/kcas.ml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/kcas/kcas.ml b/src/kcas/kcas.ml
index 8cac6e95..815f9541 100644
--- a/src/kcas/kcas.ml
+++ b/src/kcas/kcas.ml
@@ -172,7 +172,10 @@ and _ tdt =
     }
       -> [> `Xt ] tdt
       (** The result might not yet have been determined.  The [root] either says
-          which it is or points to the root of the transaction log or [tree]. *)
+          which it is or points to the root of the transaction log or [tree].
+
+          Note that if/when local/stack allocation mode becomes available in
+          OCaml, the transaction log should be mostly stack allocated. *)
   | Leaf : [> `Leaf ] tdt  (** Leaf node in the transaction log or [tree]. *)
   | Node : {
       loc : 'a loc;