summary refs log tree commit diff
path: root/doc/stdenv/stdenv.chapter.md
diff options
context:
space:
mode:
authorNaïm Favier <n@monade.li>2023-01-25 18:18:41 +0100
committerNaïm Favier <n@monade.li>2023-01-25 18:26:18 +0100
commitedb26159dba85e97731fa1941859cd997aacb2a5 (patch)
tree10761ef6b18c72a732da65ff9e16cb5dc01b13fd /doc/stdenv/stdenv.chapter.md
parent353e2d957c7421cae4e3ab42739a0997ea7e310f (diff)
downloadnixpkgs-edb26159dba85e97731fa1941859cd997aacb2a5.tar
nixpkgs-edb26159dba85e97731fa1941859cd997aacb2a5.tar.gz
nixpkgs-edb26159dba85e97731fa1941859cd997aacb2a5.tar.bz2
nixpkgs-edb26159dba85e97731fa1941859cd997aacb2a5.tar.lz
nixpkgs-edb26159dba85e97731fa1941859cd997aacb2a5.tar.xz
nixpkgs-edb26159dba85e97731fa1941859cd997aacb2a5.tar.zst
nixpkgs-edb26159dba85e97731fa1941859cd997aacb2a5.zip
doc/stdenv: clarify default check target
Diffstat (limited to 'doc/stdenv/stdenv.chapter.md')
-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 e66cc347677..1972ca62f4f 100644
--- a/doc/stdenv/stdenv.chapter.md
+++ b/doc/stdenv/stdenv.chapter.md
@@ -626,7 +626,7 @@ Before and after running `make`, the hooks `preBuild` and `postBuild` are called
 
 ### The check phase {#ssec-check-phase}
 
-The check phase checks whether the package was built correctly by running its test suite. The default `checkPhase` calls `make check`, but only if the `doCheck` variable is enabled.
+The check phase checks whether the package was built correctly by running its test suite. The default `checkPhase` calls `make $checkTarget`, but only if the `doCheck` variable is enabled (see below).
 
 #### Variables controlling the check phase {#variables-controlling-the-check-phase}
 
@@ -646,7 +646,7 @@ See the [build phase](#var-stdenv-makeFlags) for details.
 
 ##### `checkTarget` {#var-stdenv-checkTarget}
 
-The make target that runs the tests. Defaults to `check`.
+The make target that runs the tests. Defaults to `check` if it exists, otherwise `test`; if neither is found, do nothing.
 
 ##### `checkFlags` / `checkFlagsArray` {#var-stdenv-checkFlags}