Merge pull request #361 from desultory/dev

improve config docs

Author: desultory

src/ugrd/base/core.toml

@@ -63,8 +63,8 @@ hostonly = "bool"  # If true, the initramfs will be built specifically for the h
 validate = "bool"  # If true, the configuration of the initramfs will be validated against the host
 timeout = "int"  # The timeout for _run commands, defaults to 15 seconds
 _custom_init_file = "str"  # Add the _custom_init_file propety, used to set where the custom init file is located
-tmpdir = "Path"  # The base directory for builds
-build_dir = "Path"  # The directory where the initramfs is built
+tmpdir = "Path"  # The base directory for builds, defaults to /tmp. the build and output directories are created inside this directory
+build_dir = "Path"  # The directory where the initramfs is built, inside the tmpdir unless an absolute path is given
 random_build_dir = "bool"  # If true, a random build directory will be used
 build_logging = "bool" # If true, additional build information will be logged to the console
 _build_log_level = "int"  # The level of logging to use for the build log, set to 10 by default and incremeted by if build_log is true (min 20)
@@ -78,17 +78,17 @@ zstd_dependencies = "NoDupFlatList"  # ZStandard compressed dependencies propert
 gz_dependencies = "NoDupFlatList"  # GZipped dependencies property, used to define the gzipped dependencies (will be extracted)
 library_paths = "NoDupFlatList"  # library_paths property, used to define the library paths to add to LD_LIBRARY_PATH
 find_libgcc = "bool"  # If true, the initramfs will search for libgcc_s.so.1 and add it to the initramfs
-musl_libc = "bool"  # If true, disables find_libgcc and regen_ld_so_cache
+musl_libc = "bool"  # If true, disables find_libgcc and regen_ld_so_cache (not needed for musl libc based systems)
 libraries = "NoDupFlatList"  # Additional libraries, by name, added to the initramfs
 binaries = "NoDupFlatList"  # Binaries which should be included in the intiramfs, dependencies resolved with lddtree
 binary_search_paths = "NoDupFlatList"  # Binary paths, used to define the paths to search for binaries
 copies = "dict"  # Copies dict, defines the files to be copied to the initramfs
 nodes = "dict"  # Nodes dict, defines the device nodes to be created
 paths = "NoDupFlatList"  # Paths to be created in the initramfs
 masks = "dict"  # Imports to be masked in the initramfs
-make_nodes = "bool"  # If true, actual device nodes will be created in the build dir
-out_dir = "Path"  # The directory where the initramfs is packed/output. If no packer is used, this is the final output directory.
+make_nodes = "bool"  # If true, actual device nodes will be created in the build dir instead of only being created in the cpio archive
+out_dir = "Path"  # The directory where the initramfs is packed/output
 out_file = "str"  # The name of the output file, if absolute, overrides out dir with the path, and sets out_file to the filename
 old_count = "int"  # The number of times to cycle old files before deleting
-clean = "bool"  # Add the clean property, used to define if the mounts should be cleaned up after boot
+clean = "bool"  # Add the clean property, used to define if the build directory should be cleaned before building
 shell = "str"  # Set the shell to use for the init process

src/ugrd/main.py

@@ -135,11 +135,6 @@ def main():
         },
         {"flags": ["--livecd-label"], "action": "store", "help": "Sets the label for the livecd"},
         {"flags": ["--squashfs-image"], "action": "store", "help": "Sets the filename for the livede squashfs image"},
-        {
-            "flags": ["--force-out"],
-            "action": "store_true",
-            "help": "Force set the output file/dir, do not use a tmpdir.",
-        },
         {"flags": ["out_file"], "action": "store", "help": "set the output image location", "nargs": "?"},
     ]