created module categories for filesystem and kmods, updated examples and docs

Signed-off-by: Zen <[email protected]>

Author: desultory

config_example.toml

@@ -1,17 +1,15 @@
 # This config will decrypt the LUKS volume with uuid "fdf442da-0574-4531-98c7-55227a041f1d", mapping it to "/dev/mapper/root"
 # It will attempt to mount the btrfs volume with label "rootfs" to /mnt/root
 # It will pull all current kernel modules from lspci -k results
-# The "ugrd.base.kmod_nvme" module will be used to load the nvme module if it's not detected in lsmod
 # The "ugrd.base.cpio" module will pack the initramfs into a cpio archive
 
 modules = [
   "ugrd.base.base",
-  "ugrd.base.kmod",
-  "ugrd.base.kmod_nvme",
-  "ugrd.base.kmod_nosound",
-  "ugrd.base.kmod_novideo",
+  "ugrd.kmod.kmod",
+  "ugrd.kmod.nosound",
+  "ugrd.kmod.novideo",
   "ugrd.crypto.cryptsetup",
-  "ugrd.base.btrfs",
+  "ugrd.fs.btrfs",
   "ugrd.base.cpio",
 ]
 

config_raid_crypt_serial.toml

@@ -9,7 +9,7 @@ modules = [
   "ugrd.base.console",
   "ugrd.crypto.gpg",
   "ugrd.crypto.cryptsetup",
-  "ugrd.base.btrfs"
+  "ugrd.fs.btrfs"
 ]
 
 # Set the key type for all cryptsetup keys

config_subvol.toml

@@ -1,17 +1,21 @@
 # This config will decrypt the colume fdf442da-0574-4531-98c7-55227a041f1d, mapping it to "/dev/mapper/root"
 # It will attempt to mount the btrfs subvolume "gento" from the devive with label "rootfs" to /root
 # It will pull all current kernel modules from the active kernel version
+# The kmod.novideo and kmod.nosound modules are pulled to help minmize pulled modules
 
 
 modules = [
   "ugrd.base.base",
-  "ugrd.base.kmod",
+  "ugrd.kmod.kmod",
+  "ugrd.kmod.novideo",
+  "ugrd.kmod.nosound",
   "ugrd.crypto.cryptsetup",
   "ugrd.base.btrfs",
 ]
 
 # Optionally supply a kernel version
 #kernel_version = "6.1.53-gentoo-dist"
+kmod_autodetect_lsmod = true
 
 [root_mount]
 options = "subvol=gentoo"

config_vm.toml

@@ -1,12 +1,12 @@
 # This config will decrypt the volume with UUID "38a5c4d2-f5af-404a-a663-d789e443a40c", mapping it to /dev/mapper/root
-# It will pull kmods required by btrfs, since it is an included module, and virtio_blk which is part of kmod_vm.
+# It will pull kmods required by btrfs, since it is an included module, and virtio_blk which is part of kmod.vm.
 # The kernel version is set to 6.1.57-gentoo-custom
 # The root filesystem has the label "rootfs", and is mounted at /mnt/rootfs
 
 modules = [
   "ugrd.base.base",
-  "ugrd.base.kmod",
-  "ugrd.base.kmod_vm",
+  "ugrd.kmod.kmod",
+  "ugrd.kmod.vm",
   "ugrd.crypto.cryptsetup",
   "ugrd.base.btrfs"
 ]

config_yubikey.toml

@@ -7,14 +7,11 @@
 
 modules = [
   "ugrd.base.base",
-  "ugrd.base.kmod",
-  "ugrd.base.kmod_usb",
-  "ugrd.base.kmod_nvme",
-  "ugrd.base.kmod_fat",
+  "ugrd.kmod.kmod",
+  "ugrd.kmod.usb",
+  "ugrd.kmod.nvme",
   "ugrd.crypto.cryptsetup",
-  "ugrd.base.btrfs",
-  "ugrd.base.console",
-  "ugrd.crypto.gpg",
+  "ugrd.fs.btrfs",
   "ugrd.crypto.smartcard",
   "ugrd.base.cpio"
 ]

readme.md

@@ -125,31 +125,6 @@ These are set at the global level and are not associated with an individual moun
 * `mount_wait` (false) waits for user input before attenmpting to mount the generated fstab at `init_main`.
 * `mount_timeout` timeout for `mount_wait` to automatically continue.
 
