From 47b699b7d72630d2edc512594a2c813d7fb2f7a6 Mon Sep 17 00:00:00 2001
From: Pierre-Marie Pédrot <pierre-marie.pedrot@inria.fr>
Date: Thu, 20 Jul 2017 14:47:24 +0200
Subject: Documenting the purity / marshallability invariant of persistent
 states.

---
 library/libobject.mli | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'library/libobject.mli')

diff --git a/library/libobject.mli b/library/libobject.mli
index 1a21ece2b..6f935bffe 100644
--- a/library/libobject.mli
+++ b/library/libobject.mli
@@ -56,6 +56,9 @@ open Mod_subst
      rebuild the non volatile content of a section from the data
      collected by the discharge function
 
+  Any type defined as a persistent object must be pure (e.g. no references) and
+  marshallable by the OCaml Marshal module (e.g. no closures).
+
 *)
 
 type 'a substitutivity =
-- 
cgit v1.2.3