about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorSilvan Mosberger <contact@infinisil.com>2023-12-20 20:37:41 +0100
committerGitHub <noreply@github.com>2023-12-20 20:37:41 +0100
commit6afebb56f8774471e5d45f7f3b543890d0d1492b (patch)
tree318f30ea49b574f5c029df4e2a61a3d644c15367 /doc
parentac58b65cf53f8bebbb5ec35ae870a88466301a66 (diff)
parentfb9e48c6b907b6524a39898bfc5d1c7d0d63fdd4 (diff)
Merge pull request #271360 from mattpolzin/patch-1
doc: clarify stdenv phase flag attributes
Diffstat (limited to 'doc')
-rw-r--r--doc/stdenv/stdenv.chapter.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/stdenv/stdenv.chapter.md b/doc/stdenv/stdenv.chapter.md
index 5a5a867ef2dc5..5b330b245823d 100644
--- a/doc/stdenv/stdenv.chapter.md
+++ b/doc/stdenv/stdenv.chapter.md
@@ -831,7 +831,7 @@ Note that shell arrays cannot be passed through environment variables, so you ca
 
 ##### `buildFlags` / `buildFlagsArray` {#var-stdenv-buildFlags}
 
-A list of strings passed as additional flags to `make`. Like `makeFlags` and `makeFlagsArray`, but only used by the build phase.
+A list of strings passed as additional flags to `make`. Like `makeFlags` and `makeFlagsArray`, but only used by the build phase. Any build targets should be specified as part of the `buildFlags`.
 
 ##### `preBuild` {#var-stdenv-preBuild}
 
@@ -872,7 +872,7 @@ If unset, use `check` if it exists, otherwise `test`; if neither is found, do no
 
 ##### `checkFlags` / `checkFlagsArray` {#var-stdenv-checkFlags}
 
-A list of strings passed as additional flags to `make`. Like `makeFlags` and `makeFlagsArray`, but only used by the check phase.
+A list of strings passed as additional flags to `make`. Like `makeFlags` and `makeFlagsArray`, but only used by the check phase. Unlike with `buildFlags`, the `checkTarget` is automatically added to the `make` invocation in addition to any `checkFlags` specified.
 
 ##### `checkInputs` {#var-stdenv-checkInputs}
 
@@ -914,7 +914,7 @@ installTargets = "install-bin install-doc";
 
 ##### `installFlags` / `installFlagsArray` {#var-stdenv-installFlags}
 
-A list of strings passed as additional flags to `make`. Like `makeFlags` and `makeFlagsArray`, but only used by the install phase.
+A list of strings passed as additional flags to `make`. Like `makeFlags` and `makeFlagsArray`, but only used by the install phase. Unlike with `buildFlags`, the `installTargets` are automatically added to the `make` invocation in addition to any `installFlags` specified.
 
 ##### `preInstall` {#var-stdenv-preInstall}