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

Merge pull request #4202 from hercules-ci/nix-shell-doc

Browse source 
Nix shell doc
This commit is contained in:
Eelco Dolstra 2020-10-30 11:36:24 +01:00 committed by GitHub
parent 7f56cf67ba d4c5d8d32a
commit a3a22bd804
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -32,7 +32,7 @@ URL of a tarball that will be downloaded and unpacked to a temporary
location. The tarball must include a single top-level directory location. The tarball must include a single top-level directory
containing at least a file named `default.nix`. containing at least a file named `default.nix`.
If the derivation defines the variable `shellHook`, it will be evaluated If the derivation defines the variable `shellHook`, it will be run
after `$stdenv/setup` has been sourced. Since this hook is not executed after `$stdenv/setup` has been sourced. Since this hook is not executed
by regular Nix builds, it allows you to perform initialisation specific by regular Nix builds, it allows you to perform initialisation specific
to `nix-shell`. For example, the derivation attribute to `nix-shell`. For example, the derivation attribute
@ -41,10 +41,12 @@ to `nix-shell`. For example, the derivation attribute
shellHook = shellHook =
'' ''
echo "Hello shell" echo "Hello shell"
export SOME_API_TOKEN="$(cat ~/.config/some-app/api-token)"
''; '';
``` ```
will cause `nix-shell` to print `Hello shell`. will cause `nix-shell` to print `Hello shell` and set the `SOME_API_TOKEN`
environment variable to a user-configured value.
# Options # Options