Age | Commit message (Collapse) | Author |
|
This doesn't comprehensively fix everything outdated in the manual, or
make the manual greatly better, but it does note down where at least
jade noticed it was wrong, and it does fix all the instances of
referencing Nix to conform to the style guide to the best of our
ability.
A lot of things have been commented out for being wrong, and there are
three types of FIXME introduced:
- FIXME(Lix): generically Lix needs to fix it
- FIXME(Qyriad): re https://git.lix.systems/lix-project/lix/issues/215
- FIXME(meson): docs got outdated by meson changes and need rewriting
I did fix a bunch of it that I could, but there could certainly be
mistakes and this is definitely just an incremental improvement.
Fixes: https://git.lix.systems/lix-project/lix/issues/266
Change-Id: I5993c4603d7f026a887089fce77db08394362135
|
|
The big ones here are `trim-trailing-whitespace` and `end-of-file-fixer`
(which makes sure that every file ends with exactly one newline
character).
Change-Id: Idca73b640883188f068f9903e013cf0d82aa1123
|
|
While this is not actually a notion in the implementation, it is
explicitly described in the thesis and quite important for understanding
how the store works.
Co-authored-by: John Ericson <git@JohnEricson.me>
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
|
|
|
|
The targets I could find.
|
|
this is to help reading the diagrams, otherwise arrows and labels were
reported as being ambiguous.
|
|
|
|
the language has its own overview page where its properties are
described in sufficient detail.
|
|
this will at some point enable rendering them nicely for the web
|
|
Co-authored-by: Bryan Honof <bryan.honof@tweag.io>
|
|
|
|
these changes were not merged properly and had to be reverted.
see merge commit d8e54d19f71f78540dd967b2e42be6a5d8a0b1bb for full
history leading up to here.
|
|
This reverts commit 81e101345fda2a8651c470f08b364a1ca6fa37cf, reversing
changes made to 7d1280bbaf7f4cd142c2259dec620c42bf6f96fd.
|
|
So we can iterate without worrying so much.
|
|
|
|
|
|
apparently it is not possible to link to page anchors with `mdBook`[1]
[1]: https://github.com/rust-lang/mdBook/issues/167
|
|
|
|
|
|
|
|
the store of course makes a distinction, but that is not relevant here
|
|
|
|
the longer SHA-256 hashes are not truncated, but in fact processed.
Co-authored-by: Thomas <twatson52@mac.com>
|
|
Co-authored-by: Thomas <twatson52@mac.com>
|
|
|
|
Nix omits E O U T characters for some reason.
|
|
Nix itself does care a lot about what type of store object you have.
|
|
Co-authored-by: Thomas <twatson52@mac.com>
|
|
|
|
this has the weird but nice emergent property that terms at the same
height are roughly at the same level of abstraction.
|
|
this is not as compact any more, but it more closely resembles the
chapter structure, and clearly shows that the closure property is the
key idea on which most of Nix operates.
|
|
|
|
invert arrows to/from derivation:
- we need closures to form derivations
- we need derivations to perform builds
|
|
this should help nativate the chapter by indicating which terms should
be known to understand a given concept.
|
|
the various levels of detail should describe the same things.
|
|
try not to be too fancy, it's just for reading the diagram out loud.
|
|
clarify that we are copying between different stores. we have not
introduced that notion or why it would be interesting, but for now it
should be fine to keep it in context of the store directory.
we could move that later to a more detailed explanation of different
store types.
|
|
using JSON notation is unwarranted and not explained.
|
|
use singular for terminology uniformly
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Co-authored-by: John Ericson <John.Ericson@Obsidian.Systems>
|
|
garbage collection is now incremental, and may (in theory) never delete all unreferenced objects if it is slow enough.
|
|
at this level of abstraction we do not really care about build instructions or what they are, and also build instructions including their arguments really amount to the build task.
|
|
this also looks more diverse, hopefully easier to distinguish
Co-authored-by: John Ericson <John.Ericson@Obsidian.Systems>
|
|
|