From 5077ca70deb8ca8e84abb9608e08bf4485d3ec4b Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Thu, 13 Jun 2024 22:17:18 +0300 Subject: [PATCH] chore(tvix/eval): move eval docs to tvix/docs Change-Id: I75b33c43456389de6e521b4f0ad46d68bc9e98f6 Reviewed-on: https://cl.tvl.fyi/c/depot/+/11809 Autosubmit: flokli Reviewed-by: tazjin Tested-by: BuildkiteCI --- tvix/docs/src/SUMMARY.md | 13 +++++++++++++ tvix/docs/src/eval/abandoned/index.md | 3 +++ .../src/eval}/abandoned/thread-local-vm.md | 0 tvix/{eval/docs => docs/src/eval}/bindings.md | 0 .../docs => docs/src/eval}/build-references.md | 0 tvix/{eval/docs => docs/src/eval}/builtins.md | 0 .../docs => docs/src/eval}/catchable-errors.md | 0 .../src/eval}/known-optimisation-potential.md | 0 .../{eval/docs => docs/src/eval}/language-issues.md | 0 .../docs => docs/src/eval}/opcodes-attrsets.md | 0 .../{eval/docs => docs/src/eval}/recursive-attrs.md | 0 tvix/{eval/docs => docs/src/eval}/vm-loop.md | 0 12 files changed, 16 insertions(+) create mode 100644 tvix/docs/src/eval/abandoned/index.md rename tvix/{eval/docs => docs/src/eval}/abandoned/thread-local-vm.md (100%) rename tvix/{eval/docs => docs/src/eval}/bindings.md (100%) rename tvix/{eval/docs => docs/src/eval}/build-references.md (100%) rename tvix/{eval/docs => docs/src/eval}/builtins.md (100%) rename tvix/{eval/docs => docs/src/eval}/catchable-errors.md (100%) rename tvix/{eval/docs => docs/src/eval}/known-optimisation-potential.md (100%) rename tvix/{eval/docs => docs/src/eval}/language-issues.md (100%) rename tvix/{eval/docs => docs/src/eval}/opcodes-attrsets.md (100%) rename tvix/{eval/docs => docs/src/eval}/recursive-attrs.md (100%) rename tvix/{eval/docs => docs/src/eval}/vm-loop.md (100%) diff --git a/tvix/docs/src/SUMMARY.md b/tvix/docs/src/SUMMARY.md index 7c25c55ee..633c13683 100644 --- a/tvix/docs/src/SUMMARY.md +++ b/tvix/docs/src/SUMMARY.md @@ -4,6 +4,19 @@ - [Architecture & data flow](./architecture.md) - [TODOs](./TODO.md) +# Evaluator +- [Compilation of Bindings](./eval/bindings.md) +- [Builtins](./eval/builtins.md) +- [Build References](./eval/build-references.md) +- [Catchable Errors](./eval/catchable-errors.md) +- [Known Optimisation Potential](./eval/known-optimisation-potential.md) +- [Langugage Issues](./eval/language-issues.md) +- [Attrset Opcodes](./eval/opcodes-attrsets.md) +- [Recursive attribute sets](./eval/recursive-attrs.md) +- [VM Loop](./eval/vm-loop.md) +- [Abandoned](./eval/abandoned/index.md) + - [Thread-local VM](./eval/abandoned/thread-local-vm.md) + # Store - [Store API](./store/api.md) - [BlobStore Chunking](./castore/blobstore-chunking.md) diff --git a/tvix/docs/src/eval/abandoned/index.md b/tvix/docs/src/eval/abandoned/index.md new file mode 100644 index 000000000..1cef704d0 --- /dev/null +++ b/tvix/docs/src/eval/abandoned/index.md @@ -0,0 +1,3 @@ +# Abandoned ideas + +This chapter keeps track of abandoned ideas, and why they were abandoned. diff --git a/tvix/eval/docs/abandoned/thread-local-vm.md b/tvix/docs/src/eval/abandoned/thread-local-vm.md similarity index 100% rename from tvix/eval/docs/abandoned/thread-local-vm.md rename to tvix/docs/src/eval/abandoned/thread-local-vm.md diff --git a/tvix/eval/docs/bindings.md b/tvix/docs/src/eval/bindings.md similarity index 100% rename from tvix/eval/docs/bindings.md rename to tvix/docs/src/eval/bindings.md diff --git a/tvix/eval/docs/build-references.md b/tvix/docs/src/eval/build-references.md similarity index 100% rename from tvix/eval/docs/build-references.md rename to tvix/docs/src/eval/build-references.md diff --git a/tvix/eval/docs/builtins.md b/tvix/docs/src/eval/builtins.md similarity index 100% rename from tvix/eval/docs/builtins.md rename to tvix/docs/src/eval/builtins.md diff --git a/tvix/eval/docs/catchable-errors.md b/tvix/docs/src/eval/catchable-errors.md similarity index 100% rename from tvix/eval/docs/catchable-errors.md rename to tvix/docs/src/eval/catchable-errors.md diff --git a/tvix/eval/docs/known-optimisation-potential.md b/tvix/docs/src/eval/known-optimisation-potential.md similarity index 100% rename from tvix/eval/docs/known-optimisation-potential.md rename to tvix/docs/src/eval/known-optimisation-potential.md diff --git a/tvix/eval/docs/language-issues.md b/tvix/docs/src/eval/language-issues.md similarity index 100% rename from tvix/eval/docs/language-issues.md rename to tvix/docs/src/eval/language-issues.md diff --git a/tvix/eval/docs/opcodes-attrsets.md b/tvix/docs/src/eval/opcodes-attrsets.md similarity index 100% rename from tvix/eval/docs/opcodes-attrsets.md rename to tvix/docs/src/eval/opcodes-attrsets.md diff --git a/tvix/eval/docs/recursive-attrs.md b/tvix/docs/src/eval/recursive-attrs.md similarity index 100% rename from tvix/eval/docs/recursive-attrs.md rename to tvix/docs/src/eval/recursive-attrs.md diff --git a/tvix/eval/docs/vm-loop.md b/tvix/docs/src/eval/vm-loop.md similarity index 100% rename from tvix/eval/docs/vm-loop.md rename to tvix/docs/src/eval/vm-loop.md