From: Jo Zzsi Date: Tue, 19 Nov 2024 01:32:45 +0000 (-0500) Subject: docs: warn against the usage of omit, drivers, dracutmodules X-Git-Tag: 106~161 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f698315;p=thirdparty%2Fdracut-ng.git docs: warn against the usage of omit, drivers, dracutmodules These are common footguns. We should do a better job warning the users against these usually untested configurations. Follow-up to eb1ae6c . --- diff --git a/man/dracut.conf.5.adoc b/man/dracut.conf.5.adoc index 9e840ae85..f0488eb58 100644 --- a/man/dracut.conf.5.adoc +++ b/man/dracut.conf.5.adoc @@ -44,12 +44,17 @@ Configuration files must have the extension .conf; other extensions are ignored. *omit_dracutmodules+=*" ____ ":: Omit a space-separated list of dracut modules to call when building the initramfs. Modules are located in _/usr/lib/dracut/modules.d_. + Warning: Avoid manually omitting dracut modules, as you may + inadvertently remove essential ones that dracut can't detect + or warn you about. Using this option is not recommended and is at + your own risk. *dracutmodules+=*" ____ ":: Specify a space-separated list of dracut modules to call when building the initramfs. Modules are located in _/usr/lib/dracut/modules.d_. This option forces dracut to only include the specified dracut modules. In most cases the "add_dracutmodules" option is what you want to use. + This option is not recomended to use (use at your own risk). *add_drivers+=*" ____ ":: Specify a space-separated list of kernel modules to add to the initramfs. @@ -67,6 +72,9 @@ Configuration files must have the extension .conf; other extensions are ignored. Specify a space-separated list of kernel modules to exclusively include in the initramfs. The kernel modules have to be specified without the ".ko" suffix. + This option forces dracut to only include the specified kernel modules. + In most cases the "--add-drivers" option is what you want to use. + This option is not recomended to use (use at your own risk). *filesystems+=*" ____ ":: Specify a space-separated list of kernel filesystem modules to exclusively