about summary refs log tree commit diff
path: root/tvix/derivation/src/write.rs
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2023-01-23T12·19+0300
committertazjin <tazjin@tvl.su>2023-01-23T12·55+0000
commitbe7f64ac87ee00aa13b0629ef4b927e14cc30e05 (patch)
tree74599dfa0bc957d44fb46e22ad2a66d6411e30f1 /tvix/derivation/src/write.rs
parent5719763fd3afaa5dd157da604069b037ca4bf79a (diff)
refactor(tvix/derivation): minor structure simplification r/5736
Fixes some module comments and embeds the `compress_hash` function in
the `derivation` module, as it was not used outside of this module
anyways.

Change-Id: I6c5c92b3f0c03c2cdcbcfc2f813909a968c4d44c
Reviewed-on: https://cl.tvl.fyi/c/depot/+/7905
Tested-by: BuildkiteCI
Reviewed-by: flokli <flokli@flokli.de>
Diffstat (limited to 'tvix/derivation/src/write.rs')
-rw-r--r--tvix/derivation/src/write.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/tvix/derivation/src/write.rs b/tvix/derivation/src/write.rs
index daca5ece2194..8874b5d35a0a 100644
--- a/tvix/derivation/src/write.rs
+++ b/tvix/derivation/src/write.rs
@@ -1,3 +1,8 @@
+//! This module implements the serialisation of derivations into the
+//! [ATerm][] format used by C++ Nix.
+//!
+//! [ATerm]: http://program-transformation.org/Tools/ATermFormat.html
+
 use crate::output::Output;
 use crate::string_escape::escape_string;
 use std::collections::BTreeSet;