commit 03b89e3031bb983fcc59a9f7794157e2e7b67102 · pyrox.dev/nixpkgs

+6 -6

doc/cross-compilation.xml

···

       30
       30
        
        <section xml:id="sec-cross-packaging">

     

       31
       31
        
         <title>Packaging in a cross-friendly manner</title>

     

       32
       32
        
       

     

       33
       33
       -
         <section>

     

       33
       33
       +
         <section xml:id="sec-cross-platform-parameters">

     

       34
       34
        
          <title>Platform parameters</title>

     

       35
       35
        
       

     

       36
       36
        
          <para>

     
···

       219
       219
        
          </variablelist>

     

       220
       220
        
         </section>

     

       221
       221
        
       

     

       222
       222
       -
         <section>

     

       222
       222
       +
         <section xml:id="sec-cross-specifying-dependencies">

     

       223
       223
        
          <title>Specifying Dependencies</title>

     

       224
       224
        
       

     

       225
       225
        
          <para>

     
···

       304
       304
        
          </note>

     

       305
       305
        
         </section>

     

       306
       306
        
       

     

       307
       307
       -
         <section>

     

       307
       307
       +
         <section xml:id="sec-cross-cookbook">

     

       308
       308
        
          <title>Cross packaging cookbook</title>

     

       309
       309
        
       

     

       310
       310
        
          <para>

     
···

       317
       317
        
          </para>

     

       318
       318
        
       

     

       319
       319
        
          <qandaset>

     

       320
       320
       -
           <qandaentry>

     

       320
       320
       +
           <qandaentry xml:id="cross-qa-build-c-program-in-build-environment">

     

       321
       321
        
            <question>

     

       322
       322
        
             <para>

     

       323
       323
        
              What if my package's build system needs to build a C program to be run

     
···

       331
       331
        
             </para>

     

       332
       332
        
            </answer>

     

       333
       333
        
           </qandaentry>

     

       334
       334
       -
           <qandaentry>

     

       334
       334
       +
           <qandaentry xml:id="cross-qa-fails-to-find-ar">

     

       335
       335
        
            <question>

     

       336
       336
        
             <para>

     

       337
       337
        
              My package fails to find <command>ar</command>.

     
···

       347
       347
        
             </para>

     

       348
       348
        
            </answer>

     

       349
       349
        
           </qandaentry>

     

       350
       350
       -
           <qandaentry>

     

       350
       350
       +
           <qandaentry xml:id="cross-testsuite-runs-host-code">

     

       351
       351
        
            <question>

     

       352
       352
        
             <para>

     

       353
       353
        
              My package's testsuite needs to run host platform code.

+2 -2

doc/languages-frameworks/texlive.xml

···

       8
       8
        
         under attribute <varname>texlive</varname>.

     

       9
       9
        
        </para>

     

       10
       10
        
       

     

       11
       11
       -
        <section>

     

       11
       11
       +
        <section xml:id="sec-language-texlive-users-guide">

     

       12
       12
        
         <title>User's guide</title>

     

       13
       13
        
       

     

       14
       14
        
         <itemizedlist>

     
···

       68
       68
        
         </itemizedlist>

     

       69
       69
        
        </section>

     

       70
       70
        
       

     

       71
       71
       -
        <section>

     

       71
       71
       +
        <section xml:id="sec-language-texlive-known-problems">

     

       72
       72
        
         <title>Known problems</title>

     

       73
       73
        
       

     

       74
       74
        
         <itemizedlist>

+5 -5

doc/multiple-output.xml

···

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

     

       7
       7
        
                xml:id="chap-multiple-output">

     

       8
       8
        
        <title>Multiple-output packages</title>

     

       9
       9
       -
        <section>

     

       9
       9
       +
        <section xml:id="sec-multiple-outputs-introduction">

     

       10
       10
        
         <title>Introduction</title>

     

       11
       11
        
       

     

       12
       12
        
         <para>

     
