aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/src/protocols/derivation-aterm.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual/src/protocols/derivation-aterm.md')
-rw-r--r--doc/manual/src/protocols/derivation-aterm.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/manual/src/protocols/derivation-aterm.md b/doc/manual/src/protocols/derivation-aterm.md
new file mode 100644
index 000000000..e58b602a3
--- /dev/null
+++ b/doc/manual/src/protocols/derivation-aterm.md
@@ -0,0 +1,19 @@
+# Derivation "ATerm" file format
+
+For historical reasons, [derivations](@docroot@/glossary.md#gloss-store-derivation) are stored on-disk in [ATerm](https://homepages.cwi.nl/~daybuild/daily-books/technology/aterm-guide/aterm-guide.html) format.
+
+Derivations are serialised in one of the following formats:
+
+- ```
+ Derive(...)
+ ```
+
+ For all stable derivations.
+
+- ```
+ DrvWithVersion(<version-string>, ...)
+ ```
+
+ The only `version-string`s that are in use today are for [experimental features](@docroot@/contributing/experimental-features.md):
+
+ - `"xp-dyn-drv"` for the [`dynamic-derivations`](@docroot@/contributing/experimental-features.md#xp-feature-dynamic-derivations) experimental feature.