summary refs log tree commit diff
path: root/doc/stdenv.xml
diff options
context:
space:
mode:
authorFrederik Rietdijk <freddyrietdijk@fridh.nl>2017-06-19 09:48:01 +0200
committerGitHub <noreply@github.com>2017-06-19 09:48:01 +0200
commit75933da8823d1cc6354802e4f7b219edc1df0c74 (patch)
tree5c8ce4168369eb7704730edbc3d9f12cfa42115a /doc/stdenv.xml
parentd159271516479961e8a60c297488ceb55ce910ea (diff)
parent8c6fada372dba386c25e209a4dff440e2da5a0be (diff)
downloadnixlib-75933da8823d1cc6354802e4f7b219edc1df0c74.tar
nixlib-75933da8823d1cc6354802e4f7b219edc1df0c74.tar.gz
nixlib-75933da8823d1cc6354802e4f7b219edc1df0c74.tar.bz2
nixlib-75933da8823d1cc6354802e4f7b219edc1df0c74.tar.lz
nixlib-75933da8823d1cc6354802e4f7b219edc1df0c74.tar.xz
nixlib-75933da8823d1cc6354802e4f7b219edc1df0c74.tar.zst
nixlib-75933da8823d1cc6354802e4f7b219edc1df0c74.zip
Merge pull request #26345 from vcunat/p/doc-override-phases
nixpkgs manual: advise against overriding whole phases
Diffstat (limited to 'doc/stdenv.xml')
-rw-r--r--doc/stdenv.xml8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml
index 19bacd08f1ec..9ec14d5a7828 100644
--- a/doc/stdenv.xml
+++ b/doc/stdenv.xml
@@ -318,7 +318,13 @@ containing some shell commands to be executed, or by redefining the
 shell function
 <varname><replaceable>name</replaceable>Phase</varname>.  The former
 is convenient to override a phase from the derivation, while the
-latter is convenient from a build script.</para>
+latter is convenient from a build script.
+
+However, typically one only wants to <emphasis>add</emphasis> some
+commands to a phase, e.g. by defining <literal>postInstall</literal>
+or <literal>preFixup</literal>, as skipping some of the default actions
+may have unexpected consequences.
+</para>
 
 
 <section xml:id="ssec-controlling-phases"><title>Controlling