From 6d03e310603869b7ad67bd00f8eb858e362bd763 Mon Sep 17 00:00:00 2001
From: Vincent Ambo <mail@tazj.in>
Date: Fri, 20 Jan 2023 16:00:28 +0300
Subject: docs(tvix/eval): add doc comments to VM fields

Change-Id: Ia4857c217de15aec8b61e1abd39e22c50e2d816a
Reviewed-on: https://cl.tvl.fyi/c/depot/+/7876
Reviewed-by: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Autosubmit: tazjin <tazjin@tvl.su>
---
 tvix/eval/src/vm.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/tvix/eval/src/vm.rs b/tvix/eval/src/vm.rs
index 60006ea76f9c..b42b47c2dc01 100644
--- a/tvix/eval/src/vm.rs
+++ b/tvix/eval/src/vm.rs
@@ -109,12 +109,20 @@ pub struct VM<'o> {
     /// Runtime warnings collected during evaluation.
     warnings: Vec<EvalWarning>,
 
+    /// Import cache, mapping absolute file paths to the value that
+    /// they compile to. Note that this reuses thunks, too!
+    // TODO: should probably be based on a file hash
     pub import_cache: Box<BTreeMap<PathBuf, Value>>,
 
+    /// Parsed Nix search path, which is used to resolve `<...>`
+    /// references.
     nix_search_path: NixSearchPath,
 
+    /// Implementation of I/O operations used for impure builtins and
+    /// features like `import`.
     io_handle: Box<dyn EvalIO>,
 
+    /// Runtime observer which can print traces of runtime operations.
     observer: &'o mut dyn RuntimeObserver,
 }
 
-- 
cgit 1.4.1