diff options
| author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2024-07-24 18:01:18 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-07-24 18:01:18 +0000 |
| commit | 7208220b63aac7dfa4df42340ef1a6fb6c36be42 (patch) | |
| tree | 47e22845c64d1b77fd84b4ea98a23925e22a68fa /doc | |
| parent | 8402add1f4bed2b2f9e09055b663f94fda9c135d (diff) | |
| parent | 7b8b14a87692ab609e73c74ca80d3417c25a88f5 (diff) | |
Merge master into staging-next
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/build-helpers/images/dockertools.section.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/build-helpers/images/dockertools.section.md b/doc/build-helpers/images/dockertools.section.md index aeb831c770c5..60342a9d0edc 100644 --- a/doc/build-helpers/images/dockertools.section.md +++ b/doc/build-helpers/images/dockertools.section.md @@ -185,6 +185,19 @@ Similarly, if you encounter errors similar to `Error_Protocol ("certificate has _Default value:_ `"gz"`.\ _Possible values:_ `"none"`, `"gz"`, `"zstd"`. +`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`. + `contents` **DEPRECATED** : This attribute is deprecated, and users are encouraged to use `copyToRoot` instead. @@ -574,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`](#chap-passthru) for the resulting derivation. |