commit 4ba31045e46b54e8b3b3d240858f83a60b9ef49c · pyrox.dev/nixpkgs

+60 -11
doc/submitting-changes.xml
···

       262
       262
        
       </listitem>

     

       263
       263
        
       

     

       264
       264
        
       <listitem>

     

       265
       265
       -
       <para>Master should only see non-breaking commits that do not cause mass rebuilds.</para>

     

       265
       265
       +
       <para>When changing the bootloader installation process, extra care must be taken. Grub installations cannot be rolled back, hence changes may break people's installations forever. For any non-trivial change to the bootloader please file a PR asking for review, especially from @edolstra.</para>

     

       266
       266
        
       </listitem>

     

       267
       267
       +
       </itemizedlist>

     

       268
       268
       +
       

     

       269
       269
       +
       <section>

     

       270
       270
       +
         <title>Master branch</title>

     

       271
       271
       +
       

     

       272
       272
       +
         <itemizedlist>

     

       273
       273
       +
           <listitem>

     

       274
       274
       +
             <para>

     

       275
       275
       +
               It should only see non-breaking commits that do not cause mass rebuilds.

     

       276
       276
       +
             </para>

     

       277
       277
       +
           </listitem>

     

       278
       278
       +
         </itemizedlist>

     

       279
       279
       +
       </section>

     

       280
       280
       +
       

     

       281
       281
       +
       <section>

     

       282
       282
       +
         <title>Staging branch</title>

     

       267
       283
        
       

     

       268
       268
       -
       <listitem>

     

       269
       269
       -
       <para>Staging should only see non-breaking mass-rebuild commits. That means it's not to be used for testing, and changes must have been well tested already. <link xlink:href="http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read policy here</link>.</para>

     

       270
       270
       -
       </listitem>

     

       284
       284
       +
         <itemizedlist>

     

       285
       285
       +
           <listitem>

     

       286
       286
       +
             <para>

     

       287
       287
       +
               It's only for non-breaking mass-rebuild commits. That means it's not to

     

       288
       288
       +
               be used for testing, and changes must have been well tested already.

     

       289
       289
       +
               <link xlink:href="http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read policy here</link>.

     

       290
       290
       +
             </para>

     

       291
       291
       +
           </listitem>

     

       292
       292
       +
           <listitem>

     

       293
       293
       +
             <para>

     

       294
       294
       +
               If the branch is already in a broken state, please refrain from adding

     

       295
       295
       +
               extra new breakages. Stabilize it for a few days, merge into master,

     

       296
       296
       +
               then resume development on staging.

     

       297
       297
       +
               <link xlink:href="http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations">Keep an eye on the staging evaluations here</link>.

     

       298
       298
       +
               If any fixes for staging happen to be already in master, then master can

     

       299
       299
       +
               be merged into staging.

     

       300
       300
       +
             </para>

     

       301
       301
       +
           </listitem>

     

       302
       302
       +
         </itemizedlist>

     

       303
       303
       +
       </section>

     

       304
       304
       +
       

     

       305
       305
       +
       <section>

     

       306
       306
       +
         <title>Stable release branches</title>

     

       307
       307
       +
       

     

       308
       308
       +
         <itemizedlist>

     

       309
       309
       +
           <listitem>

     

       310
       310
       +
             <para>

     

       311
       311
       +
               If you're cherry-picking a commit to a stable release branch, always use

     

       312
       312
       +
               <command>git cherry-pick -xe</command> and ensure the message contains a

     

       313
       313
       +
               clear description about why this needs to be included in the stable

     

       314
       314
       +
               branch.

     

       315
       315
       +
             </para>

     

       316
       316
       +
             <para>An example of a cherry-picked commit would look like this:</para>

     

       317
       317
       +
             <screen>

     

       318
       318
       +
       nixos: Refactor the world.

     

       271
       319
        
       

     

       272
       272
       -
       <listitem>

     

       273
       273
       -
       <para>If staging is already in a broken state, please refrain from adding extra new breakages. Stabilize it for a few days, merge into master, then resume development on staging. <link xlink:href="http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations">Keep an eye on the staging evaluations here</link>. If any fixes for staging happen to be already in master, then master can be merged into staging.</para>

     

       274
       274
       -
       </listitem>

     

       320
       320
       +
       The original commit message describing the reason why the world was torn apart.

     

       275
       321
        
       

     

       276
       276
       -
       <listitem>

     

       277
       277
       -
       <para>When changing the bootloader installation process, extra care must be taken. Grub installations cannot be rolled back, hence changes may break people's installations forever. For any non-trivial change to the bootloader please file a PR asking for review, especially from @edolstra.</para>

     

       278
       278
       -
       </listitem>

     

       279
       279
       -
       </itemizedlist>

     

       322
       322
       +
       (cherry picked from commit abcdef)

     

       323
       323
       +
       Reason: I just had a gut feeling that this would also be wanted by people from

     

       324
       324
       +
       the stone age.

     

       325
       325
       +
             </screen>

     

       326
       326
       +
           </listitem>

     

       327
       327
       +
         </itemizedlist>

     

       328
       328
       +
       </section>

     

       280
       329
        
       

     

       281
       330
        
       </section>

     

       282
       331
        
       </chapter>