diff options
| author | John Ericson <John.Ericson@Obsidian.Systems> | 2018-01-08 01:33:35 -0500 |
|---|---|---|
| committer | John Ericson <John.Ericson@Obsidian.Systems> | 2018-01-09 12:37:12 -0500 |
| commit | 4e907dbca19d4b1ab6b110c7e68f88a539df7c97 (patch) | |
| tree | 10e75d40dfaaae0882d8bf1003c1c09d2afb566e /doc/stdenv.xml | |
| parent | b2cbffae6468c34f3c315bc40aa6df4483309f00 (diff) | |
| download | nixlib-4e907dbca19d4b1ab6b110c7e68f88a539df7c97.tar nixlib-4e907dbca19d4b1ab6b110c7e68f88a539df7c97.tar.gz nixlib-4e907dbca19d4b1ab6b110c7e68f88a539df7c97.tar.bz2 nixlib-4e907dbca19d4b1ab6b110c7e68f88a539df7c97.tar.lz nixlib-4e907dbca19d4b1ab6b110c7e68f88a539df7c97.tar.xz nixlib-4e907dbca19d4b1ab6b110c7e68f88a539df7c97.tar.zst nixlib-4e907dbca19d4b1ab6b110c7e68f88a539df7c97.zip | |
stdenv: Force `doCheck` and `doInstallCheck` to be false when we are cross compiling
I hope this will be a temporary measure. If there is consensus around issue #33599, then we can follow an explicit `dontCheck`, but default to not checking during cross builds when none is given.
Diffstat (limited to 'doc/stdenv.xml')
| -rw-r--r-- | doc/stdenv.xml | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 7154a576def9..3a7b23baaa7e 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -995,13 +995,14 @@ but only if the <varname>doCheck</varname> variable is enabled.</para> <varlistentry> <term><varname>doCheck</varname></term> - <listitem><para>If set to a non-empty string, the check phase is - executed, otherwise it is skipped (default). Thus you should set - - <programlisting> -doCheck = true;</programlisting> - - in the derivation to enable checks.</para></listitem> + <listitem><para> + Controls whether the check phase is executed. + By default it is skipped, but if <varname>doCheck</varname> is set to true, the check phase is usually executed. + Thus you should set <programlisting>doCheck = true;</programlisting> in the derivation to enable checks. + The exception is cross compilation. + Cross compiled builds never run tests, no matter how <varname>doCheck</varname> is set, + as the newly-built program won't run on the platform used to build it. + </para></listitem> </varlistentry> <varlistentry> @@ -1280,12 +1281,14 @@ installcheck</command>.</para> <varlistentry> <term><varname>doInstallCheck</varname></term> - <listitem><para>If set to a non-empty string, the installCheck phase is - executed, otherwise it is skipped (default). Thus you should set - - <programlisting>doInstallCheck = true;</programlisting> - - in the derivation to enable install checks.</para></listitem> + <listitem><para> + Controls whether the installCheck phase is executed. + By default it is skipped, but if <varname>doInstallCheck</varname> is set to true, the installCheck phase is usually executed. + Thus you should set <programlisting>doInstallCheck = true;</programlisting> in the derivation to enable install checks. + The exception is cross compilation. + Cross compiled builds never run tests, no matter how <varname>doInstallCheck</varname> is set, + as the newly-built program won't run on the platform used to build it. + </para></listitem> </varlistentry> <varlistentry> |