about summary refs log tree commit diff
path: root/doc/build-helpers
diff options
context:
space:
mode:
authormessemar <martin-messer@gmx.de>2023-12-12 13:19:21 +0100
committerGitHub <noreply@github.com>2023-12-12 13:19:21 +0100
commit0d6d654f3683e58495c04c10d13319df52a59034 (patch)
tree469703bbd02e0f687c70a4418a882ff068f4e25f /doc/build-helpers
parentf61980dbf91d43e969157bc34186f912024f62cf (diff)
downloadnixlib-0d6d654f3683e58495c04c10d13319df52a59034.tar
nixlib-0d6d654f3683e58495c04c10d13319df52a59034.tar.gz
nixlib-0d6d654f3683e58495c04c10d13319df52a59034.tar.bz2
nixlib-0d6d654f3683e58495c04c10d13319df52a59034.tar.lz
nixlib-0d6d654f3683e58495c04c10d13319df52a59034.tar.xz
nixlib-0d6d654f3683e58495c04c10d13319df52a59034.tar.zst
nixlib-0d6d654f3683e58495c04c10d13319df52a59034.zip
doc: checkpointBuild: fix wording
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
Diffstat (limited to 'doc/build-helpers')
-rw-r--r--doc/build-helpers/special/checkpoint-build.section.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/build-helpers/special/checkpoint-build.section.md b/doc/build-helpers/special/checkpoint-build.section.md
index afdf78ebf3c9..e5889a05be16 100644
--- a/doc/build-helpers/special/checkpoint-build.section.md
+++ b/doc/build-helpers/special/checkpoint-build.section.md
@@ -6,17 +6,17 @@ For hermeticity, Nix derivations do not allow any state to carry over between bu
 
 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 based on build checkpoints, the following steps needs to be fullfilled:
-    * - run prepareCheckpointBuild on the desired derivation
-    *   e.G `checkpointArtifacts = (pkgs.checkpointBuildTools.prepareCheckpointBuild pkgs.virtualbox);`
-    * - change something you want in the sources of the package( e.G using source override)
+To change a normal derivation to a checkpoint based build, these steps must be taken:
+  * apply `prepareCheckpointBuild` on the desired derivation
+    e.g. `checkpointArtifacts = (pkgs.checkpointBuildTools.prepareCheckpointBuild pkgs.virtualbox);`
+  - change something you want in the sources of the package. (e.g. using a source override)
     *   changedVBox = pkgs.virtualbox.overrideAttrs (old: {
     *      src = path/to/vbox/sources;
     *   }
     * - use `mkCheckpointedBuild 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.
+As Nix intentionally has no built-in support for the detection of the previously built derivation, a base version must be declared.
 To create the outputs later used as base version for checkpoint builds, the function `pkgs.checkpointBuildTools.prepareCheckpointBuild` is used.
 The function takes the original derivation as an argument and transforms the output to a base version for an checkpoint build build.
 While doing so, the original output is not created and the installation phase is overwritten to produce the checkpoint artifacts.