about summary refs log tree commit diff
path: root/tvix/nix-compat/src/nar/writer
diff options
context:
space:
mode:
Diffstat (limited to 'tvix/nix-compat/src/nar/writer')
-rw-r--r--tvix/nix-compat/src/nar/writer/mod.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/tvix/nix-compat/src/nar/writer/mod.rs b/tvix/nix-compat/src/nar/writer/mod.rs
index 71625420cc19..ffc1a9f30e8e 100644
--- a/tvix/nix-compat/src/nar/writer/mod.rs
+++ b/tvix/nix-compat/src/nar/writer/mod.rs
@@ -163,6 +163,10 @@ impl<'a, 'w> Directory<'a, 'w> {
     ///
     /// The entry is simply another [`Node`], which can then be filled like the
     /// root of a NAR (including, of course, by nesting directories).
+    ///
+    /// It is the caller's responsibility to ensure that directory entries are
+    /// written in order of ascending name. If this is not ensured, this method
+    /// may panic or silently produce invalid archives.
     pub fn entry(&mut self, name: &[u8]) -> io::Result<Node<'_, 'w>> {
         debug_assert!(
             name.len() <= wire::MAX_NAME_LEN,