From 7e72cc4e388826c893a5117de64d3be1b5ddf2fd Mon Sep 17 00:00:00 2001 From: Lin Jian Date: Fri, 11 Oct 2024 09:22:13 +0800 Subject: [PATCH] doc: fix typo --- doc/hooks/versionCheckHook.section.md | 2 +- doc/stdenv/passthru.chapter.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/hooks/versionCheckHook.section.md b/doc/hooks/versionCheckHook.section.md index 55b9fa916c40..b8ff79d5dac8 100644 --- a/doc/hooks/versionCheckHook.section.md +++ b/doc/hooks/versionCheckHook.section.md @@ -28,7 +28,7 @@ It does so in a clean environment (using `env --ignore-environment`), and it che The variables that this phase control are: -- `dontVersionCheck`: Disable adding this hook to the [`preDistPhases`](#var-stdenv-preDist). Useful if you do want to load the bash functions of the hook, but run them differently. +- `dontVersionCheck`: Disable adding this hook to the [`preInstallCheckHooks`](#ssec-installCheck-phase). Useful if you do want to load the bash functions of the hook, but run them differently. - `versionCheckProgram`: The full path to the program that should print the `${version}` string. Defaults roughly to `${placeholder "out"}/bin/${pname}`. Using `$out` in the value of this variable won't work, as environment variables from this variable are not expanded by the hook. Hence using `placeholder` is unavoidable. - `versionCheckProgramArg`: The argument that needs to be passed to `versionCheckProgram`. If undefined the hook tries first `--help` and then `--version`. Examples: `version`, `-V`, `-v`. - `preVersionCheck`: A hook to run before the check is done. diff --git a/doc/stdenv/passthru.chapter.md b/doc/stdenv/passthru.chapter.md index 142b978d5880..0c0b03fd0dc2 100644 --- a/doc/stdenv/passthru.chapter.md +++ b/doc/stdenv/passthru.chapter.md @@ -79,7 +79,7 @@ Besides tests provided by upstream, that you run in the [`checkPhase`](#ssec-che - They access the package as consumers would, independently from the environment in which it was built - They can be run and debugged without rebuilding the package, which is useful if that takes a long time -- They don't add overhead to each build, as opposed checks added to the [`distPhase`](#ssec-distribution-phase), such as [`versionCheckHook`](#versioncheckhook). +- They don't add overhead to each build, as opposed checks added to the [`installCheckPhase`](#ssec-installCheck-phase), such as [`versionCheckHook`](#versioncheckhook). It is also possible to use `passthru.tests` to test the version with [`testVersion`](#tester-testVersion), but since that is pretty trivial and recommended thing to do, we recommend using [`versionCheckHook`](#versioncheckhook) for that, which has the following advantages over `passthru.tests`: