From 4d51990bc5c4831bc25c29ea3efbcfe3630e2d45 Mon Sep 17 00:00:00 2001 From: Yorick van Pelt Date: Mon, 6 May 2024 15:06:50 +0200 Subject: [PATCH] dockerTools: document streamLayeredImage's includeNixDB argument --- doc/build-helpers/images/dockertools.section.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/build-helpers/images/dockertools.section.md b/doc/build-helpers/images/dockertools.section.md index 945bfdb27682..064a854a17eb 100644 --- a/doc/build-helpers/images/dockertools.section.md +++ b/doc/build-helpers/images/dockertools.section.md @@ -587,6 +587,19 @@ This allows the function to produce reproducible images. _Default value:_ `true` +`includeNixDB` (Boolean; _optional_) + +: Populate the nix database in the image with the dependencies of `copyToRoot`. + The main purpose is to be able to use nix commands in the container. + + :::{.caution} + Be careful since this doesn't work well in combination with `fromImage`. In particular, in a multi-layered image, only the Nix paths from the lower image will be in the database. + + This also neglects to register the store paths that are pulled into the image as a dependency of one of the other values, but aren't a dependency of `copyToRoot`. + ::: + + _Default value:_ `false`. + `passthru` (Attribute Set; _optional_) : Use this to pass any attributes as [passthru](#var-stdenv-passthru) for the resulting derivation.