lix-project/lix
19
42
Fork 18
Code Issues 295 Code Review (Gerrit) Projects 1 Releases Wiki Activity

Clarify that not all nix packages will use the default build phases

Browse source
This commit is contained in:
John Chapman 2021-10-17 15:24:22 +11:00
parent 4cff413054
commit ffeec5f283
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/manual/src/command-ref/nix-shell.md
View file

@ -110,18 +110,18 @@ shell in which to build it:
```console
$ nix-shell '<nixpkgs>' -A pan
[nix-shell]$ unpackPhase
[nix-shell]$ eval ${unpackPhase:-unpackPhase}
[nix-shell]$ cd pan-*
[nix-shell]$ configurePhase
[nix-shell]$ buildPhase
[nix-shell]$ eval ${configurePhase:-configurePhase}
[nix-shell]$ eval ${buildPhase:-buildPhase}
[nix-shell]$ ./pan/gui/pan
```
Note: Other packages may override these phases (the unpackPhase,
configurePhase, buildPhase, etc).
For those, it may be required to do something like
`eval "$configurePhase-configurePhase"` or `eval "$configurePhase"`
depending on how that package's nix files have been written.
The reason we use form `eval ${configurePhase:-configurePhase}` here is because
those packages that override these phases do so by exporting the overridden
values in the environment variable of the same name.
Here bash is being told to either evaluate the contents of 'configurePhase',
if it exists as a variable, otherwise evaluate the configurePhase function.
To clear the environment first, and do some additional automatic
initialisation of the interactive shell: