architecture diagram on CI

14 files changed, 56 insertions, 0 deletions

diff --git a/lib/abstract/Storage.ml b/lib/abstract/Storage.ml
index 2358c67..5eaeba3 100644
--- a/lib/abstract/Storage.ml
+++ b/lib/abstract/Storage.ml
@@ -1,3 +1,8 @@
+(* @needs Configuration *)
+(* @needs Condition *)
+(* @needs Hash *)
+(* @needs Representation *)
+
 module type STORAGE = sig
   type connection
   type transaction
diff --git a/lib/backend/execution/FOL.ml b/lib/backend/execution/FOL.ml
index 302285d..7da890d 100644
--- a/lib/backend/execution/FOL.ml
+++ b/lib/backend/execution/FOL.ml
@@ -1,3 +1,8 @@
+(* @uses Tuple -- project, rename, merge over result streams *)
+(* @needs Value *)
+(* @needs Path *)
+(* @needs Condition *)
+
 module Plan = struct
   type path_arg = Var of string | Const of Concepts.Value.value
 
diff --git a/lib/backend/managers/Cursor.ml b/lib/backend/managers/Cursor.ml
index 474387a..7fdbb6f 100644
--- a/lib/backend/managers/Cursor.ml
+++ b/lib/backend/managers/Cursor.ml
@@ -1,3 +1,9 @@
+(* @composes Storage -- functor parameter *)
+(* @needs Path *)
+(* @needs Tuple *)
+(* @needs Value *)
+(* @needs Condition *)
+
 type descriptor =
   | Stored of {merkle_root: string}
   | Ephemeral of {merkle_root: string; dependencies: Concepts.Path.t BatFingerTree.t}
diff --git a/lib/backend/managers/Handle.ml b/lib/backend/managers/Handle.ml
index 872af43..be84972 100644
--- a/lib/backend/managers/Handle.ml
+++ b/lib/backend/managers/Handle.ml
@@ -1,3 +1,11 @@
+(* @composes Storage -- functor parameter *)
+(* @composes Cursor -- applies Cursor.Make (Store) *)
+(* @uses Object -- find, registry/kind inspection *)
+(* @uses Condition -- builds not-a-relation / no-such-object errors *)
+(* @needs Path *)
+(* @needs Tuple *)
+(* @needs Value *)
+
 module type HANDLER = sig
   type t
   type handle
diff --git a/lib/backend/managers/Identity.ml b/lib/backend/managers/Identity.ml
index 3510e3a..bfde226 100644
--- a/lib/backend/managers/Identity.ml
+++ b/lib/backend/managers/Identity.ml
@@ -1,3 +1,5 @@
+(* @needs Object *)
+
 let permits (object_ : Object.registry) (method_ : Object.rnt_method) : bool =
   BatSet.mem method_ object_.Object.entry.Object.methods
 
diff --git a/lib/backend/managers/Lifecycle.ml b/lib/backend/managers/Lifecycle.ml
index 7aa3836..d104249 100644
--- a/lib/backend/managers/Lifecycle.ml
+++ b/lib/backend/managers/Lifecycle.ml
@@ -8,6 +8,10 @@
    the manager surfaces those to the caller as disposals rather than acting on
    storage itself. *)
 
+(* @uses Object -- find/update, unregister, reference_edges, has_children *)
+(* @needs Path *)
+(* @needs Condition *)
+
 type tree = Object.rnt_object_tree
 
 (* A runtime object that was collected and now needs an external teardown the
diff --git a/lib/backend/managers/Namespace.ml b/lib/backend/managers/Namespace.ml
index 61b1eff..a48fef9 100644
--- a/lib/backend/managers/Namespace.ml
+++ b/lib/backend/managers/Namespace.ml
@@ -1,3 +1,8 @@
+(* @composes Storage -- functor parameter *)
+(* @needs Object *)
+(* @needs Path *)
+(* @needs Condition *)
+
 module Make (Store : Abstract.Storage.STORAGE) = struct
   type tree = Object.rnt_object_tree
 
diff --git a/lib/backend/managers/Object.ml b/lib/backend/managers/Object.ml
index 981420b..ae5f5c1 100644
--- a/lib/backend/managers/Object.ml
+++ b/lib/backend/managers/Object.ml
@@ -1,3 +1,7 @@
+(* @uses Path -- snoc, to_string when building registry paths *)
+(* @uses Condition -- builds registry-object/path errors *)
+(* @needs Value *)
+
 type multigroup = {merkle_root: string}
 type relation = {merkle_root: string}
 
diff --git a/lib/backend/storage/LMDB.ml b/lib/backend/storage/LMDB.ml
index 0d7f8d0..ff5eb3d 100644
--- a/lib/backend/storage/LMDB.ml
+++ b/lib/backend/storage/LMDB.ml
@@ -1,3 +1,10 @@
+(* @uses Configuration -- reads config term to connect *)
+(* @uses Hash -- hash keys for get/put *)
+(* @uses Representation -- blob encode/decode *)
+(* @needs Condition *)
+(* @needs Value *)
+(* @needs Storage *)
+
 module C = struct
   open Ctypes
   open PosixTypes
diff --git a/lib/concepts/Condition.ml b/lib/concepts/Condition.ml
index 16f02d0..a9082ad 100644
--- a/lib/concepts/Condition.ml
+++ b/lib/concepts/Condition.ml
@@ -1,3 +1,5 @@
+(* @uses Value -- renders property values in to_string_hum *)
+
 type properties = (string, Value.value) BatMap.t
 type ps = properties -> properties
 
diff --git a/lib/concepts/Configuration.ml b/lib/concepts/Configuration.ml
index 5ca95d5..b2c29eb 100644
--- a/lib/concepts/Configuration.ml
+++ b/lib/concepts/Configuration.ml
@@ -1,3 +1,5 @@
+(* @uses Condition -- builds syntax/type errors *)
+
 open Sexplib.Sexp
 
 type term = Sexplib.Sexp.t
diff --git a/lib/concepts/Hash.ml b/lib/concepts/Hash.ml
index 106e731..f467ee7 100644
--- a/lib/concepts/Hash.ml
+++ b/lib/concepts/Hash.ml
@@ -1,3 +1,5 @@
+(* @needs Value *)
+
 type hash = Digestif.SHA256.t
 
 let hash_of_value (v : Value.value) =
diff --git a/lib/concepts/Representation.ml b/lib/concepts/Representation.ml
index 856ae11..12c3624 100644
--- a/lib/concepts/Representation.ml
+++ b/lib/concepts/Representation.ml
@@ -1,3 +1,5 @@
+(* @needs Value *)
+
 type blob = bytes
 
 let blob_of_bytes (b : bytes) = b
diff --git a/lib/concepts/Tuple.ml b/lib/concepts/Tuple.ml
index 3050c13..8fac426 100644
--- a/lib/concepts/Tuple.ml
+++ b/lib/concepts/Tuple.ml
@@ -1,3 +1,5 @@
+(* @needs Value *)
+
 module AttributeMap = BatMap.String
 
 (** A tuple: a finite map from attribute name to attribute. *)