commit 53b5d946e15b7865d5aefb1bd566bca475727e7c · pyrox.dev/nixpkgs

+3 -3

doc/coding-conventions.xml

···

       5
       5
        
       <title>Coding conventions</title>

     

       6
       6
        
       

     

       7
       7
        
       

     

       8
       8
       -
       <section><title>Syntax</title>

     

       8
       8
       +
       <section xml:id="sec-syntax"><title>Syntax</title>

     

       9
       9
        
       

     

       10
       10
        
       <itemizedlist>

     

       11
       11
        
       

     
···

       207
       207
        
       </section>

     

       208
       208
        
       

     

       209
       209
        
       

     

       210
       210
       -
       <section><title>Package naming</title>

     

       210
       210
       +
       <section xml:id="sec-package-naming"><title>Package naming</title>

     

       211
       211
        
       

     

       212
       212
        
       <para>In Nixpkgs, there are generally three different names associated with a package:

     

       213
       213
        
       

     
···

       292
       292
        
       <filename>allPackages.nix</filename> or

     

       293
       293
        
       <filename>AllPackages.nix</filename>.</para>

     

       294
       294
        
       

     

       295
       295
       -
       <section><title>Hierarchy</title>

     

       295
       295
       +
       <section xml:id="sec-hierarchy"><title>Hierarchy</title>

     

       296
       296
        
       

     

       297
       297
        
       <para>Each package should be stored in its own directory somewhere in

     

       298
       298
        
       the <filename>pkgs/</filename> tree, i.e. in

+14 -14

doc/language-support.xml

···

       13
       13
        
       such as Perl or Haskell.  These are described in this chapter.</para>

     

       14
       14
        
       

     

       15
       15
        
       

     

       16
       16
       -
       <section xml:id="ssec-language-perl"><title>Perl</title>

     

       16
       16
       +
       <section xml:id="sec-language-perl"><title>Perl</title>

     

       17
       17
        
       

     

       18
       18
        
       <para>Nixpkgs provides a function <varname>buildPerlPackage</varname>,

     

       19
       19
        
       a generic package builder function for any Perl package that has a

     
···

       151
       151
        
       

     

       152
       152
        
       </para>

     

       153
       153
        
       

     

       154
       154
       -
       <section><title>Generation from CPAN</title>

     

       154
       154
       +
       <section xml:id="ssec-generation-from-CPAN"><title>Generation from CPAN</title>

     

       155
       155
        
       

     

       156
       156
        
       <para>Nix expressions for Perl packages can be generated (almost)

     

       157
       157
        
       automatically from CPAN.  This is done by the program

     
···

       191
       191
        
       </section>

     

       192
       192
        
       

     

       193
       193
        
       

     

       194
       194
       -
       <section xml:id="python"><title>Python</title>

     

       194
       194
       +
       <section xml:id="sec-python"><title>Python</title>

     

       195
       195
        
       

     

       196
       196
        
       <para>

     

       197
       197
        
         Currently supported interpreters are <varname>python26</varname>, <varname>python27</varname>,

     
···

       276
       276
        
         </varlistentry>

     

       277
       277
        
       

     

       278
       278
        
       </variablelist>

     

       279
       279
       -
       <section xml:id="build-python-package"><title><varname>buildPythonPackage</varname> function</title>

     

       279
       279
       +
       <section xml:id="ssec-build-python-package"><title><varname>buildPythonPackage</varname> function</title>

     

       280
       280
        
       

     

       281
       281
        
         <para>

     

       282
       282
        
         The function is implemented in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/python-modules/generic/default.nix">

     
···

       438
       438
        
       

     

       439
       439
        
       </section>

     

       440
       440
        
       

     

       441
       441
       -
       <section xml:id="python-build-env"><title><function>python.buildEnv</function> function</title>

     

       441
       441
       +
       <section xml:id="ssec-python-build-env"><title><function>python.buildEnv</function> function</title>

     

       442
       442
        
         <para>

     

       443
       443
        
           Create Python environments using low-level <function>pkgs.buildEnv</function> function. Example <filename>default.nix</filename>:

     

       444
       444
        
       

     
