diff options
| author | John Ericson <John.Ericson@Obsidian.Systems> | 2023-09-06 09:24:52 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-06 09:24:52 -0400 |
| commit | 754528241a07677bf87255b5aa36c73e610171e1 (patch) | |
| tree | 209c4860f01bb28e5b3a5e2c379886c79e867ae1 /doc | |
| parent | 83f99a380b3230092906cd7d2b847b8fcc9723f4 (diff) | |
| parent | d568877eab59a490694e0bc3edec99d13049552c (diff) | |
Merge pull request #8927 from obsidiansystems/test-derivation-aterm
Test and begin documentation of the ATerm format for derivations
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/src/SUMMARY.md.in | 1 | ||||
| -rw-r--r-- | doc/manual/src/protocols/derivation-aterm.md | 9 |
2 files changed, 10 insertions, 0 deletions
diff --git a/doc/manual/src/SUMMARY.md.in b/doc/manual/src/SUMMARY.md.in index 6c599abcf..701a6ea69 100644 --- a/doc/manual/src/SUMMARY.md.in +++ b/doc/manual/src/SUMMARY.md.in @@ -100,6 +100,7 @@ - [File System Object](architecture/file-system-object.md) - [Protocols](protocols/protocols.md) - [Serving Tarball Flakes](protocols/tarball-fetcher.md) + - [Derivation "ATerm" file format](protocols/derivation-aterm.md) - [Glossary](glossary.md) - [Contributing](contributing/contributing.md) - [Hacking](contributing/hacking.md) diff --git a/doc/manual/src/protocols/derivation-aterm.md b/doc/manual/src/protocols/derivation-aterm.md new file mode 100644 index 000000000..c9dc00ef7 --- /dev/null +++ b/doc/manual/src/protocols/derivation-aterm.md @@ -0,0 +1,9 @@ +# 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 the following format: + +``` +Derive(...) +``` |