improve docs, move cpio module to the fs section

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

Author: desultory

readme.md

@@ -144,13 +144,6 @@ Modules write to a shared config dict that is accessible by other modules.
 * `binaries` is a list used to define programs to be pulled into the initrams. `which` is used to find the path of added entries, and `lddtree` is used to resolve dependendies.
 * `paths` is a list of directores to create in the `build_dir`. They do not need a leading `/`.
 
-#### base.cpio
-
-This module handles CPIO creation.
-
-* `out_file` (ugrd.cpio) Sets the name of the output file, under `out_dir` unless a path is defined.
-* `mknod_cpio` (true) Only create devicne nodes within the CPIO.
-
 ##### symlink creation
 
 Symlinks are defined in the `symlinks` dict. Each entry must have a name, `source` and `target`:
@@ -193,7 +186,7 @@ minor = 1
 
 Creates `/dev/console` with permissions `0o644`
 
-> Using `mknod_cpio` from `ugrd.base.cpio` will not create the device nodes in the build dir, but within the CPIO archive
+> Using `mknod_cpio` from `ugrd.fs.cpio` will not create the device nodes in the build dir, but within the CPIO archive
 
 #### base.console
 
@@ -305,6 +298,13 @@ destination = "/mnt/extra"
 label = "extra"
 ```
 
+#### ugrd.fs.cpio
+
+This module handles CPIO creation.
+
+* `out_file` (ugrd.cpio) Sets the name of the output file, under `out_dir` unless a path is defined.
+* `mknod_cpio` (true) Only create devicne nodes within the CPIO.
+
 ##### General mount options
 
 These are set at the global level and are not associated with an individual mount:
@@ -535,7 +535,7 @@ The `cpio` module imports the `make_cpio_list` packing function with:
 
 ```
 [imports.pack]
-"ugrd.base.base" = [ "make_cpio_list" ]
+"ugrd.fs.cpio" = [ "make_cpio" ]
 ```
 
 ##### funcs
@@ -587,12 +587,12 @@ The `custom_init` function should return a tuple with the line used to call the
 def custom_init(self) -> str:
     """
     init override for the console module.
-    Write the main init runlevels to the self.config_dict['_custom_init_file'] file.
+    Write the main init runlevels to self._custom_init_file.
     Returns the output of console_init which is the command to start agetty.
     """
-    custom_init_contents = [self.config_dict['shebang'],
-                            f"# Console module version v{__version__}"]
-    custom_init_contents += self.generate_init_main()
+    custom_init_contents = [self['shebang'],
+                            f"# Console module version v{__version__}",
+                            *self.generate_init_main()]
 
     return console_init(self), custom_init_contents
 
@@ -603,10 +603,10 @@ def console_init(self) -> str:
     Tell it to execute teh _custom_init_file
     If the console is a serial port, set the baud rate.
     """
-    name = self.config_dict['primary_console']
-    console = self.config_dict['console'][name]
+    name = self['primary_console']
+    console = self['console'][name]
 
-    out_str = f"agetty --autologin root --login-program {self.config_dict['_custom_init_file']}"
+    out_str = f"agetty --autologin root --login-program {self['_custom_init_file']}"
 
     console_type = console.get('type', 'tty')
 
@@ -618,4 +618,3 @@ def console_init(self) -> str:
 
     return out_str
 ```
-

src/ugrd/base/base.toml

@@ -1,4 +1,4 @@
-modules = ["ugrd.base.core", "ugrd.fs.mounts", "ugrd.base.cpio"]
+modules = ["ugrd.base.core", "ugrd.fs.mounts", "ugrd.fs.cpio"]
 
 binaries = [ "awk", "grep", "ls", "cat", "switch_root" ]
 

src/ugrd/base/cpio.py renamed to src/ugrd/fs/cpio.py

@@ -30,9 +30,7 @@ def make_cpio(self) -> None:
 
 
 def _process_out_file(self, out_file):
-    """
-    Processes the out_file configuration option.
-    """
+    """ Processes the out_file configuration option. """
     if not out_file:
         raise ValueError("out_file cannot be empty")
 

src/ugrd/base/cpio.toml renamed to src/ugrd/fs/cpio.toml

@@ -4,10 +4,10 @@ mknod_cpio = true
 required_parameters = ['out_file']
 
 [imports.config_processing]
-"ugrd.base.cpio" = [ "_process_out_file" ]
+"ugrd.fs.cpio" = [ "_process_out_file" ]
 
 [imports.pack]
-"ugrd.base.cpio" = [ "make_cpio" ]
+"ugrd.fs.cpio" = [ "make_cpio" ]
 
 [custom_parameters]
 out_file =  "str"  # The name of the cpio file to create.