diff mbox series

[isar-cip-core,v4,4/4] doc/README.swupdate.md: Add documentation for hardware compatibility

Message ID 20240304105453.984881-5-Quirin.Gylstorff@siemens.com (mailing list archive)
State Accepted
Headers show
Series Reduce difference to debian | expand

Commit Message

Gylstorff Quirin March 4, 2024, 10:54 a.m. UTC
From: Quirin Gylstorff <quirin.gylstorff@siemens.com>

Signed-off-by: Quirin Gylstorff <quirin.gylstorff@siemens.com>
---
 doc/README.swupdate.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
diff mbox series

Patch

diff --git a/doc/README.swupdate.md b/doc/README.swupdate.md
index cf1bcfb..5877882 100644
--- a/doc/README.swupdate.md
+++ b/doc/README.swupdate.md
@@ -111,6 +111,20 @@  The sw-description will contain the following section:
         }):
 ```
 
+## SWUpdate Hardware compatibility
+
+The variable `SWU_HW_COMPAT` contains a space separate list of
+compatible hardware revisions.
+SWUpdate checks the compatibility against `/etc/hwrevision`, see
+[hardware-compatibility in the SWUpdate documentation.](https://sbabic.github.io/swupdate/sw-description.html#hardware-compatibility)
+
+For testing purpose the content of `/etc/hwrevision` can be set with
+the variable `MACHINE_HW_VERSION`.
+
+In production scenarios it is recommended to acquire a HW specific
+identifier (e.g., Board identifer with dmidecode) during boot up and
+write it to `/etc/hwrevision`.
+
 # Building and testing the CIP Core image
 
 Set up `kas-container` as described in the [top-level README](../README.md).