Skip to content

Commit c4d34f2

Browse files
authored
fix: correct typos across docs and messages (#1229)
## Summary This PR fixes typos in docs and user-facing messages. ## Detailed Changes | File | Fixed | |---|---| | `scripts/create-release.nix` | `uncommited` -> `uncommitted` (4x) | | `lib/default.nix:906` | `Depracated` -> `Deprecated` | | `lib/tests.nix:195` | `mkOveride` -> `mkOverride` | | `docs/interactive-vm.md:3` | `similiar` -> `similar` | | `docs/disko-images.md:82` | `involed` -> `involved` | | `docs/disko-images.md:110` | `scirpt` -> `script` | | `docs/table-to-gpt.md:62` | `partiton` -> `partition` | | `lib/make-disk-image.nix:212` | `involed` -> `involved` | | `docs/disko-images.md:11` | `In the this example` -> `In this example` | No intended behavior change. Closes #1228
2 parents 7b9f7f8 + 089cf54 commit c4d34f2

File tree

7 files changed

+11
-11
lines changed

7 files changed

+11
-11
lines changed

docs/disko-images.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Follow the steps below to generate disk images:
88
1. **Create a NixOS configuration that includes the disko and the disk
99
configuration of your choice**
1010

11-
In the this example we create a flake containing a nixos configuration for
11+
In this example we create a flake containing a nixos configuration for
1212
`myhost`.
1313

1414
```nix
@@ -79,7 +79,7 @@ In the this example we create a flake containing a nixos configuration for
7979
They will have the same permissions but will be owned by root:root
8080
* --build-memory <amt>
8181
specify the amount of memory in MiB that gets allocated to the build VM
82-
This can be useful if you want to build images with a more involed NixOS config
82+
This can be useful if you want to build images with a more involved NixOS config
8383
The default is 1024 MiB
8484
```
8585

@@ -107,7 +107,7 @@ In the this example we create a flake containing a nixos configuration for
107107
disko.devices.disk.<drive>.imageName = "nixos-x86_64-linux-generic-btrfs"; # Set your preferred name
108108
```
109109

110-
The image scirpt will produce `nixos-x86_64-linux-generic-btrfs.raw` instead of `<drive>.raw`.
110+
The image script will produce `nixos-x86_64-linux-generic-btrfs.raw` instead of `<drive>.raw`.
111111

112112
- For virtual drive use, define the image size in your Disko configuration:
113113

docs/interactive-vm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Running Interactive VMs with `disko`
22

3-
disko now exports its own flavor of interactive VMs (similiar to
3+
disko now exports its own flavor of interactive VMs (similar to
44
config.system.build.vm). Simply import the disko module and build the vm runner
55
with:
66

docs/table-to-gpt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ for example like this:
5959

6060
## Remediation
6161

62-
The new GPT layout (`type = "gpt"`) uses partlabels to realize the partiton
62+
The new GPT layout (`type = "gpt"`) uses partlabels to realize the partition
6363
numbering. For this reason you have to manually set up partition labels, if you
6464
want to resolve this issue.
6565

lib/default.nix

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -940,7 +940,7 @@ let
940940
type = lib.types.str;
941941
description = ''
942942
The script to unmount (& destroy) all devices defined by disko.devices
943-
Does not ask for confirmation! Depracated in favor of _destroy
943+
Does not ask for confirmation! Deprecated in favor of _destroy
944944
'';
945945
default = ''
946946
umount -Rv "${rootMountPoint}" || :

lib/make-disk-image.nix

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ in
209209
They will have the same permissions but will be owned by root:root
210210
* --build-memory <amt>
211211
specify the amount of memory in MiB that gets allocated to the build VM
212-
This can be useful if you want to build images with a more involed NixOS config
212+
This can be useful if you want to build images with a more involved NixOS config
213213
The default is disko.memSize which defaults to ${builtins.toString options.disko.memSize.default} MiB
214214
USAGE
215215
}

lib/tests.nix

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ let
192192
boot.swraid.mdadmConf = "PROGRAM ${pkgs.coreutils}/bin/true";
193193

194194
# grub will install to these devices, we need to force those or we are offset by 1
195-
# we use mkOveride 70, so that users can override this with mkForce in case they are testing grub mirrored boots
195+
# we use mkOverride 70, so that users can override this with mkForce in case they are testing grub mirrored boots
196196
boot.loader.grub.devices = lib.mkOverride 70 testConfigInstall.boot.loader.grub.devices;
197197

198198
assertions = [

scripts/create-release.nix

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ writeShellApplication {
4343
fi
4444
4545
# Ensure there are no uncommitted or unpushed changes
46-
uncommited_changes=$(git diff --compact-summary)
47-
if [[ -n "$uncommited_changes" ]]; then
48-
echo -e "There are uncommited changes, exiting:\n''${uncommited_changes}" >&2
46+
uncommitted_changes=$(git diff --compact-summary)
47+
if [[ -n "$uncommitted_changes" ]]; then
48+
echo -e "There are uncommitted changes, exiting:\n''${uncommitted_changes}" >&2
4949
exit 1
5050
fi
5151
git pull https://github.com/nix-community/disko master

0 commit comments

Comments
 (0)