bbjubjub2494/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

add subsections for objects and references

Browse source 
group description of data instead of spreading it across the section.

that should help direct skimming. as it turns out, people do not
actually read any of that.
This commit is contained in:
Valentin Gagarin 2022-05-26 05:16:33 +02:00
parent 4341849193
commit 843288a451
1 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/manual/src/architecture/store/store.md
View file

@ -2,6 +2,8 @@
A Nix store is a collection of *store objects*. A Nix store is a collection of *store objects*.
## Store Object
A store object can hold A store object can hold
- arbitrary *data* - arbitrary *data*
@ -9,6 +11,16 @@ A store object can hold
Nix makes no distinction if store objects are build inputs, build results, or build tasks. Nix makes no distinction if store objects are build inputs, build results, or build tasks.
Store objects are [immutable][immutable-object]: once created, they do not change until they are deleted.
## Reference
References to store objects are [opaque][opaque-data-type], [unique identifiers][unique-identifier]:
The only way to obtain references is by adding or building store objects.
A reference will always point to exactly one store object.
## Operations
A Nix store can *add*, *retrieve*, and *delete* store objects. A Nix store can *add*, *retrieve*, and *delete* store objects.
[ data ] [ data ]
@ -46,11 +58,7 @@ As it keeps track of references, it can [garbage-collect][garbage-collection] un
[ store ] --> collect garbage --> [ store' ] [ store ] --> collect garbage --> [ store' ]
Store objects are [immutable][immutable-object]: once created, they do not change until they are deleted. ## Closure
References are [opaque][opaque-data-type], [unique identifiers][unique-identifier]:
The only way to obtain references is by adding or building store objects.
A reference will always point to exactly one store object.
Nix stores have the *closure property*: for each store object in the store, all the store objects it references must also be in the store. Nix stores have the *closure property*: for each store object in the store, all the store objects it references must also be in the store.