From 7d25dc74c5bfc7b73aaced3f65ecd4f42457124b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Mon, 11 Mar 2024 09:54:31 +0100 Subject: [PATCH] docs: clarify generated image names --- docs/reference.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/reference.md b/docs/reference.md index 02dda22..5557238 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -93,7 +93,7 @@ In the this example we create a flake containing a nixos configuration for `myho nix build .#nixosConfigurations.myhost.config.system.build.diskoImagesScript ``` -3. **Execute the result file:** Execute the generated result file. Running +3. **Execute the disko image script:** Execute the generated disko image script. Running `./result --help` will output the available options: ```console @@ -124,6 +124,8 @@ In the this example we create a flake containing a nixos configuration for `myho sudo ./result --build-memory 2048 ``` + The script will generate the actual image outside of the nix store in the current working directory. + The create image names depend on the names used in `disko.disks` attrset in the NixOS configuration. In our code example it will produce the following image: ```