···

       484
       484
        
         </variablelist>

     

       485
       485
        
       </section>

     

       486
       486
        
       

     

       487
       487
       -
       <section xml:id="python-tools"><title>Tools</title>

     

       487
       487
       +
       <section xml:id="ssec-python-tools"><title>Tools</title>

     

       488
       488
        
       

     

       489
       489
        
       <para>Packages inside nixpkgs are written by hand. However many tools

     

       490
       490
        
       exist in community to help save time. No tool is preferred at the moment.

     
···

       511
       511
        
       

     

       512
       512
        
       </section>

     

       513
       513
        
       

     

       514
       514
       -
       <section xml:id="python-development"><title>Development</title>

     

       514
       514
       +
       <section xml:id="ssec-python-development"><title>Development</title>

     

       515
       515
        
       

     

       516
       516
        
         <para>

     

       517
       517
        
           To develop Python packages <function>buildPythonPackage</function> has

     
···

       555
       555
        
       

     

       556
       556
        
       </section>

     

       557
       557
        
       

     

       558
       558
       -
       <section xml:id="python-faq"><title>FAQ</title>

     

       558
       558
       +
       <section xml:id="ssec-python-faq"><title>FAQ</title>

     

       559
       559
        
       

     

       560
       560
        
       <variablelist>

     

       561
       561
        
       

     
···

       597
       597
        
       </section>

     

       598
       598
        
       

     

       599
       599
        
       

     

       600
       600
       -
       <section xml:id="python-contrib"><title>Contributing guidelines</title>

     

       600
       600
       +
       <section xml:id="ssec-python-contrib"><title>Contributing guidelines</title>

     

       601
       601
        
       <para>

     

       602
       602
        
         Following rules are desired to be respected:

     

       603
       603
        
       </para>

     
···

       625
       625
        
       </section>

     

       626
       626
        
       

     

       627
       627
        
       

     

       628
       628
       -
       <section xml:id="ssec-language-ruby"><title>Ruby</title>

     

       628
       628
       +
       <section xml:id="sec-language-ruby"><title>Ruby</title>

     

       629
       629
        
         <para>There currently is support to bundle applications that are packaged as Ruby gems. The utility "bundix" allows you to write a <filename>Gemfile</filename>, let bundler create a <filename>Gemfile.lock</filename>, and then convert

     

       630
       630
        
         this into a nix expression that contains all Gem dependencies automatically.</para>

     

       631
       631
        
       

     
···

       666
       666
        
       

     

       667
       667
        
       </section>

     

       668
       668
        
       

     

       669
       669
       -
       <section xml:id="ssec-language-go"><title>Go</title>

     

       669
       669
       +
       <section xml:id="sec-language-go"><title>Go</title>

     

       670
       670
        
       

     

       671
       671
        
       <para>The function <varname>buildGoPackage</varname> builds

     

       672
       672
        
       standard Go packages.

     
···

       787
       787
        
       </section>

     

       788
       788
        
       

     

       789
       789
        
       

     

       790
       790
       -
       <section xml:id="ssec-language-java"><title>Java</title>

     

       790
       790
       +
       <section xml:id="sec-language-java"><title>Java</title>

     

       791
       791
        
       

     

       792
       792
        
       <para>Ant-based Java packages are typically built from source as follows:

     

       793
       793
        
       

     
···

       868
       868
        
       </section>

     

       869
       869
        
       

     

       870
       870
        
       

     

       871
       871
       -
       <section xml:id="ssec-language-lua"><title>Lua</title>

     

       871
       871
       +
       <section xml:id="sec-language-lua"><title>Lua</title>

     

       872
       872
        
       

     

       873
       873
        
       <para>

     

       874
       874
        
         Lua packages are built by the <varname>buildLuaPackage</varname> function.  This function is

     
