From 41de927b7098d0e4c082e95ee4b5a1312bae69dd Mon Sep 17 00:00:00 2001 From: Marc Scholten Date: Sat, 3 Sep 2022 11:13:58 +0200 Subject: [PATCH] doc: Clarify default value of sourceRoot --- doc/stdenv/stdenv.chapter.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/stdenv/stdenv.chapter.md b/doc/stdenv/stdenv.chapter.md index fa61973263a..93351ce1bdb 100644 --- a/doc/stdenv/stdenv.chapter.md +++ b/doc/stdenv/stdenv.chapter.md @@ -452,6 +452,8 @@ The list of source files or directories to be unpacked or copied. One of these m 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. +By default the `sourceRoot` is set to `"source"`. If you want to point to a sub-directory inside your project, you therefore need to set `sourceRoot = "source/my-sub-directory"`. + ##### `setSourceRoot` {#var-stdenv-setSourceRoot} Alternatively to setting `sourceRoot`, you can set `setSourceRoot` to a shell command to be evaluated by the unpack phase after the sources have been unpacked. This command must set `sourceRoot`.