about summary refs log tree commit diff
path: root/tvix/docs/src/nix-daemon/serialization.md
diff options
context:
space:
mode:
authorBrian Olsen <brian@maven-group.org>2024-11-03T13·24+0100
committerBrian Olsen <brian@maven-group.org>2024-11-03T20·49+0000
commit28dbf5f0eb0306d7675ec83475e14c79b05b310d (patch)
tree292f13498fd6d2a18e4bb33381690202ac400a4c /tvix/docs/src/nix-daemon/serialization.md
parentf02bc522b66dda707a7ef469082e56fc0df46569 (diff)
chore(tvix/docs): Small changes to Nix Daemon protocol description r/8884
I found some more operations that are obsolete and a few missing
fields. I also did some small changes to make handshake description
more consistent.

Change-Id: I9f853a37e9d50621491f31ea71879d6a600046e2
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12724
Tested-by: BuildkiteCI
Reviewed-by: flokli <flokli@flokli.de>
Diffstat (limited to 'tvix/docs/src/nix-daemon/serialization.md')
-rw-r--r--tvix/docs/src/nix-daemon/serialization.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/tvix/docs/src/nix-daemon/serialization.md b/tvix/docs/src/nix-daemon/serialization.md
index 1042c956ba71..4d165456d612 100644
--- a/tvix/docs/src/nix-daemon/serialization.md
+++ b/tvix/docs/src/nix-daemon/serialization.md
@@ -144,11 +144,11 @@ An [Int](#int) enum with the following possible values:
 ### OptTrusted
 An [UInt8](#uint8) optional enum with the following possible values:
 
-| Name             | Int |
-| ---------------- | --- |
-| None             |  0  |
-| Some(Trusted)    |  1  |
-| Some(NotTrusted) |  2  |
+| Name       | Int |
+| ---------- | --- |
+| Unknown    |  0  |
+| Trusted    |  1  |
+| NotTrusted |  2  |
 
 
 ## Bytes serializers
@@ -340,15 +340,15 @@ Optional microseconds.
 - env :: [Map](#map-of-x-to-y) of [String](#string) to [String](#string)
 
 ### TraceLine
-- havePos :: [Size](#size) (hardcoded to 0)
+- havePos :: [Size](#size) (hardcoded to 0 with assert on read)
 - hint :: [String](#string) (If logger is JSON, invalid UTF-8 is replaced with U+FFFD)
 
 ### Error
-- type :: [String](#string) (hardcoded to `Error`)
+- type :: [String](#string) (hardcoded to `Error` with assert on read)
 - level :: [Verbosity](#verbosity)
 - name :: [String](#string) (removed and hardcoded to `Error`)
 - msg :: [String](#string) (If logger is JSON, invalid UTF-8 is replaced with U+FFFD)
-- havePos :: [Size](#size) (hardcoded to 0)
+- havePos :: [Size](#size) (hardcoded to 0 with assert on read)
 - traces :: [List](#list-of-x) of [TraceLine](#traceline)
 
 ## Field