diff options
Diffstat (limited to 'doc/build-helpers/testers.chapter.md')
| -rw-r--r-- | doc/build-helpers/testers.chapter.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/build-helpers/testers.chapter.md b/doc/build-helpers/testers.chapter.md index 34cfc00a4953c..a10e60de8c6d7 100644 --- a/doc/build-helpers/testers.chapter.md +++ b/doc/build-helpers/testers.chapter.md @@ -120,9 +120,10 @@ It has two modes: Checks that the output from running a command contains the specified version string in it as a whole word. -Although simplistic, this test assures that the main program can run. -While there's no substitute for a real test case, it does catch dynamic linking errors and such. -It also provides some protection against accidentally building the wrong version, for example when using an "old" hash in a fixed-output derivation. +NOTE: In most cases, [`versionCheckHook`](#versioncheckhook) should be preferred, but this function is provided and documented here anyway. The motivation for adding either tests would be: + +- Catch dynamic linking errors and such and missing environment variables that should be added by wrapping. +- Probable protection against accidentally building the wrong version, for example when using an "old" hash in a fixed-output derivation. By default, the command to be run will be inferred from the given `package` attribute: it will check `meta.mainProgram` first, and fall back to `pname` or `name`. |