···

       38
       38
        
          </para>

     

       39
       39
        
         </note>

     

       40
       40
        
        </section>

     

       41
       41
       -
        <section>

     

       41
       41
       +
        <section xml:id="sec-multiple-outputs-installing">

     

       42
       42
        
         <title>Installing a split package</title>

     

       43
       43
        
       

     

       44
       44
        
         <para>

     
···

       84
       84
        
          </listitem>

     

       85
       85
        
         </itemizedlist>

     

       86
       86
        
        </section>

     

       87
       87
       -
        <section>

     

       87
       87
       +
        <section xml:id="sec-multiple-outputs-using-split-packages">

     

       88
       88
        
         <title>Using a split package</title>

     

       89
       89
        
       

     

       90
       90
        
         <para>

     
···

       102
       102
        
          also added. (See <xref linkend="multiple-output-file-type-groups" />.)

     

       103
       103
        
         </para>

     

       104
       104
        
        </section>

     

       105
       105
       -
        <section>

     

       105
       105
       +
        <section xml:id="sec-multiple-outputs-">

     

       106
       106
        
         <title>Writing a split derivation</title>

     

       107
       107
        
       

     

       108
       108
        
         <para>

     
···

       283
       283
        
          </variablelist>

     

       284
       284
        
         </section>

     

       285
       285
        
       

     

       286
       286
       -
         <section>

     

       286
       286
       +
         <section xml:id="sec-multiple-outputs-caveats">

     

       287
       287
        
          <title>Common caveats</title>

     

       288
       288
        
       

     

       289
       289
        
          <itemizedlist>

+2 -2

doc/package-notes.xml

···

       181
       181
        
        </section>

     

       182
       182
        
       <!--============================================================-->

     

       183
       183
        
       <!--

     

       184
       184
       -
       <section>

     

       184
       184
       +
       <section xml:id="sec-package-notes-gnome">

     

       185
       185
        
         <title>Gnome</title>

     

       186
       186
        
         <para>* Expression is auto-generated</para>

     

       187
       187
        
         <para>* How to update</para>

     
···

       189
       189
        
       -->

     

       190
       190
        
       <!--============================================================-->

     

       191
       191
        
       <!--

     

       192
       192
       -
       <section>

     

       192
       192
       +
       <section xml:id="sec-package-notes-gcc">

     

       193
       193
        
         <title>GCC</title>

     

       194
       194
        
         <para>…</para>

     

       195
       195
        
       </section>

+8 -8

doc/release-notes.xml

···

       2
       2
        
       <article xmlns="http://docbook.org/ns/docbook"

     

       3
       3
        
                xmlns:xlink="http://www.w3.org/1999/xlink">

     

       4
       4
        
        <title>Nixpkgs Release Notes</title>

     

       5
       5
       -
        <section>

     

       5
       5
       +
        <section xml:id="release-notes-0.14">

     

       6
       6
        
         <title>Release 0.14 (June 4, 2012)</title>

     

       7
       7
        
       

     

       8
       8
        
         <para>

     
···

       17
       17
        
          packages by numerous contributors. For details, see the commit logs.

     

       18
       18
        
         </para>

     

       19
       19
        
        </section>

     

       20
       20
       -
        <section>

     

       20
       20
       +
        <section xml:id="release-notes-0.13">

     

       21
       21
        
         <title>Release 0.13 (February 5, 2010)</title>

     

       22
       22
        
       

     

       23
       23
        
         <para>

     
···

       51
       51
        
          </itemizedlist>

     

       52
       52
        
         </para>

     

       53
       53
        
        </section>

     

       54
       54
       -
        <section>

     

       54
       54
       +
        <section xml:id="release-notes-0.12">

     

       55
       55
        
         <title>Release 0.12 (April 24, 2009)</title>

     

       56
       56
        
       

     

       57
       57
        
         <para>

     
···

       145
       145
        
          <literal>nix-dev</literal> mailing list.

     

       146
       146
        
         </para>

     

       147
       147
        
        </section>

     

       148
       148
       -
        <section>

     

       148
       148
       +
        <section xml:id="release-notes-0.11">

     

       149
       149
        
         <title>Release 0.11 (September 11, 2007)</title>

     

       150
       150
        
       

     

       151
       151
        
         <para>

     
