about summary refs log tree commit diff
path: root/doc/stdenv/stdenv.chapter.md
diff options
context:
space:
mode:
authorDoron Behar <doron.behar@gmail.com>2024-06-18 08:54:26 +0300
committerDoron Behar <doron.behar@gmail.com>2024-06-28 18:03:59 +0300
commitf42d4debf076b03f48b24fb59a7a75d0d8c29363 (patch)
tree165b709b9f961474b0c2f19abfd1445dd1ea8aa5 /doc/stdenv/stdenv.chapter.md
parentb353c6d82ab939b6fd12fa8cb5854cab7b3e1537 (diff)
doc: recommend versionCheckHook whenever relevant
Diffstat (limited to 'doc/stdenv/stdenv.chapter.md')
-rw-r--r--doc/stdenv/stdenv.chapter.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/stdenv/stdenv.chapter.md b/doc/stdenv/stdenv.chapter.md
index 400fa2de1e764..6d26f1dad3d46 100644
--- a/doc/stdenv/stdenv.chapter.md
+++ b/doc/stdenv/stdenv.chapter.md
@@ -762,6 +762,8 @@ Before and after running `make`, the hooks `preBuild` and `postBuild` are called
 
 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](#var-stdenv-doCheck) is enabled.
 
+It is highly recommended, for packages' sources that are not distributed with any tests, to at least use [`versionCheckHook`](#versioncheckhook) to test that the resulting executable is basically functional.
+
 #### Variables controlling the check phase {#variables-controlling-the-check-phase}
 
 ##### `doCheck` {#var-stdenv-doCheck}