max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-29 09:06:15 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

reword example for clarity

Browse source
This commit is contained in:
Valentin Gagarin 2023-09-26 00:58:50 +02:00
parent 7de66f19f8
commit 5b0336b3b1
1 changed files with 11 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
doc/manual/src/language/derivations.md
View file

@ -71,11 +71,15 @@ It outputs an attribute set, and produces a [store derivation](@docroot@/glossar
Examples: Examples:
Imagine a library package that provides a dynamic library, header files, and documentation. Imagine a library package that provides a dynamic library, header files, and documentation.
A program that links against the library doesn’t need the header files and documentation at runtime, and it doesn’t need the documentation at build time. A program that links against such a library doesn’t need the header files and documentation at runtime, and it doesn’t need the documentation at build time.
Thus, the library package could specify: Thus, the library package could specify:
```nix ```nix
derivation {
# ...
outputs = [ "lib" "dev" "doc" ]; outputs = [ "lib" "dev" "doc" ];
# ...
}
``` ```
This will cause Nix to pass environment variables `lib`, `dev`, and `doc` to the builder containing the intended store paths of each output. This will cause Nix to pass environment variables `lib`, `dev`, and `doc` to the builder containing the intended store paths of each output.
@ -90,22 +94,12 @@ It outputs an attribute set, and produces a [store derivation](@docroot@/glossar
for an Autoconf-style package. for an Autoconf-style package.
You can refer to each output of a You can refer to each output of a derivation by selecting it as an attribute, e.g. `myPackage.lib` or `myPackage.doc`.
derivation by selecting it as an attribute, e.g.
```nix
buildInputs = [ pkg.lib pkg.dev ];
```
<!-- FIXME: move this to the output attributes section when we have one -->
The first element of `outputs` determines the *default output*. The first element of `outputs` determines the *default output*.
Thus, you could also write Therefore, in the given example, `myPackage` is equivalent to `myPackage.lib`.
```nix <!-- FIXME: refer to the output attributes when we have one -->
buildInputs = [ pkg pkg.dev ];
```
since `pkg` is equivalent to `pkg.lib`.
- See [Advanced Attributes](./advanced-attributes.md) for more, infrequently used, optional attributes. - See [Advanced Attributes](./advanced-attributes.md) for more, infrequently used, optional attributes.