about summary refs log tree commit diff
path: root/tvix/docs/src/eval/build-references.md
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2024-10-21T13·34+0200
committerflokli <flokli@flokli.de>2024-11-12T11·55+0000
commit14744713276870cf0380e31bee01124e1a2f4cb0 (patch)
tree084f0b9e215a9746a8d9210c81c7fe5e91bd7731 /tvix/docs/src/eval/build-references.md
parent2af30c8c7faf108bfcf649a9bf2818b25e5a63f6 (diff)
docs(tvix/eval): update string context document r/8912
NixString doesn't contain a `HashSet<BuildReference>` anymore, there's a
more packed internal data structure. We don't need to be overly specific
in the docs, just say we expose an API.

Change-Id: I13380c49293f9a86d1916909fdfeefbe64d9024b
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12755
Tested-by: BuildkiteCI
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: edef <edef@edef.eu>
Diffstat (limited to 'tvix/docs/src/eval/build-references.md')
-rw-r--r--tvix/docs/src/eval/build-references.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/tvix/docs/src/eval/build-references.md b/tvix/docs/src/eval/build-references.md
index dd53f65d83aa..6c0b88df1839 100644
--- a/tvix/docs/src/eval/build-references.md
+++ b/tvix/docs/src/eval/build-references.md
@@ -120,9 +120,10 @@ passes etc.
 In the past, Tvix did not track string contexts in its evaluator at all, see
 the historical section for more information about that.
 
-Tvix tracks string contexts in every `NixString` structure via a
-`HashSet<BuildReference>` and offers an API to combine the references while
-keeping the exact internal structure of that data private.
+Tvix tracks string contexts in every `NixString` structure and offers an API to
+do operations on the context (inherit/clear/…), as well as iterators over
+(different types of) context elements, while keeping the exact internal
+structure of that data private.
 
 ## Historical attempt: Persistent reference tracking