about summary refs log tree commit diff
path: root/tvix/docs/src/nix-daemon/logging.md
diff options
context:
space:
mode:
authorVova Kryachko <v.kryachko@gmail.com>2024-11-19T17·28-0500
committerVladimir Kryachko <v.kryachko@gmail.com>2024-11-20T17·36+0000
commitdb13b6c0920b1d5f141ffbcab485f42b2695d1ae (patch)
treeda722964161cf1dc6ba5db63c1a1b5bfb9ea6f77 /tvix/docs/src/nix-daemon/logging.md
parente5fbde94aa4c706ecc93108ac0c646620eb2e426 (diff)
chore(tvix/nix-daemon): Implement STDERR_READ protocol r/8944
When sending nars over the wire to the nix-daemon, nix protocol versions
1.21 to 1.23 use this framing protocol.

This change implements an AsyncRead for this protocol, to be used in
AddToStoreNar and any other operations when necessary.

Change-Id: I571f1adbb2343c14c98503d1a2c12eea4c783ec9
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12813
Reviewed-by: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Diffstat (limited to 'tvix/docs/src/nix-daemon/logging.md')
-rw-r--r--tvix/docs/src/nix-daemon/logging.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/tvix/docs/src/nix-daemon/logging.md b/tvix/docs/src/nix-daemon/logging.md
index b6522c867100..e753279fa7e9 100644
--- a/tvix/docs/src/nix-daemon/logging.md
+++ b/tvix/docs/src/nix-daemon/logging.md
@@ -53,9 +53,9 @@ Normal string log message.
 
 ### `STDERR_READ`
 Reader interface used by ImportsPaths and AddToStoreNar (between 1.21 and 1.23).
-It works by sending a desired buffer length and then on the receiver stream it
-reads bytes buffer of that length. If it receives 0 bytes it sees this as an
-unexpected EOF.
+It works by sending a *desired* buffer length and then on the receiver stream it
+reads the *actual* buffer length followed by a bytes buffer of that length padded to
+8 bytes. If it receives 0 bytes it sees this as an unexpected EOF.
 
 - 0x64617461 :: [UInt64][se-UInt64] (hardcoded, 'data' in ASCII)
 - desiredLen :: [Size][se-Size]