aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/command-ref/opt-common.xml
diff options
context:
space:
mode:
authorNiklas Hambüchen <mail@nh2.me>2019-11-10 17:29:13 +0100
committerNiklas Hambüchen <mail@nh2.me>2019-11-10 17:29:13 +0100
commit07294e988cc54f1c2570c567662cf39eabbd610c (patch)
tree04f56afb0ebd0c0cecaa2d9ae64ca34ba15eec32 /doc/manual/command-ref/opt-common.xml
parent35732a95bcdc0a4b4492845205e6283fcc88fd0d (diff)
manual: nix-shell: Elaborate on using `-p` with expressions.
This documents the outcome of the change in https://github.com/NixOS/nix/issues/454: > We can also automatically add parentheses in the generated > `buildInputs`, so you can type `nix-shell -p "expr"` > instead of `"(expr").
Diffstat (limited to 'doc/manual/command-ref/opt-common.xml')
-rw-r--r--doc/manual/command-ref/opt-common.xml9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/manual/command-ref/opt-common.xml b/doc/manual/command-ref/opt-common.xml
index 6a8107be9..0383bfaed 100644
--- a/doc/manual/command-ref/opt-common.xml
+++ b/doc/manual/command-ref/opt-common.xml
@@ -323,7 +323,14 @@
Nix expressions to be parsed and evaluated, rather than as a list
of file names of Nix expressions.
(<command>nix-instantiate</command>, <command>nix-build</command>
- and <command>nix-shell</command> only.)</para></listitem>
+ and <command>nix-shell</command> only.)</para>
+
+ <para>For <command>nix-shell</command>, this option is commonly used
+ to give you a shell in which you can build the packages returned
+ by the expression. If you want to get a shell which contain the
+ <emphasis>built</emphasis> packages ready for use, give your
+ expression to the <command>nix-shell -p</command> convenience flag
+ instead.</para></listitem>
</varlistentry>