-#### base.kmod
-
-This module is used to embed kernel modules into the initramfs.
-
-Modules can use `_kmod_depend` to add required modules. Simply using the `ugrd.crypto.cryptsetup` module, for example, will try to add the `dm_crypt` kmod.
-
-The following parameters can be used to change the kernel module pulling and initializing behavior:
-
-* `kernel_version` (uname -r) is used to specify the kernel version to pull modules for, should be a directory under `/lib/modules/<kernel_version>`.
-* `kmod_init`  is used to specify kernel modules to load at boot. If set, ONLY these modules will be loaded with modprobe.
-* `kmod_autodetect_lspci` (false) if set to `true`, will populate `kernel_modules` with modules listed in `lspci -k`.
-* `kmod_autodetect_lsmod` (false) if set to `true`, will populate `kernel_modules` with modules listed in `lsmod`.
-* `kernel_modules` is used to define a list of kernel module names to pull into the initramfs. These modules will not be `modprobe`'d automatically if `kmod_init` is also set.
-* `kmod_ignore` is used to specify kernel modules to ignore. If a module depends on one of these, it will throw an error and drop it from being included.
-* `kmod_ignore_softdeps` (false) ignore softdeps when checking kernel module dependencies.
-* `_kmod_depend` is meant to be used within modules, specifies kernel modules which should be added to `kmod_init` when that `ugrd` module is imported.
-
-##### Kernel module helpers
-
-Some helper modules have been created to make importing required kernel modules easier.
-
-`base.ugrd.kmod_nvme`, `kmod_usb`, and `kmod_fat` can be used to load modules for NVME's, USB storage, and the FAT file system respectively.
-
-Similarly `base.ugrd.kmod_novideo` and `kmod_nosound` exist to ignore video and sound devices that may appear when autodetecting modules.
-
 #### base.console
 
 This module creates an agetty session. This is used by the `ugrd.crypto.gpg` module so the tty can be used for input and output.
@@ -195,7 +170,36 @@ The following parameters can be set to alter CPIO functionality:
 * `cpio_list_name` (cpio.list) can be used to change the filename of the CPIO list for `gen_init_cpio`.
 * `_gen_init_cpio_path` The path to this tool can be specified. If not, it is included and will be built at runtime if needed.
 
-#### base.btrfs
+### Kernel modules
+
+`ugrd.kmod.kmod` is the core of the kernel module loading..
+
+> Modules can use `_kmod_depend` to add required modules. Simply using the `ugrd.crypto.cryptsetup` module, for example, will try to add the `dm_crypt` kmod.
+
+#### ugrd.kmod.kmod confugration parameters
+
+The following parameters can be used to change the kernel module pulling and initializing behavior:
+
+* `kernel_version` (uname -r) is used to specify the kernel version to pull modules for, should be a directory under `/lib/modules/<kernel_version>`.
+* `kmod_init`  is used to specify kernel modules to load at boot. If set, ONLY these modules will be loaded with modprobe.
+* `kmod_autodetect_lspci` (false) if set to `true`, will populate `kernel_modules` with modules listed in `lspci -k`.
+* `kmod_autodetect_lsmod` (false) if set to `true`, will populate `kernel_modules` with modules listed in `lsmod`.
+* `kernel_modules` is used to define a list of kernel module names to pull into the initramfs. These modules will not be `modprobe`'d automatically if `kmod_init` is also set.
+* `kmod_ignore` is used to specify kernel modules to ignore. If a module depends on one of these, it will throw an error and drop it from being included.
+* `kmod_ignore_softdeps` (false) ignore softdeps when checking kernel module dependencies.
+* `_kmod_depend` is meant to be used within modules, specifies kernel modules which should be added to `kmod_init` when that `ugrd` module is imported.
+
+#### Kernel module helpers
+
+Some helper modules have been created to make importing required kernel modules easier.
+
+`base.ugrd.kmod_nvme`, `kmod_usb`, and `kmod_fat` can be used to load modules for NVME's, USB storage, and the FAT file system respectively.
+
+Similarly `base.ugrd.kmod_novideo` and `kmod_nosound` exist to ignore video and sound devices that may appear when autodetecting modules.
+
+### Filesystem modules
+
+#### fs.btrfs
 
 Importing this module will run `btrfs device scan` and pull btrfs modules. No config is required.