diff options
author | Jade Lovelace <lix@jade.fyi> | 2024-05-05 15:32:20 -0700 |
---|---|---|
committer | Jade Lovelace <lix@jade.fyi> | 2024-05-05 16:11:01 -0700 |
commit | 748d8310fa7e044ad4c950ff38e31309ea3f606d (patch) | |
tree | 4a097ffd7a05e17f7b4a55660abff765e0346e11 /doc/manual/src/language | |
parent | a3d4aca83691eb4bcbc2d3b20b559dbd59f02887 (diff) |
Fix the pages in the manual for Lix
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
Diffstat (limited to 'doc/manual/src/language')
-rw-r--r-- | doc/manual/src/language/advanced-attributes.md | 10 | ||||
-rw-r--r-- | doc/manual/src/language/derivations.md | 12 |
2 files changed, 11 insertions, 11 deletions
diff --git a/doc/manual/src/language/advanced-attributes.md b/doc/manual/src/language/advanced-attributes.md index a5ad47a93..ec21b9990 100644 --- a/doc/manual/src/language/advanced-attributes.md +++ b/doc/manual/src/language/advanced-attributes.md @@ -116,7 +116,7 @@ Derivations can declare some infrequently used optional attributes. These attributes declare that the derivation is a so-called *fixed-output derivation*, which means that a cryptographic hash of the output is already known in advance. When the build of a - fixed-output derivation finishes, Nix computes the cryptographic + fixed-output derivation finishes, Lix computes the cryptographic hash of the output and compares it to the hash declared with these attributes. If there is a mismatch, the build fails. @@ -241,7 +241,7 @@ Derivations can declare some infrequently used optional attributes. then when the builder runs, the environment variable `bigPath` will contain the absolute path to a temporary file containing `a very long string`. That is, for any attribute *x* listed in - `passAsFile`, Nix will pass an environment variable `xPath` + `passAsFile`, Lix will pass an environment variable `xPath` holding the path of the file containing the value of attribute *x*. This is useful when you need to pass large strings to a builder, since most operating systems impose a limit on the size @@ -256,13 +256,13 @@ Derivations can declare some infrequently used optional attributes. the cost of building locally. - [`allowSubstitutes`]{#adv-attr-allowSubstitutes}\ - If this attribute is set to `false`, then Nix will always build this + If this attribute is set to `false`, then Lix will always build this derivation; it will not try to substitute its outputs. This is useful for very trivial derivations (such as `writeText` in Nixpkgs) that are cheaper to build than to substitute from a binary cache. You may disable the effects of this attibute by enabling the - `always-allow-substitutes` configuration option in Nix. + `always-allow-substitutes` configuration option in Lix. > **Note** > @@ -284,7 +284,7 @@ Derivations can declare some infrequently used optional attributes. [`outputChecks`](#adv-attr-outputChecks) for example. As a convenience to Bash builders, - Nix writes a script that initialises shell variables + Lix writes a script that initialises shell variables corresponding to all attributes that are representable in Bash. The environment variable `NIX_ATTRS_SH_FILE` points to the exact location of the script, both in a build and a diff --git a/doc/manual/src/language/derivations.md b/doc/manual/src/language/derivations.md index 1dceacab7..c10e8149d 100644 --- a/doc/manual/src/language/derivations.md +++ b/doc/manual/src/language/derivations.md @@ -61,7 +61,7 @@ the attributes of which specify the inputs of the build. outputs = [ "lib" "headers" "doc" ]; ``` - This will cause Nix to pass environment variables `lib`, `headers` + This will cause Lix to pass environment variables `lib`, `headers` and `doc` to the builder containing the intended store paths of each output. The builder would typically do something like @@ -137,7 +137,7 @@ The builder is executed as follows: it’s `out`.) - If an output path already exists, it is removed. Also, locks are - acquired to prevent multiple Nix instances from performing the same + acquired to prevent multiple Lix instances from performing the same build at the same time. - A log of the combined standard output and error is written to @@ -150,17 +150,17 @@ The builder is executed as follows: - The temporary directory is removed (unless the `-K` option was specified). - - If the build was successful, Nix scans each output path for + - If the build was successful, Lix scans each output path for references to input paths by looking for the hash parts of the input - paths. Since these are potential runtime dependencies, Nix registers + paths. Since these are potential runtime dependencies, Lix registers them as dependencies of the output paths. - - After the build, Nix sets the last-modified timestamp on all files + - After the build, Lix sets the last-modified timestamp on all files in the build result to 1 (00:00:01 1/1/1970 UTC), sets the group to the default group, and sets the mode of the file to 0444 or 0555 (i.e., read-only, with execute permission enabled if the file was originally executable). Note that possible `setuid` and `setgid` bits are cleared. Setuid and setgid programs are not currently - supported by Nix. This is because the Nix archives used in + supported by Lix. This is because the Lix archives used in deployment have no concept of ownership information, and because it makes the build result dependent on the user performing the build. |