diff --git a/doc/builders/special/darwin-builder.section.md b/doc/builders/special/darwin-builder.section.md index 30bf2d095102..b5b6ab8971e9 100644 --- a/doc/builders/special/darwin-builder.section.md +++ b/doc/builders/special/darwin-builder.section.md @@ -62,7 +62,7 @@ builders-use-substitutes = true $ sudo launchctl kickstart -k system/org.nixos.nix-daemon ``` -## Example flake usage +## Example flake usage {#sec-darwin-builder-example-flake} ``` { @@ -120,7 +120,7 @@ $ sudo launchctl kickstart -k system/org.nixos.nix-daemon } ``` -## Reconfiguring the builder +## Reconfiguring the builder {#sec-darwin-builder-reconfiguring} Initially you should not change the builder configuration else you will not be able to use the binary cache. However, after you have the builder running locally diff --git a/doc/builders/special/vm-tools.section.md b/doc/builders/special/vm-tools.section.md index 3b6fb0d2556b..8feab04902d8 100644 --- a/doc/builders/special/vm-tools.section.md +++ b/doc/builders/special/vm-tools.section.md @@ -6,7 +6,7 @@ A set of VM related utilities, that help in building some packages in more advan A bash script fragment that produces a disk image at `destination`. -### Attributes +### Attributes {#vm-tools-createEmptyImage-attributes} * `size`. The disk size, in MiB. * `fullName`. Name that will be written to `${destination}/nix-support/full-name`. @@ -20,14 +20,14 @@ Thus, any pure Nix derivation should run unmodified. If the build fails and Nix is run with the `-K/--keep-failed` option, a script `run-vm` will be left behind in the temporary build directory that allows you to boot into the VM and debug it interactively. -### Attributes +### Attributes {#vm-tools-runInLinuxVM-attributes} * `preVM` (optional). Shell command to be evaluated *before* the VM is started (i.e., on the host). * `memSize` (optional, default `512`). The memory size of the VM in MiB. * `diskImage` (optional). A file system image to be attached to `/dev/sda`. Note that currently we expect the image to contain a filesystem, not a full disk image with a partition table etc. -### Examples +### Examples {#vm-tools-runInLinuxVM-examples} Build the derivation hello inside a VM: ```nix @@ -56,13 +56,13 @@ runInLinuxVM (hello.overrideAttrs (_: { Takes a file, such as an ISO, and extracts its contents into the store. -### Attributes +### Attributes {#vm-tools-extractFs-attributes} * `file`. Path to the file to be extracted. Note that currently we expect the image to contain a filesystem, not a full disk image with a partition table etc. * `fs` (optional). Filesystem of the contents of the file. -### Examples +### Examples {#vm-tools-extractFs-examples} Extract the contents of an ISO file: ```nix @@ -82,7 +82,7 @@ Like [](#vm-tools-runInLinuxVM), but instead of using `stdenv` from the Nix stor Generate a script that can be used to run an interactive session in the given image. -### Examples +### Examples {#vm-tools-makeImageTestScript-examples} Create a script for running a Fedora 27 VM: ```nix @@ -100,7 +100,7 @@ makeImageTestScript diskImages.ubuntu2004x86_64 A set of functions that build a predefined set of minimal Linux distributions images. -### Images +### Images {#vm-tools-diskImageFuns-images} * Fedora * `fedora26x86_64` @@ -126,12 +126,12 @@ A set of functions that build a predefined set of minimal Linux distributions im * `debian11i386` * `debian11x86_64` -### Attributes +### Attributes {#vm-tools-diskImageFuns-attributes} * `size` (optional, defaults to `4096`). The size of the image, in MiB. * `extraPackages` (optional). A list names of additional packages from the distribution that should be included in the image. -### Examples +### Examples {#vm-tools-diskImageFuns-examples} 8GiB image containing Firefox in addition to the default packages: ```nix