chore(tvix/docs): move daemon protocol to its own chapter
… and add an introductionary page at the root. Change-Id: I89ce69a4221c332b7c0d99ac26b4e26bfd248341 Reviewed-on: https://cl.tvl.fyi/c/depot/+/11806 Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: Brian Olsen <me@griff.name>
This commit is contained in:
parent
d947f61d36
commit
c30fded880
2 changed files with 20 additions and 4 deletions
|
@ -8,7 +8,8 @@
|
||||||
- [Specification of the Nix Language](./language-spec.md)
|
- [Specification of the Nix Language](./language-spec.md)
|
||||||
- [Nix language version history](./lang-version.md)
|
- [Nix language version history](./lang-version.md)
|
||||||
- [Value Pointer Equality](./value-pointer-equality.md)
|
- [Value Pointer Equality](./value-pointer-equality.md)
|
||||||
- [Daemon protocol changelog](./nix-daemon/changelog.md)
|
- [Daemon Protocol](./nix-daemon/index.md)
|
||||||
- [Daemon protocol logging](./nix-daemon/logging.md)
|
- [Changelog](./nix-daemon/changelog.md)
|
||||||
- [Daemon protocol operations](./nix-daemon/operations.md)
|
- [Logging](./nix-daemon/logging.md)
|
||||||
- [Daemon protocol serialization](./nix-daemon/serialization.md)
|
- [Operations](./nix-daemon/operations.md)
|
||||||
|
- [Serialization](./nix-daemon/serialization.md)
|
||||||
|
|
15
tvix/docs/src/nix-daemon/index.md
Normal file
15
tvix/docs/src/nix-daemon/index.md
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
# Nix Daemon Protocol
|
||||||
|
|
||||||
|
The Nix Daemon protocol is what's used to communicate with the `nix-daemon`,
|
||||||
|
either on the local system (in which case the communication happens via a Unix
|
||||||
|
domain socket), or with a remote Nix (in which this is tunneled over SSH).
|
||||||
|
|
||||||
|
It uses a custom binary format which isn't too documented. The subpages here
|
||||||
|
collect serve as an in-depth detail about some of the inner workings, data types
|
||||||
|
etc.
|
||||||
|
|
||||||
|
A first implementation of this exists in
|
||||||
|
[griff/Nix.rs](https://github.com/griff/Nix.rs/tree/main).
|
||||||
|
|
||||||
|
Work is underway to port / factor this out into reusable building blocks into
|
||||||
|
the [nix-compat] crate.
|
Loading…
Add table
Reference in a new issue