Skip to content

Commit f209923

Browse files
committed
improve config documentation
Signed-off-by: Zen <[email protected]>
1 parent 3e1d635 commit f209923

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/ugrd/base/core.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ hostonly = "bool" # If true, the initramfs will be built specifically for the h
6363
validate = "bool" # If true, the configuration of the initramfs will be validated against the host
6464
timeout = "int" # The timeout for _run commands, defaults to 15 seconds
6565
_custom_init_file = "str" # Add the _custom_init_file propety, used to set where the custom init file is located
66-
tmpdir = "Path" # The base directory for builds
67-
build_dir = "Path" # The directory where the initramfs is built
66+
tmpdir = "Path" # The base directory for builds, defaults to /tmp. the build and output directories are created inside this directory
67+
build_dir = "Path" # The directory where the initramfs is built, inside the tmpdir unless an absolute path is given
6868
random_build_dir = "bool" # If true, a random build directory will be used
6969
build_logging = "bool" # If true, additional build information will be logged to the console
7070
_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
7878
gz_dependencies = "NoDupFlatList" # GZipped dependencies property, used to define the gzipped dependencies (will be extracted)
7979
library_paths = "NoDupFlatList" # library_paths property, used to define the library paths to add to LD_LIBRARY_PATH
8080
find_libgcc = "bool" # If true, the initramfs will search for libgcc_s.so.1 and add it to the initramfs
81-
musl_libc = "bool" # If true, disables find_libgcc and regen_ld_so_cache
81+
musl_libc = "bool" # If true, disables find_libgcc and regen_ld_so_cache (not needed for musl libc based systems)
8282
libraries = "NoDupFlatList" # Additional libraries, by name, added to the initramfs
8383
binaries = "NoDupFlatList" # Binaries which should be included in the intiramfs, dependencies resolved with lddtree
8484
binary_search_paths = "NoDupFlatList" # Binary paths, used to define the paths to search for binaries
8585
copies = "dict" # Copies dict, defines the files to be copied to the initramfs
8686
nodes = "dict" # Nodes dict, defines the device nodes to be created
8787
paths = "NoDupFlatList" # Paths to be created in the initramfs
8888
masks = "dict" # Imports to be masked in the initramfs
89-
make_nodes = "bool" # If true, actual device nodes will be created in the build dir
90-
out_dir = "Path" # The directory where the initramfs is packed/output. If no packer is used, this is the final output directory.
89+
make_nodes = "bool" # If true, actual device nodes will be created in the build dir instead of only being created in the cpio archive
90+
out_dir = "Path" # The directory where the initramfs is packed/output
9191
out_file = "str" # The name of the output file, if absolute, overrides out dir with the path, and sets out_file to the filename
9292
old_count = "int" # The number of times to cycle old files before deleting
93-
clean = "bool" # Add the clean property, used to define if the mounts should be cleaned up after boot
93+
clean = "bool" # Add the clean property, used to define if the build directory should be cleaned before building
9494
shell = "str" # Set the shell to use for the init process

0 commit comments

Comments
 (0)