pyrox.dev
lol
doc/stdenv/platform-notes: convert to markdown
authored by
Ben Siraphob
and committed by
Jan Tojnar
92d319d5
27d72106
+63
-84
+1
-1
doc/manual.xml
+1
-1
doc/manual.xml
···
19
19
<xi:include href="stdenv/meta.xml" />
20
20
<xi:include href="stdenv/multiple-output.xml" />
21
21
<xi:include href="stdenv/cross-compilation.chapter.xml" />
22
-
<xi:include href="stdenv/platform-notes.xml" />
22
+
<xi:include href="stdenv/platform-notes.chapter.xml" />
23
23
</part>
24
24
<part>
25
25
<title>Builders</title>
+62
doc/stdenv/platform-notes.chapter.md
+62
doc/stdenv/platform-notes.chapter.md
···
1
+
# Platform Notes {#chap-platform-notes}
2
+
3
+
## Darwin (macOS) {#sec-darwin}
4
+
5
+
Some common issues when packaging software for Darwin:
6
+
7
+
- The Darwin `stdenv` uses clang instead of gcc. When referring to the compiler `$CC` or `cc` will work in both cases. Some builds hardcode gcc/g++ in their build scripts, that can usually be fixed with using something like `makeFlags = [ "CC=cc" ];` or by patching the build scripts.
8
+
9
+
```nix
10
+
stdenv.mkDerivation {
11
+
name = "libfoo-1.2.3";
12
+
# ...
13
+
buildPhase = ''
14
+
$CC -o hello hello.c
15
+
'';
16
+
}
17
+
```
18
+
19
+
- On Darwin, libraries are linked using absolute paths, libraries are resolved by their `install_name` at link time. Sometimes packages won’t set this correctly causing the library lookups to fail at runtime. This can be fixed by adding extra linker flags or by running `install_name_tool -id` during the `fixupPhase`.
20
+
21
+
```nix
22
+
stdenv.mkDerivation {
23
+
name = "libfoo-1.2.3";
24
+
# ...
25
+
makeFlags = lib.optional stdenv.isDarwin "LDFLAGS=-Wl,-install_name,$(out)/lib/libfoo.dylib";
26
+
}
27
+
```
28
+
29
+
- Even if the libraries are linked using absolute paths and resolved via their `install_name` correctly, tests can sometimes fail to run binaries. This happens because the `checkPhase` runs before the libraries are installed.
30
+
31
+
This can usually be solved by running the tests after the `installPhase` or alternatively by using `DYLD_LIBRARY_PATH`. More information about this variable can be found in the *dyld(1)* manpage.
32
+
33
+
```
34
+
dyld: Library not loaded: /nix/store/7hnmbscpayxzxrixrgxvvlifzlxdsdir-jq-1.5-lib/lib/libjq.1.dylib
35
+
Referenced from: /private/tmp/nix-build-jq-1.5.drv-0/jq-1.5/tests/../jq
36
+
Reason: image not found
37
+
./tests/jqtest: line 5: 75779 Abort trap: 6
38
+
```
39
+
40
+
```nix
41
+
stdenv.mkDerivation {
42
+
name = "libfoo-1.2.3";
43
+
# ...
44
+
doInstallCheck = true;
45
+
installCheckTarget = "check";
46
+
}
47
+
```
48
+
49
+
- Some packages assume xcode is available and use `xcrun` to resolve build tools like `clang`, etc. This causes errors like `xcode-select: error: no developer tools were found at '/Applications/Xcode.app'` while the build doesn’t actually depend on xcode.
50
+
51
+
```nix
52
+
stdenv.mkDerivation {
53
+
name = "libfoo-1.2.3";
54
+
# ...
55
+
prePatch = ''
56
+
substituteInPlace Makefile \
57
+
--replace '/usr/bin/xcrun clang' clang
58
+
'';
59
+
}
60
+
```
61
+
62
+
The package `xcbuild` can be used to build projects that really depend on Xcode. However, this replacement is not 100% compatible with Xcode and can occasionally cause issues.
-83
doc/stdenv/platform-notes.xml
-83
doc/stdenv/platform-notes.xml
···
1
-
<chapter xmlns="http://docbook.org/ns/docbook"
2
-
xmlns:xlink="http://www.w3.org/1999/xlink"
3
-
xml:id="chap-platform-notes">
4
-
<title>Platform Notes</title>
5
-
<section xml:id="sec-darwin">
6
-
<title>Darwin (macOS)</title>
7
-
8
-
<para>
9
-
Some common issues when packaging software for Darwin:
10
-
</para>
11
-
12
-
<itemizedlist>
13
-
<listitem>
14
-
<para>
15
-
The Darwin <literal>stdenv</literal> uses clang instead of gcc. When referring to the compiler <varname>$CC</varname> or <command>cc</command> will work in both cases. Some builds hardcode gcc/g++ in their build scripts, that can usually be fixed with using something like <literal>makeFlags = [ "CC=cc" ];</literal> or by patching the build scripts.
16
-
</para>
17
-
<programlisting>
18
-
stdenv.mkDerivation {
19
-
name = "libfoo-1.2.3";
20
-
# ...
21
-
buildPhase = ''
22
-
$CC -o hello hello.c
23
-
'';
24
-
}
25
-
</programlisting>
26
-
</listitem>
27
-
<listitem>
28
-
<para>
29
-
On Darwin, libraries are linked using absolute paths, libraries are resolved by their <literal>install_name</literal> at link time. Sometimes packages won't set this correctly causing the library lookups to fail at runtime. This can be fixed by adding extra linker flags or by running <command>install_name_tool -id</command> during the <function>fixupPhase</function>.
30
-
</para>
31
-
<programlisting>
32
-
stdenv.mkDerivation {
33
-
name = "libfoo-1.2.3";
34
-
# ...
35
-
makeFlags = lib.optional stdenv.isDarwin "LDFLAGS=-Wl,-install_name,$(out)/lib/libfoo.dylib";
36
-
}
37
-
</programlisting>
38
-
</listitem>
39
-
<listitem>
40
-
<para>
41
-
Even if the libraries are linked using absolute paths and resolved via their <literal>install_name</literal> correctly, tests can sometimes fail to run binaries. This happens because the <varname>checkPhase</varname> runs before the libraries are installed.
42
-
</para>
43
-
<para>
44
-
This can usually be solved by running the tests after the <varname>installPhase</varname> or alternatively by using <varname>DYLD_LIBRARY_PATH</varname>. More information about this variable can be found in the <citerefentry>
45
-
<refentrytitle>dyld</refentrytitle>
46
-
<manvolnum>1</manvolnum></citerefentry> manpage.
47
-
</para>
48
-
<programlisting>
49
-
dyld: Library not loaded: /nix/store/7hnmbscpayxzxrixrgxvvlifzlxdsdir-jq-1.5-lib/lib/libjq.1.dylib
50
-
Referenced from: /private/tmp/nix-build-jq-1.5.drv-0/jq-1.5/tests/../jq
51
-
Reason: image not found
52
-
./tests/jqtest: line 5: 75779 Abort trap: 6
53
-
</programlisting>
54
-
<programlisting>
55
-
stdenv.mkDerivation {
56
-
name = "libfoo-1.2.3";
57
-
# ...
58
-
doInstallCheck = true;
59
-
installCheckTarget = "check";
60
-
}
61
-
</programlisting>
62
-
</listitem>
63
-
<listitem>
64
-
<para>
65
-
Some packages assume xcode is available and use <command>xcrun</command> to resolve build tools like <command>clang</command>, etc. This causes errors like <code>xcode-select: error: no developer tools were found at '/Applications/Xcode.app'</code> while the build doesn't actually depend on xcode.
66
-
</para>
67
-
<programlisting>
68
-
stdenv.mkDerivation {
69
-
name = "libfoo-1.2.3";
70
-
# ...
71
-
prePatch = ''
72
-
substituteInPlace Makefile \
73
-
--replace '/usr/bin/xcrun clang' clang
74
-
'';
75
-
}
76
-
</programlisting>
77
-
<para>
78
-
The package <literal>xcbuild</literal> can be used to build projects that really depend on Xcode. However, this replacement is not 100% compatible with Xcode and can occasionally cause issues.
79
-
</para>
80
-
</listitem>
81
-
</itemizedlist>
82
-
</section>
83
-
</chapter>