From ee0d0f27203f461d158f3335fc637fed377b2084 Mon Sep 17 00:00:00 2001 From: Kai Vehmanen Date: Tue, 21 Jan 2025 18:46:52 +0200 Subject: [PATCH 1/2] README.md: clarify platform applicability Clarify the README.md text to emphasize that this repository and upstream release process is open to all vendors. Some of the examples are Intel specific and/or use e.g. Intel specific firmware paths as examples, as that is what is currently distributed. Signed-off-by: Kai Vehmanen --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index ad1e09d..d00abad 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ ## Notice on Platform Coverage +While sof-bin repository is open to all vendors, in practise only +binaries for Intel based systems have been distributed using this +method so far. For pragmatic reasons, examples in this documentation +use Intel binaries as examples as those are currently available. + WARNING: starting with v2.2, older Intel products are not supported by the main SOF development branch anymore. To avoid duplication and confusion in this sof-bin git repository, older product generations are @@ -37,6 +42,9 @@ sudo mv /usr/local/bin/sof-* some_backup_location/ # optional sudo ./install.sh ``` +The install script is intended for Linux systems where the Linux kernel +will look up firmware binaries under /lib/firmware. + ## Install process with install.sh (sof-bin git tree) To run install from sof-bin git checkout: From 151c7be8ec762088673800e920975a7af7a629e4 Mon Sep 17 00:00:00 2001 From: Kai Vehmanen Date: Tue, 21 Jan 2025 21:34:38 +0200 Subject: [PATCH 2/2] tests: modify tarball_multi 2023.09 test The README.md has been updated with updated sections, so recreating 2023.09 will cause a mismatch in installed README.md. Exclude the known difference in the test case. Signed-off-by: Kai Vehmanen --- tests/tests.bats | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tests/tests.bats b/tests/tests.bats index 9da8991..6561f88 100644 --- a/tests/tests.bats +++ b/tests/tests.bats @@ -202,6 +202,10 @@ test_install_one_version() # anymore git show v2023.12.1:install.sh > "$(pwd)/sof-bin-$ver"/install.sh + # install.sh was updated in 2025.01, so it won't match + # anymore + git show v2023.12.1:README.md > "$(pwd)/sof-bin-$ver"/README.md + diff -qr "$EXTR_REFS"/sof-bin-"$ver" "$(pwd)/sof-bin-$ver"/ popd || exit 1