summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorRobert Hensing <roberth@users.noreply.github.com>2021-10-07 15:03:45 +0200
committerGitHub <noreply@github.com>2021-10-07 15:03:45 +0200
commit45da228a4904f4e532e645994a415563ec2d7806 (patch)
tree63ec81007ed81a76c05d51b36d6d64b1ccbfeb1a /doc
parent40fd8c9c24980dbb38769b2544ea318ab175761c (diff)
parent6ef3c96ddf7132e0dbb0d958b03fcc0ce327a0b0 (diff)
downloadnixpkgs-45da228a4904f4e532e645994a415563ec2d7806.tar
nixpkgs-45da228a4904f4e532e645994a415563ec2d7806.tar.gz
nixpkgs-45da228a4904f4e532e645994a415563ec2d7806.tar.bz2
nixpkgs-45da228a4904f4e532e645994a415563ec2d7806.tar.lz
nixpkgs-45da228a4904f4e532e645994a415563ec2d7806.tar.xz
nixpkgs-45da228a4904f4e532e645994a415563ec2d7806.tar.zst
nixpkgs-45da228a4904f4e532e645994a415563ec2d7806.zip
Merge pull request #140396 from laikq/srcs-doc
doc: reference sourceRoot in description of srcs
Diffstat (limited to 'doc')
-rw-r--r--doc/stdenv/stdenv.chapter.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/stdenv/stdenv.chapter.md b/doc/stdenv/stdenv.chapter.md
index 9befcaa51a9..02042407f6c 100644
--- a/doc/stdenv/stdenv.chapter.md
+++ b/doc/stdenv/stdenv.chapter.md
@@ -373,11 +373,11 @@ Additional file types can be supported by setting the `unpackCmd` variable (see
 
 ##### `srcs` / `src` {#var-stdenv-src}
 
-The list of source files or directories to be unpacked or copied. One of these must be set.
+The list of source files or directories to be unpacked or copied. One of these must be set. Note that if you use `srcs`, you should also set `sourceRoot` or `setSourceRoot`.
 
 ##### `sourceRoot` {#var-stdenv-sourceRoot}
 
-After running `unpackPhase`, the generic builder changes the current directory to the directory created by unpacking the sources. If there are multiple source directories, you should set `sourceRoot` to the name of the intended directory.
+After running `unpackPhase`, the generic builder changes the current directory to the directory created by unpacking the sources. If there are multiple source directories, you should set `sourceRoot` to the name of the intended directory. Set `sourceRoot = ".";` if you use `srcs` and control the unpack phase yourself.
 
 ##### `setSourceRoot` {#var-stdenv-setSourceRoot}