···

       344
       344
        
          Bravenboer, Michael Raskin, Wouter den Breejen and Yury G. Kudryashov.

     

       345
       345
        
         </para>

     

       346
       346
        
        </section>

     

       347
       347
       -
        <section>

     

       347
       347
       +
        <section xml:id="release-notes-0.10">

     

       348
       348
        
         <title>Release 0.10 (October 12, 2006)</title>

     

       349
       349
        
       

     

       350
       350
        
         <note>

     
···

       547
       547
        
          Bravenboer, Merijn de Jonge, Rob Vermaas and Roy van den Broek.

     

       548
       548
        
         </para>

     

       549
       549
        
        </section>

     

       550
       550
       -
        <section>

     

       550
       550
       +
        <section xml:id="release-notes-0.9">

     

       551
       551
        
         <title>Release 0.9 (January 31, 2006)</title>

     

       552
       552
        
       

     

       553
       553
        
         <para>

     
···

       676
       676
        
          Martin Bravenboer, Rob Vermaas and Roy van den Broek.

     

       677
       677
        
         </para>

     

       678
       678
        
        </section>

     

       679
       679
       -
        <section>

     

       679
       679
       +
        <section xml:id="release-notes-0.8">

     

       680
       680
        
         <title>Release 0.8 (April 11, 2005)</title>

     

       681
       681
        
       

     

       682
       682
        
         <para>

     
···

       700
       700
        
          </itemizedlist>

     

       701
       701
        
         </para>

     

       702
       702
        
        </section>

     

       703
       703
       -
        <section>

     

       703
       703
       +
        <section xml:id="release-notes-0.7">

     

       704
       704
        
         <title>Release 0.7 (March 14, 2005)</title>

     

       705
       705
        
       

     

       706
       706
        
         <itemizedlist>

+10 -10

doc/reviewing-contributions.xml

···

       56
       56
        
         meant as examples. Their usage is optional and the reviewer is free to adapt

     

       57
       57
        
         them to their liking.

     

       58
       58
        
        </para>

     

       59
       59
       -
        <section>

     

       59
       59
       +
        <section xml:id="reviewing-contributions-package-updates">

     

       60
       60
        
         <title>Package updates</title>

     

       61
       61
        
       

     

       62
       62
        
         <para>

     
···

       208
       208
        
          </listitem>

     

       209
       209
        
         </itemizedlist>

     

       210
       210
        
       

     

       211
       211
       -
         <example>

     

       211
       211
       +
         <example xml:id="reviewing-contributions-sample-package-update">

     

       212
       212
        
          <title>Sample template for a package update review</title>

     

       213
       213
        
       <screen>

     

       214
       214
        
       ##### Reviewed points

     
···

       226
       226
        
       </screen>

     

       227
       227
        
         </example>

     

       228
       228
        
        </section>

     

       229
       229
       -
        <section>

     

       229
       229
       +
        <section xml:id="reviewing-contributions-new-packages">

     

       230
       230
        
         <title>New packages</title>

     

       231
       231
        
       

     

       232
       232
        
         <para>

     
···

       320
       320
        
          </listitem>

     

       321
       321
        
         </itemizedlist>

     

       322
       322
        
       

     

       323
       323
       -
         <example>

     

       323
       323
       +
         <example xml:id="reviewing-contributions-sample-new-package">

     

       324
       324
        
          <title>Sample template for a new package review</title>

     

       325
       325
        
       <screen>

     

       326
       326
        
       ##### Reviewed points

     
···

       346
       346
        
       </screen>

     

       347
       347
        
         </example>

     

       348
       348
        
        </section>

     

       349
       349
       -
        <section>

     

       349
       349
       +
        <section xml:id="reviewing-contributions-module-updates">

     

       350
       350
        
         <title>Module updates</title>

     

       351
       351
        
       

     

       352
       352
        
         <para>

     
