From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Sat, 1 Mar 2025 16:37:31 +0000 (+0100)
Subject: man: soft-deprecate Firmware{Include,Exclude}
X-Git-Tag: v26~316^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dafb2461e61ade8b2cb6f783885be324ad154256;p=thirdparty%2Fmkosi.git

man: soft-deprecate Firmware{Include,Exclude}
---

diff --git a/mkosi/resources/man/mkosi.1.md b/mkosi/resources/man/mkosi.1.md
index 26ea79934..80c4a0f22 100644
--- a/mkosi/resources/man/mkosi.1.md
+++ b/mkosi/resources/man/mkosi.1.md
@@ -1100,16 +1100,18 @@ boolean argument: either `1`, `yes`, or `true` to enable, or `0`, `no`,
 `KernelInitrdModules=`, `--kernel-modules-initrd-include=`
 :   Like `KernelModules=`, but specifies the kernel modules to include in the initrd.
 
-`FirmwareInclude=`, `--firmware-include=`
-:   Takes a list of regex patterns that specify firmware files to include in the image. Patterns should be
-    relative to `/usr/lib/firmware/<subdir>` paths. **mkosi** checks for a match anywhere in the firmware path
-    (e.g. `bcm8483` will match against `cxgb4/bcm8483.bin`). All firmware files that match any of the specified
-    patterns are included in the image.
-
-`FirmwareExclude=`, `--firmware-exclude=`
-:   Takes a list of regex patterns that specify firmware files to exclude from the image. Behaves the same as
-    `FirmwareInclude=` except that all firmware that match any of the specified patterns is excluded from the
-    image. Firmware specified with this option is excluded even if an included kernel module depends on it.
+`FirmwareFiles=`, `--firmware-files=`
+:   Takes a list of glob patterns that specify which firmware files to include in the image.
+    The patterns are interpreted in the same way as in the `KernelModules=` settings,
+    except that the paths are relative to `/usr/lib/firmware/<subdir>`.
+    The compression suffix is ignored and must not be included in the pattern.
+
+    Firmware files that listed by modules that are included in the image are
+    automatically included.
+
+    Example: `FirmwareFiles=cxgb4/bcm8483.bin` or `FirmwareFiles=bcm8483.*` would both cause
+    `/usr/lib/firmware/cxgb4/bcm8483.bin.xz` to be included,
+    even if not listed by a module.
 
 `Locale=`, `--locale=`, `LocaleMessages=`, `--locale-messages=`, `Keymap=`, `--keymap=`, `Timezone=`, `--timezone=`, `Hostname=`, `--hostname=`, `RootShell=`, `--root-shell=`
 :   The settings `Locale=`, `--locale=`, `LocaleMessages=`, `--locale-messages=`,
diff --git a/mkosi/resources/man/mkosi.news.7.md b/mkosi/resources/man/mkosi.news.7.md
index 9c93a8aa2..5e2fea52b 100644
--- a/mkosi/resources/man/mkosi.news.7.md
+++ b/mkosi/resources/man/mkosi.news.7.md
@@ -30,6 +30,10 @@
   deprecated and are replaced by a single option that takes a list of
   positive and negative globs. The new options are KernelModules=
   and KernelInitrdModules=.
+- A new way to specify firmware files included in the initrd has been added.
+  Previous separate Include and Exclude options that take regexps are now
+  deprecated and are replaced by a single option that takes a list of
+  positive and negative globs. The new option is FirmwareFiles=.
 
 ## v25