about summary refs log tree commit diff
path: root/doc/stdenv
diff options
context:
space:
mode:
authorAleksana <me@aleksana.moe>2024-04-08 20:07:40 +0800
committerGitHub <noreply@github.com>2024-04-08 14:07:40 +0200
commitfe0c92572faf77e18e42353637c3cb8ab680a9b0 (patch)
treeb8b5c89a695e1af8c97bb852722a65446e2c2954 /doc/stdenv
parentc011096248019b04db90d6eb5d4fd4403ea60943 (diff)
doc/stdenv: document prefixKey more precisely (#302535)
* doc/stdenv: document prefixKey more precisely

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Diffstat (limited to 'doc/stdenv')
-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 a1e27b7bdf7f4..f3cdb1f2dc0c0 100644
--- a/doc/stdenv/stdenv.chapter.md
+++ b/doc/stdenv/stdenv.chapter.md
@@ -797,7 +797,7 @@ A shell array containing additional arguments passed to the configure script. Yo
 
 ##### `dontAddPrefix` {#var-stdenv-dontAddPrefix}
 
-By default, the flag `--prefix=$prefix` is added to the configure flags. If this is undesirable, set this variable to true.
+By default, `./configure` is passed the concatenation of [`prefixKey`](#var-stdenv-prefixKey) and [`prefix`](#var-stdenv-prefix) on the command line. Disable this by setting `dontAddPrefix` to `true`.
 
 ##### `prefix` {#var-stdenv-prefix}
 
@@ -805,7 +805,7 @@ The prefix under which the package must be installed, passed via the `--prefix`
 
 ##### `prefixKey` {#var-stdenv-prefixKey}
 
-The key to use when specifying the prefix. By default, this is set to `--prefix=` as that is used by the majority of packages.
+The key to use when specifying the installation [`prefix`](#var-stdenv-prefix). By default, this is set to `--prefix=` as that is used by the majority of packages. Other packages may need `--prefix ` (with a trailing space) or `PREFIX=`.
 
 ##### `dontAddStaticConfigureFlags` {#var-stdenv-dontAddStaticConfigureFlags}