Note on local/stack allocation

ocaml-multicore · Dec 26, 2023 · 820eb0c · 820eb0c
1 parent 6f850f9
commit 820eb0c
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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;