From 73b1fbc777a85b7e9e960b0076e6cd52c4e3bdbd Mon Sep 17 00:00:00 2001
From: anonymix007 <48598263+anonymix007@users.noreply.github.com>
Date: Tue, 22 Oct 2024 15:07:15 +0300
Subject: [PATCH] man: Document stub behaviour for .hwids and .dtbauto sections

---
 man/systemd-stub.xml | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/man/systemd-stub.xml b/man/systemd-stub.xml
index 439d999c64c..6625fca91ef 100644
--- a/man/systemd-stub.xml
+++ b/man/systemd-stub.xml
@@ -79,6 +79,20 @@
 
       <listitem><para>A <literal>.dtb</literal> section with a compiled binary DeviceTree.</para></listitem>
 
+      <listitem><para>Zero or more <literal>.dtbauto</literal> sections. Stub will always try to find first matching one.
+      Matching process extracts first <varname>compatible</varname> string from <literal>.dtbauto</literal>
+      section and compares it with the first Devicetree's <varname>compatible</varname> string supplied by
+      the firmware in configuration tables. If firmware does not provide Devicetree, matching with
+      <varname>.hwids</varname>  section will be used instead. Stub will use SMBIOS data to calculate hardware
+      IDs of the machine (as per <ulink url="https://learn.microsoft.com/en-us/windows-hardware/drivers/install/specifying-hardware-ids-for-a-computer">specification</ulink>),
+      then it will proceed to trying to find any of them in <literal>.hwids</literal> section and will use first
+      matching entry's <varname>compatible</varname>  as a search key among the <literal>.dtbauto</literal>
+      entries, in a similar fashion as the use of <varname>compatible</varname> string read from the firmware
+      provided Devicetree was described before. First matching <literal>.dtbauto</literal> section will be
+      loaded and will override <varname>.dtb</varname> if present.</para></listitem>
+
+      <listitem><para>A <literal>.hwids</literal> section with hardware IDs of the machines to match Devicetrees (refer to <literal>.dtbauto</literal> section description).</para></listitem>
+
       <listitem><para>A <literal>.uname</literal> section with the kernel version information, i.e. the
       output of <command>uname -r</command> for the kernel included in the <literal>.linux</literal>
       section.</para></listitem>
-- 
2.47.3