doc: reference sourceRoot in description of srcs
This commit is contained in:
parent
441e405c77
commit
6ef3c96ddf
1 changed files with 2 additions and 2 deletions
|
@ -373,11 +373,11 @@ Additional file types can be supported by setting the `unpackCmd` variable (see
|
||||||
|
|
||||||
##### `srcs` / `src` {#var-stdenv-src}
|
##### `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}
|
##### `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}
|
##### `setSourceRoot` {#var-stdenv-setSourceRoot}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue