From 179ca9859eb30e351bb86bb43e3eab1876b55f96 Mon Sep 17 00:00:00 2001 From: Philip Taron Date: Mon, 16 Feb 2026 08:53:57 -0800 Subject: [PATCH] doc: buildenv.section.md: fix argument name, default, and grammar - includeClosure -> includeClosures (matching the actual argument name) - extraPrefix default: [ ] -> "" (matching the actual default) - Fix broken sentence about ignoreSingleFileOutputs --- doc/build-helpers/special/buildenv.section.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/build-helpers/special/buildenv.section.md b/doc/build-helpers/special/buildenv.section.md index 8d584caf306e..7ae1dbb94e36 100644 --- a/doc/build-helpers/special/buildenv.section.md +++ b/doc/build-helpers/special/buildenv.section.md @@ -27,12 +27,12 @@ Unless otherwise noted, arguments can be overridden directly using [`.overr - `extraOutputsToInstall` (default to `[ ]`): Package outputs to include in addition to what `meta.outputsToInstall` specifies. -- `includeClosure` (default to `false`): +- `includeClosures` (default to `false`): Whether to include closures of all input paths. The list of the closure paths are constructed with `writeClosure`. They are installed with lower priority and with build-time exceptions silenced. -- `extraPrefix` (default to `[ ]`): +- `extraPrefix` (default to `""`): Root the result in directory `"$out${extraPrefix}"`, e.g. `"/share"`. - `ignoreCollisions` (default: `false`): @@ -95,5 +95,5 @@ And [`lib.meta.setPrio`](#function-library-lib.meta.setPrio)-related Nixpkgs Lib When an output path provides a single file instead of a directory, it inherently cannot merge into the result layout. All discoverable packages should configure their `meta.outputsToInstall` correctly, so that single-file outputs won't be installed into a profile. -The `ignoreSingleFileOutputs` To drop all single-file output paths silently. +Set `ignoreSingleFileOutputs` to `true` to drop all single-file output paths silently. This option is useful when the specified paths contain the output paths of package tests.