···

       443
       443
        
          </listitem>

     

       444
       444
        
         </itemizedlist>

     

       445
       445
        
       

     

       446
       446
       -
         <example>

     

       446
       446
       +
         <example xml:id="reviewing-contributions-sample-module-update">

     

       447
       447
        
          <title>Sample template for a module update review</title>

     

       448
       448
        
       <screen>

     

       449
       449
        
       ##### Reviewed points

     
···

       464
       464
        
       </screen>

     

       465
       465
        
         </example>

     

       466
       466
        
        </section>

     

       467
       467
       -
        <section>

     

       467
       467
       +
        <section xml:id="reviewing-contributions-new-modules">

     

       468
       468
        
         <title>New modules</title>

     

       469
       469
        
       

     

       470
       470
        
         <para>

     
···

       542
       542
        
          </listitem>

     

       543
       543
        
         </itemizedlist>

     

       544
       544
        
       

     

       545
       545
       -
         <example>

     

       545
       545
       +
         <example xml:id="reviewing-contributions-sample-new-module">

     

       546
       546
        
          <title>Sample template for a new module review</title>

     

       547
       547
        
       <screen>

     

       548
       548
        
       ##### Reviewed points

     
···

       564
       564
        
       </screen>

     

       565
       565
        
         </example>

     

       566
       566
        
        </section>

     

       567
       567
       -
        <section>

     

       567
       567
       +
        <section xml:id="reviewing-contributions-other-submissions">

     

       568
       568
        
         <title>Other submissions</title>

     

       569
       569
        
       

     

       570
       570
        
         <para>

     
···

       585
       585
        
          pull requests fitting this category.

     

       586
       586
        
         </para>

     

       587
       587
        
        </section>

     

       588
       588
       -
        <section>

     

       588
       588
       +
        <section xml:id="reviewing-contributions--merging-pull-requests">

     

       589
       589
        
         <title>Merging pull-requests</title>

     

       590
       590
        
       

     

       591
       591
        
         <para>

+7 -7

doc/stdenv.xml

···

       212
       212
        
          platforms relative to the new derivation's, and whether they are propagated.

     

       213
       213
        
          The platform distinctions are motivated by cross compilation; see

     

       214
       214
        
          <xref linkend="chap-cross"/> for exactly what each platform means.

     

       215
       215
       -
          <footnote>

     

       215
       215
       +
          <footnote xml:id="footnote-stdenv-ignored-build-platform">

     

       216
       216
        
           <para>

     

       217
       217
        
            The build platform is ignored because it is a mere implementation detail

     

       218
       218
        
            of the package satisfying the dependency: As a general programming

     
···

       233
       233
        
          out only for dependencies whose host platform matches the new derivation's

     

       234
       234
        
          build platform–i.e. which run on the platform where the new derivation

     

       235
       235
        
          will be built.

     

       236
       236
       -
          <footnote>

     

       236
       236
       +
          <footnote xml:id="footnote-stdenv-native-dependencies-in-path">

     

       237
       237
        
           <para>

     

       238
       238
        
            Currently, that means for native builds all dependencies are put on the

     

       239
       239
        
            <envar>PATH</envar>. But in the future that may not be the case for sake

     
···

       280
       280
        
          <link xlink:href="https://en.wikipedia.org/wiki/Natural_deduction">Natural

     

       281
       281
        
          Deduction</link> using the inference rules. This probably seems a bit

     

       282
       282
        
          obtuse, but so is the bash code that actually implements it!

     

       283
       283
       -
          <footnote>

     

       283
       283
       +
          <footnote xml:id="footnote-stdenv-find-inputs-location">

     

       284
       284
        
           <para>

     

       285
       285
        
            The <function>findInputs</function> function, currently residing in

     

       286
       286
        
            <filename>pkgs/stdenv/generic/setup.sh</filename>, implements the

     