···

       915
       915
        
       

     

       916
       916
        
       </section>

     

       917
       917
        
       

     

       918
       918
       -
       <section xml:id="ssec-language-coq"><title>Coq</title>

     

       918
       918
       +
       <section xml:id="sec-language-coq"><title>Coq</title>

     

       919
       919
        
         <para>

     

       920
       920
        
           Coq libraries should be installed in

     

       921
       921
        
           <literal>$(out)/lib/coq/${coq.coq-version}/user-contrib/</literal>.

+2 -1

doc/meta.xml

···

       82
       82
        
       </para>

     

       83
       83
        
       

     

       84
       84
        
       

     

       85
       85
       -
       <section><title>Standard meta-attributes</title>

     

       85
       85
       +
       <section xml:id="sec-standard-meta-attributes"><title>Standard

     

       86
       86
       +
       meta-attributes</title>

     

       86
       87
        
       

     

       87
       88
        
       <para>It is expected that each meta-attribute is one of the following:</para>

     

       88
       89

+1 -1

doc/package-notes.xml

···

       141
       141
        
       

     

       142
       142
        
       <!--============================================================-->

     

       143
       143
        
       

     

       144
       144
       -
       <section>

     

       144
       144
       +
       <section xml:id="sec-xorg">

     

       145
       145
        
       

     

       146
       146
        
       <title>X.org</title>

     

       147
       147

+2 -1

doc/packageconfig.xml

···

       67
       67
        
       	<filename>lib/licenses.nix</filename> of the nix package tree.

     

       68
       68
        
           </para>

     

       69
       69
        
       

     

       70
       70
       -
       <section><title>Modify packages via <literal>packageOverrides</literal></title>

     

       70
       70
       +
       <section xml:id="sec-modify-via-packageOverrides"><title>Modify

     

       71
       71
       +
       packages via <literal>packageOverrides</literal></title>

     

       71
       72
        
       

     

       72
       73
        
       <para>

     

       73
       74

+17 -13

doc/stdenv.xml

···

       15
       15
        
       can easily customise or override the various build phases.</para>

     

       16
       16
        
       

     

       17
       17
        
       

     

       18
       18
       -
       <section><title>Using <literal>stdenv</literal></title>

     

       18
       18
       +
       <section xml:id="sec-using-stdenv"><title>Using

     

       19
       19
       +
       <literal>stdenv</literal></title>

     

       19
       20
        
       

     

       20
       21
        
       <para>To build a package with the standard environment, you use the

     

       21
       22
        
       function <varname>stdenv.mkDerivation</varname>, instead of the

     
···

       124
       125
        
       </section>

     

       125
       126
        
       

     

       126
       127
        
       

     

       127
       127
       -
       <section><title>Tools provided by <literal>stdenv</literal></title>

     

       128
       128
       +
       <section xml:id="sec-tools-of-stdenv"><title>Tools provided by

     

       129
       129
       +
       <literal>stdenv</literal></title>

     

       128
       130
        
       

     

       129
       131
        
       <para>The standard environment provides the following packages:

     

       130
       132
        
       

     
···

       225
       227
        
       </section>

     

       226
       228
        
       

     

       227
       229
        
       

     

       228
       228
       -
       <section xml:id="ssec-stdenv-phases"><title>Phases</title>

     

       230
       230
       +
       <section xml:id="sec-stdenv-phases"><title>Phases</title>

     

       229
       231
        
       

     

       230
       232
        
       <para>The generic builder has a number of <emphasis>phases</emphasis>.

     

       231
       233
        
       Package builds are split into phases to make it easier to override

     
···

       243
       245
        
       latter is convenient from a build script.</para>

     

       244
       246
        
       

     

       245
       247
        
       

     

       246
       246
       -
       <section><title>Controlling phases</title>

     

       248
       248
       +
       <section xml:id="ssec-controlling-phases"><title>Controlling

     

       249
       249
       +
       phases</title>

     

       247
       250
        
       

     

       248
       251
        
       <para>There are a number of variables that control what phases are

     

       249
       252
        
       executed and in what order:

     
