From 098e44d03cf1968434990b7d62a0e6221fc675e0 Mon Sep 17 00:00:00 2001
From: anonymix007 <48598263+anonymix007@users.noreply.github.com>
Date: Sun, 17 Nov 2024 20:52:30 +0300
Subject: [PATCH] man: Document ukify --hwids= and --devicetree-auto= options
---
man/ukify.xml | 31 +++++++++++++++++++++++++++++++
man/ukify_hwid.json.example | 8 ++++++++
2 files changed, 39 insertions(+)
create mode 100644 man/ukify_hwid.json.example
diff --git a/man/ukify.xml b/man/ukify.xml
index 14dbb2a9542..61f70257e2a 100644
--- a/man/ukify.xml
+++ b/man/ukify.xml
@@ -71,6 +71,8 @@
Cmdline=/,
OSRelease=/,
DeviceTree=/,
+ DeviceTreeAuto=/,
+ HWIDs=/,
Splash=/,
PCRPKey=/,
Uname=/,
@@ -373,6 +375,35 @@
+
+ DeviceTreeAuto=PATH...
+
+
+ Zero or more automatically selectable DeviceTree files. In the configuration file, items are separated by
+ whitespace. Each DeviceTree will be in a separate .dtbauto section.
+
+
+
+
+
+ HWIDs=PATH
+
+
+ The hardware ID device table (the .hwids section). The argument is a
+ path to a directory with JSON HWID device description files. Each file needs to contain a single JSON object with a name, compatible and hwids keys. The name and compatible keys must have string values and the hwids key must have a list of strings as value, where the strings must be valid UUIDs that represent CHIDs/HWIDs.
+ Example:
+
+ Here Example Laptop 16 Gen 7 is the device name (as defined by the manufacturer),
+ example,laptop-16-g7 is the compatible (as defined by the kernel) and hwids
+ is an array of CHIDs/HWIDs (extracted i.e. from fwupdtool hwids output).
+ If not specified, the section will not be present. It is recommended to specify this parameter if automatically
+ selectable DeviceTrees are to be used.
+
+
+
+
+
+
Uname=VERSION
diff --git a/man/ukify_hwid.json.example b/man/ukify_hwid.json.example
new file mode 100644
index 00000000000..83921b5d936
--- /dev/null
+++ b/man/ukify_hwid.json.example
@@ -0,0 +1,8 @@
+{
+ "name": "Example Laptop 16 Gen 7",
+ "compatible": "example,laptop-16-g7",
+ "hwids": [
+ "5dc05bf4-01f6-4089-b464-a08c47ea9295",
+ "3e3f8f3c-2003-46f2-811c-85554f7d5952"
+ ]
+}