]> git.ipfire.org Git - thirdparty/dracut-ng.git/commitdiff
docs: document --force-add precedence over --omit
authorIan Wienand <iwienand@redhat.com>
Fri, 25 Oct 2024 02:42:25 +0000 (13:42 +1100)
committerLaszlo <laszlo.gombos@gmail.com>
Fri, 25 Oct 2024 02:58:57 +0000 (22:58 -0400)
Following-on from the dependent PR, this adds some documentation for
--force-add and it's relationship to --omit.

Depends-On: https://github.com/dracut-ng/dracut-ng/pull/584

man/dracut.8.adoc
man/dracut.usage.adoc

index 0db152b97e758f329368f6a1ffd496d6207c6abd..ea3e080c9df43cd8d34fa526213d3897deb302a4 100644 (file)
@@ -65,6 +65,7 @@ _<output file>_ **--rebuild**::
 
 **-a, --add** _<list of dracut modules>_::
     Add a space-separated list of dracut modules to the default set of modules.
+    If a module appears in both _add_ and _omit_ lists, it will be omitted.
     This parameter can be specified multiple times.
 +
 [NOTE]
@@ -77,9 +78,11 @@ example:
 ===============================
 
 **--force-add** _<list of dracut modules>_::
-    Force to add a space-separated list of dracut modules to the default set of
-    modules, when -H is specified. This parameter can be specified multiple
-    times.
+    A space-separated list of dracut modules appended to the default set of
+    modules when _host-only_ (`-H`) mode is specified.  Unlike `--add`,
+    `--force-add` will _override_ omittied (`-o`) modules; it is thus useful to
+    ensure that a module is added even if it is specified as omitted in
+    configuration files.  This parameter can be specified multiple times.
 +
 [NOTE]
 ===============================
index 737c02ec7e69093a3107beb9851fd3941cf6ada0..2e2592ef7a5c68fa7b5c9b18e061b32b5d63c121 100644 (file)
@@ -74,24 +74,28 @@ Some dracut modules are turned off by default and have to be activated manually.
 You can do this by adding the dracut modules to the configuration file
 _/etc/dracut.conf_ or _/etc/dracut.conf.d/myconf.conf_. See *dracut.conf*(5).
 You can also add dracut modules on the command line
-by using the -a or --add option:
+by using the `-a` or `--add` option:
 
 [,console]
 ----
 # dracut --add module initramfs-module.img
 ----
 
-To see a list of available dracut modules, use the --list-modules option:
+To see a list of available dracut modules, use the `--list-modules` option:
 [,console]
 ----
 # dracut --list-modules
 ----
 
+TIP: Omitted modules will _override_ added modules.  `--force-add` can be used
+to add a module in host-only mode if it is specified as omitted (usually via a
+distribution configuration file).
+
 == Omitting dracut Modules
 Sometimes you don't want a dracut module to be included for reasons of speed,
 size or functionality. To do this, either specify the omit_dracutmodules
 variable in the _dracut.conf_ or _/etc/dracut.conf.d/myconf.conf_ configuration
-file (see *dracut.conf*(5)), or use the -o or --omit option
+file (see *dracut.conf*(5)), or use the `-o` or `--omit` option
 on the command line:
 
 [,console]