aboutsummaryrefslogtreecommitdiff
path: root/library/summary.mli
diff options
context:
space:
mode:
authorMaxime Dénès2017-07-20 14:50:23 +0200
committerMaxime Dénès2017-07-20 14:50:23 +0200
commit362ed8371062cea08ae2d7e5842091bf184393cb (patch)
treea281ae1722a5262a0b5e37aedf0704c7f0f4777a /library/summary.mli
parentb02179e15d35352b48440657ad47f6bf7ee9495c (diff)
parent47b699b7d72630d2edc512594a2c813d7fb2f7a6 (diff)
Merge PR #903: Documenting the purity / marshallability invariant of persistent states.
Diffstat (limited to 'library/summary.mli')
-rw-r--r--library/summary.mli2
1 files changed, 2 insertions, 0 deletions
diff --git a/library/summary.mli b/library/summary.mli
index a6ad49950e..d093d95f29 100644
--- a/library/summary.mli
+++ b/library/summary.mli
@@ -14,6 +14,8 @@ type marshallable =
| `No (* Full data will be store in memory, e.g. for Undo *)
| `Shallow ] (* Only part of the data will be marshalled to a slave process *)
+(** Types of global Coq states. The ['a] type should be pure and marshallable by
+ the standard OCaml marshalling function. *)
type 'a summary_declaration = {
(** freeze_function [true] is for marshalling to disk.
* e.g. lazy must be forced *)