···

       1112
       1112
        
              By default, the configure phase applies some special hackery to all

     

       1113
       1113
        
              files called <filename>ltmain.sh</filename> before running the configure

     

       1114
       1114
        
              script in order to improve the purity of Libtool-based packages

     

       1115
       1115
       -
              <footnote>

     

       1115
       1115
       +
              <footnote xml:id="footnote-stdenv-sys-lib-search-path">

     

       1116
       1116
        
               <para>

     

       1117
       1117
        
                It clears the

     

       1118
       1118
        
                <varname>sys_lib_<replaceable>*</replaceable>search_path</varname>

     
···

       1151
       1151
        
              or a subset to control exactly which platform flags are passed.

     

       1152
       1152
        
              Compilers and other tools should use this to also pass the target

     

       1153
       1153
        
              platform, for example.

     

       1154
       1154
       -
              <footnote>

     

       1154
       1154
       +
              <footnote xml:id="footnote-stdenv-build-time-guessing-impurity">

     

       1155
       1155
        
               <para>

     

       1156
       1156
        
                Eventually these will be passed when in native builds too, to improve

     

       1157
       1157
        
                determinism: build-time guessing, as is done today, is a risk of

     
···

       1732
       1732
        
              Controls whether the installCheck phase is executed. By default it is

     

       1733
       1733
        
              skipped, but if <varname>doInstallCheck</varname> is set to true, the

     

       1734
       1734
        
              installCheck phase is usually executed. Thus you should set

     

       1735
       1735
       -
              <programlisting>doInstallCheck = true;</programlisting>

     

       1735
       1735
       +
       <programlisting>doInstallCheck = true;</programlisting>

     

       1736
       1736
        
              in the derivation to enable install checks. The exception is cross

     

       1737
       1737
        
              compilation. Cross compiled builds never run tests, no matter how

     

       1738
       1738
        
              <varname>doInstallCheck</varname> is set, as the newly-built program

     
···

       2213
       2213
        
              <command>clang</command> is to be used. Secondly, this helps packages

     

       2214
       2214
        
              not get confused when cross-compiling, in which case multiple Bintools

     

       2215
       2215
        
              Wrappers may simultaneously be in use.

     

       2216
       2216
       -
              <footnote>

     

       2216
       2216
       +
              <footnote xml:id="footnote-stdenv-per-platform-wrapper">

     

       2217
       2217
        
               <para>

     

       2218
       2218
        
                Each wrapper targets a single platform, so if binaries for multiple

     

       2219
       2219
        
                platforms are needed, the underlying binaries must be wrapped multiple

+15 -15

doc/submitting-changes.xml

···

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

     

       3
       3
        
                xml:id="chap-submitting-changes">

     

       4
       4
        
        <title>Submitting changes</title>

     

       5
       5
       -
        <section>

     

       5
       5
       +
        <section xml:id="submitting-changes-making-patches">

     

       6
       6
        
         <title>Making patches</title>

     

       7
       7
        
       

     

       8
       8
        
         <itemizedlist>

     
···

       205
       205
        
          </listitem>

     

       206
       206
        
         </itemizedlist>

     

       207
       207
        
        </section>

     

       208
       208
       -
        <section>

     

       208
       208
       +
        <section xml:id="submitting-changes-submitting-changes">

     

       209
       209
        
         <title>Submitting changes</title>

     

       210
       210
        
       

     

       211
       211
        
         <itemizedlist>

     
···

       253
       253
        
          </listitem>

     

       254
       254
        
         </itemizedlist>

     

       255
       255
        
        </section>

     

       256
       256
       -
        <section>

     

       256
       256
       +
        <section xml:id="submitting-changes-pull-request-template">

     

       257
       257
        
         <title>Pull Request Template</title>

     

       258
       258
        
       

     

       259
       259
        
         <para>

     
···

       269
       269
        
          below:

     

       270
       270
        
         </para>

     

       271
       271
        
       

     

       272
       272
       -
         <section>

     

       272
       272
       +
         <section xml:id="submitting-changes-tested-with-sandbox">

     

       273
       273
        
          <title>Tested using sandboxing</title>

     

       274
       274
        
       

     

       275
       275
        
          <para>

     