···

       327
       330
        
       </section>

     

       328
       331
        
       

     

       329
       332
        
       

     

       330
       330
       -
       <section><title>The unpack phase</title>

     

       333
       333
       +
       <section xml:id="ssec-unpack-phase"><title>The unpack phase</title>

     

       331
       334
        
       

     

       332
       335
        
       <para>The unpack phase is responsible for unpacking the source code of

     

       333
       336
        
       the package.  The default implementation of

     
···

       434
       437
        
       </section>

     

       435
       438
        
       

     

       436
       439
        
       

     

       437
       437
       -
       <section><title>The patch phase</title>

     

       440
       440
       +
       <section xml:id="ssec-patch-phase"><title>The patch phase</title>

     

       438
       441
        
       

     

       439
       442
        
       <para>The patch phase applies the list of patches defined in the

     

       440
       443
        
       <varname>patches</varname> variable.</para>

     
···

       477
       480
        
       </section>

     

       478
       481
        
       

     

       479
       482
        
       

     

       480
       480
       -
       <section><title>The configure phase</title>

     

       483
       483
       +
       <section xml:id="ssec-configure-phase"><title>The configure phase</title>

     

       481
       484
        
       

     

       482
       485
        
       <para>The configure phase prepares the source tree for building.  The

     

       483
       486
        
       default <function>configurePhase</function> runs

     
···

       573
       576
        
       </section>

     

       574
       577
        
       

     

       575
       578
        
       

     

       576
       576
       -
       <section><title>The build phase</title>

     

       579
       579
       +
       <section xml:id="build-phase"><title>The build phase</title>

     

       577
       580
        
       

     

       578
       581
        
       <para>The build phase is responsible for actually building the package

     

       579
       582
        
       (e.g. compiling it).  The default <function>buildPhase</function>

     
···

       657
       660
        
       </section>

     

       658
       661
        
       

     

       659
       662
        
       

     

       660
       660
       -
       <section><title>The check phase</title>

     

       663
       663
       +
       <section xml:id="ssec-check-phase"><title>The check phase</title>

     

       661
       664
        
       

     

       662
       665
        
       <para>The check phase checks whether the package was built correctly

     

       663
       666
        
       by running its test suite.  The default

     
···

       717
       720
        
       </section>

     

       718
       721
        
       

     

       719
       722
        
       

     

       720
       720
       -
       <section><title>The install phase</title>

     

       723
       723
       +
       <section xml:id="ssec-install-phase"><title>The install phase</title>

     

       721
       724
        
       

     

       722
       725
        
       <para>The install phase is responsible for installing the package in

     

       723
       726
        
       the Nix store under <envar>out</envar>.  The default

     
···

       772
       775
        
       </section>

     

       773
       776
        
       

     

       774
       777
        
       

     

       775
       775
       -
       <section><title>The fixup phase</title>

     

       778
       778
       +
       <section xml:id="ssec-fixup-phase"><title>The fixup phase</title>

     

       776
       779
        
       

     

       777
       780
        
       <para>The fixup phase performs some (Nix-specific) post-processing

     

       778
       781
        
       actions on the files installed under <filename>$out</filename> by the

     
···

       895
       898
        
       </section>

     

       896
       899
        
       

     

       897
       900
        
       

     

       898
       898
       -
       <section><title>The distribution phase</title>

     

       901
       901
       +
       <section xml:id="ssec-distribution-phase"><title>The distribution

     

       902
       902
       +
       phase</title>

     

       899
       903
        
       

     

       900
       904
        
       <para>The distribution phase is intended to produce a source

     

       901
       905
        
       distribution of the package.  The default

     
···

       1199
       1203
        
       </section>

     

       1200
       1204
        
       

     

       1201
       1205
        
       

     

       1202
       1202
       -
       <section><title>Purity in Nixpkgs</title>

     

       1206
       1206
       +
       <section xml:id="sec-purity-in-nixpkgs"><title>Purity in Nixpkgs</title>

     

       1203
       1207
        
       

     

       1204
       1208
        
       <para>[measures taken to prevent dependencies on packages outside the

     

       1205
       1209
        
       store, and what you can do to prevent them]</para>