commit 633b03c57f658d57a192eabb088b171b4542081e · pyrox.dev/nixpkgs

doc/manual.xml

···

       18
       18
        
         <xi:include href="functions.xml" />

     

       19
       19
        
         <xi:include href="meta.xml" />

     

       20
       20
        
         <xi:include href="languages-frameworks/index.xml" />

     

       21
       21
       +
         <xi:include href="platform-notes.xml" />

     

       21
       22
        
         <xi:include href="package-notes.xml" />

     

       22
       23
        
         <xi:include href="overlays.xml" />

     

       23
       24
        
         <xi:include href="coding-conventions.xml" />

+83

doc/platform-notes.xml

···

       1
       1
       +
       <chapter xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       +
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       +
                xml:id="chap-platform-nodes">

     

       4
       4
       +
       

     

       5
       5
       +
       <title>Platform Notes</title>

     

       6
       6
       +
       

     

       7
       7
       +
       <section xml:id="sec-darwin">

     

       8
       8
       +
       

     

       9
       9
       +
       <title>Darwin (macOS)</title>

     

       10
       10
       +
       <para>Some common issues when packaging software for darwin:</para>

     

       11
       11
       +
       

     

       12
       12
       +
       <itemizedlist>

     

       13
       13
       +
       

     

       14
       14
       +
         <listitem>

     

       15
       15
       +
           <para>

     

       16
       16
       +
             The darwin <literal>stdenv</literal> uses clang instead of gcc.

     

       17
       17
       +
             When referring to the compiler <varname>$CC</varname> or <command>cc</command>

     

       18
       18
       +
             will work in both cases.  Some builds hardcode gcc/g++ in their

     

       19
       19
       +
             build scripts, that can usually be fixed with using something

     

       20
       20
       +
             like <literal>makeFlags = [ "CC=cc" ];</literal> or by patching

     

       21
       21
       +
             the build scripts.

     

       22
       22
       +
           </para>

     

       23
       23
       +
       

     

       24
       24
       +
           <programlisting>

     

       25
       25
       +
             stdenv.mkDerivation {

     

       26
       26
       +
               name = "libfoo-1.2.3";

     

       27
       27
       +
               # ...

     

       28
       28
       +
               buildPhase = ''

     

       29
       29
       +
                 $CC -o hello hello.c

     

       30
       30
       +
               '';

     

       31
       31
       +
             }

     

       32
       32
       +
           </programlisting>

     

       33
       33
       +
         </listitem>

     

       34
       34
       +
       

     

       35
       35
       +
         <listitem>

     

       36
       36
       +
           <para>

     

       37
       37
       +
             On darwin libraries are linked using absolute paths, libraries

     

       38
       38
       +
             are resolved by their <literal>install_name</literal> at link

     

       39
       39
       +
             time.  Sometimes packages won't set this correctly causing the

     

       40
       40
       +
             library lookups to fail at runtime.  This can be fixed by adding

     

       41
       41
       +
             extra linker flags or by running <command>install_name_tool -id</command>

     

       42
       42
       +
             during the <function>fixupPhase</function>.

     

       43
       43
       +
           </para>

     

       44
       44
       +
       

     

       45
       45
       +
           <programlisting>

     

       46
       46
       +
             stdenv.mkDerivation {

     

       47
       47
       +
               name = "libfoo-1.2.3";

     

       48
       48
       +
               # ...

     

       49
       49
       +
               makeFlags = stdenv.lib.optional stdenv.isDarwin "LDFLAGS=-Wl,-install_name,$(out)/lib/libfoo.dylib";

     

       50
       50
       +
             }

     

       51
       51
       +
           </programlisting>

     

       52
       52
       +
         </listitem>

     

       53
       53
       +
       

     

       54
       54
       +
         <listitem>

     

       55
       55
       +
           <para>

     

       56
       56
       +
             Some packages assume xcode is available and use <command>xcrun</command>

     

       57
       57
       +
             to resolve build tools like <command>clang</command>, etc.

     

       58
       58
       +
             This causes errors like <code>xcode-select: error: no developer tools were found at '/Applications/Xcode.app'</code>

     

       59
       59
       +
             while the build doesn't actually depend on xcode.

     

       60
       60
       +
           </para>

     

       61
       61
       +
       

     

       62
       62
       +
           <programlisting>

     

       63
       63
       +
             stdenv.mkDerivation {

     

       64
       64
       +
               name = "libfoo-1.2.3";

     

       65
       65
       +
               # ...

     

       66
       66
       +
               prePatch = ''

     

       67
       67
       +
                 substituteInPlace Makefile \

     

       68
       68
       +
                     --replace '/usr/bin/xcrun clang' clang

     

       69
       69
       +
               '';

     

       70
       70
       +
             }

     

       71
       71
       +
           </programlisting>

     

       72
       72
       +
       

     

       73
       73
       +
           <para>

     

       74
       74
       +
             The package <literal>xcbuild</literal> can be used to build projects

     

       75
       75
       +
             that really depend on Xcode, however projects that build some kind of

     

       76
       76
       +
             graphical interface won't work without using Xcode in an impure way.

     

       77
       77
       +
           </para>

     

       78
       78
       +
         </listitem>

     

       79
       79
       +
       

     

       80
       80
       +
       </itemizedlist>

     

       81
       81
       +
       </section>

     

       82
       82
       +
       

     

       83
       83
       +
       </chapter>