···

       322
       322
        
          </para>

     

       323
       323
        
         </section>

     

       324
       324
        
       

     

       325
       325
       -
         <section>

     

       325
       325
       +
         <section xml:id="submitting-changes-platform-diversity">

     

       326
       326
        
          <title>Built on platform(s)</title>

     

       327
       327
        
       

     

       328
       328
        
          <para>

     
···

       334
       334
        
          </para>

     

       335
       335
        
         </section>

     

       336
       336
        
       

     

       337
       337
       -
         <section>

     

       337
       337
       +
         <section xml:id="submitting-changes-nixos-tests">

     

       338
       338
        
          <title>Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)</title>

     

       339
       339
        
       

     

       340
       340
        
          <para>

     
···

       350
       350
        
          </para>

     

       351
       351
        
         </section>

     

       352
       352
        
       

     

       353
       353
       -
         <section>

     

       353
       353
       +
         <section xml:id="submitting-changes-tested-compilation">

     

       354
       354
        
          <title>Tested compilation of all pkgs that depend on this change using <command>nox-review</command></title>

     

       355
       355
        
       

     

       356
       356
        
          <para>

     
···

       373
       373
        
          </para>

     

       374
       374
        
         </section>

     

       375
       375
        
       

     

       376
       376
       -
         <section>

     

       376
       376
       +
         <section xml:id="submitting-changes-tested-execution">

     

       377
       377
        
          <title>Tested execution of all binary files (usually in <filename>./result/bin/</filename>)</title>

     

       378
       378
        
       

     

       379
       379
        
          <para>

     
···

       387
       387
        
          </para>

     

       388
       388
        
         </section>

     

       389
       389
        
       

     

       390
       390
       -
         <section>

     

       391
       391
       -
          <title>Meets nixpkgs contribution standards</title>

     

       390
       390
       +
         <section xml:id="submitting-changes-contribution-standards">

     

       391
       391
       +
          <title>Meets Nixpkgs contribution standards</title>

     

       392
       392
        
       

     

       393
       393
        
          <para>

     

       394
       394
        
           The last checkbox is fits

     
···

       402
       402
        
          </para>

     

       403
       403
        
         </section>

     

       404
       404
        
        </section>

     

       405
       405
       -
        <section>

     

       405
       405
       +
        <section xml:id="submitting-changes-hotfixing-pull-requests">

     

       406
       406
        
         <title>Hotfixing pull requests</title>

     

       407
       407
        
       

     

       408
       408
        
         <itemizedlist>

     
···

       430
       430
        
          </listitem>

     

       431
       431
        
         </itemizedlist>

     

       432
       432
        
        </section>

     

       433
       433
       -
        <section>

     

       433
       433
       +
        <section xml:id="submitting-changes-commit-policy">

     

       434
       434
        
         <title>Commit policy</title>

     

       435
       435
        
       

     

       436
       436
        
         <itemizedlist>

     
···

       456
       456
        
          </listitem>

     

       457
       457
        
         </itemizedlist>

     

       458
       458
        
       

     

       459
       459
       -
         <section>

     

       459
       459
       +
         <section xml:id="submitting-changes-master-branch">

     

       460
       460
        
          <title>Master branch</title>

     

       461
       461
        
       

     

       462
       462
        
          <itemizedlist>

     
···

       468
       468
        
          </itemizedlist>

     

       469
       469
        
         </section>

     

       470
       470
        
       

     

       471
       471
       -
         <section>

     

       471
       471
       +
         <section xml:id="submitting-changes-staging-branch">

     

       472
       472
        
          <title>Staging branch</title>

     

       473
       473
        
       

     

       474
       474
        
          <itemizedlist>

     
···

       493
       493
        
          </itemizedlist>

     

       494
       494
        
         </section>

     

       495
       495
        
       

     

       496
       496
       -
         <section>

     

       496
       496
       +
         <section xml:id="submitting-changes-stable-release-branches">

     

       497
       497
        
          <title>Stable release branches</title>

     

       498
       498
        
       

     

       499
       499
        
          <itemizedlist>