colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: add section about checkpointed build

Browse Source
This commit is contained in:
Martin Messer 2022-06-27 14:03:10 +02:00
parent c8afee88bf
commit fc2e3fac61
4 changed files with 35 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/build-helpers/special.md
View File

@ -7,4 +7,5 @@ special/fhs-environments.section.md
special/makesetuphook.section.md
special/mkshell.section.md
special/vm-tools.section.md
special/incremental-build.section.md
```

28
doc/build-helpers/special/incremental-build.section.md Normal file
View File

@ -0,0 +1,28 @@
# pkgs.buildIncremental.* {#sec-incremental-build}
`pkgs.buildIncremental` provides a way to build derivations incrementally. It consists of two functions to make incremental builds using nix possible.
For hermeticity, Nix derivations do not allow any state to carry over between builds, making a transparent incremental build within a derivation impossible.
However, we can tell Nix explicitly what the previous build state was, by representing that previous state as a derivation output. This allows the passed build state to be used for an incremental build.
To build a derivation incrementally, the following steps needs to be fullfilled:
* - run prepareIncrementalBuild on the desired derivation
* e.G `incrementalBuildArtifacts = (pkgs.buildIncremental.prepareIncrementalBuild pkgs.virtualbox);`
* - change something you want in the sources of the package( e.G using source override)
* changedVBox = pkgs.virtuabox.overrideAttrs (old: {
* src = path/to/vbox/sources;
* }
* - use `mkIncrementalBuild changedVBox buildOutput`
* enjoy shorter build times
As Nix has no builtin support for the detection of the previous built derivation, a base version needs to be declared.
To create the outputs later used as base version for incremental builds, the function `pkgs.buildIncremental.prepareIncrementalBuild` is used.
The function takes the original derivation as an argument and transforms the output to a base version for an incremental build.
While doing so, the original output is not created and the installation phase is overwritten to produce the incremental build artifacts.
When the built artifacts of the base version of the derivation are created, the code can be modified and changes are built using the `pkgs.buildIncremental.mkIncrementalBuild` function.
The `pkgs.buildIncremental.mkIncrementalBuild` function detects the changes in the code and places the output of the base version derivation within the build folder.
Then, the build tool is able to detect the changes and makes the decision of which parts of the derivation needs to be recompiled and produces the output, as expected in the derivation, without incremental build support.

10
pkgs/test/incrementalBuild/default.nix
View File

@ -1,6 +1,6 @@
{ hello, buildIncremental, runCommandNoCC, texinfo, stdenv, rsync }:
{ hello, incrementalBuildTools, runCommandNoCC, texinfo, stdenv, rsync }:
let
baseHelloArtifacts = buildIncremental.prepareIncrementalBuild hello;
baseHelloArtifacts = incrementalBuildTools.prepareIncrementalBuild hello;
patchedHello = hello.overrideAttrs (old: {
buildInputs = [ texinfo ];
src = runCommandNoCC "patch-hello-src" { } ''
@ -10,7 +10,7 @@ let
patch -p1 < ${./hello.patch}
'';
});
incrementalBuiltHello = buildIncremental.mkIncrementalBuild patchedHello baseHelloArtifacts;
incrementalBuiltHello = incrementalBuildTools.mkIncrementalBuild patchedHello baseHelloArtifacts;
incrementalBuiltHelloWithCheck = incrementalBuiltHello.overrideAttrs (old: {
doCheck = true;
@ -20,7 +20,7 @@ let
'';
});
baseHelloRemoveFileArtifacts = buildIncremental.prepareIncrementalBuild (hello.overrideAttrs (old: {
baseHelloRemoveFileArtifacts = incrementalBuildTools.prepareIncrementalBuild (hello.overrideAttrs (old: {
patches = [ ./hello-additionalFile.patch ];
}));
@ -41,7 +41,7 @@ let
'';
});
incrementalBuiltHelloWithRemovedFile = buildIncremental.mkIncrementalBuild patchedHelloRemoveFile baseHelloRemoveFileArtifacts;
incrementalBuiltHelloWithRemovedFile = incrementalBuildTools.mkIncrementalBuild patchedHelloRemoveFile baseHelloRemoveFileArtifacts;
in
stdenv.mkDerivation {
name = "patched-hello-returns-correct-output";

2
pkgs/top-level/all-packages.nix
View File

@ -429,7 +429,7 @@ with pkgs;
camunda-modeler = callPackage ../applications/misc/camunda-modeler { };
inncrementalBuildTools = callPackage ../build-support/build-incremental.nix {};
incrementalBuildTools = callPackage ../build-support/build-incremental.nix {};
caroline = callPackage ../development/libraries/caroline { };