From 47d839cdf8f428ca745a3bbab7a14d57e5c8a700 Mon Sep 17 00:00:00 2001 From: Dmitrii Golovanov Date: Mon, 24 Mar 2025 20:42:37 +0100 Subject: [PATCH 1/4] Reset unwanted executable attributes Reset executable attributes on .rst, .txt, .diag files as well as on CODEOWNERS. Signed-off-by: Dmitrii Golovanov --- CODEOWNERS | 0 algos/demux/demux.rst | 0 architectures/firmware/index.rst | 0 architectures/firmware/intel/cavs/cavs-boot/apollolake/index.rst | 0 .../firmware/intel/cavs/cavs-boot/cavs-dsp-boot-overview.rst | 0 architectures/firmware/intel/cavs/index.rst | 0 architectures/firmware/intel/index.rst | 0 architectures/firmware/sof-xtos/schedulers.rst | 0 .../mpp_layer/images/mpp_scheduling/edf_scheduling.diag | 0 .../firmware/sof-zephyr/rtos_layer/zephyr_kernel_overview.rst | 0 architectures/index.rst | 0 getting_started/build-guide/build-from-scratch.rst | 0 getting_started/build-guide/build-with-zephyr.rst | 0 getting_started/index.rst | 0 getting_started/intel_debug/introduction.rst | 0 getting_started/intel_debug/suggestions.rst | 0 getting_started/nxp/sof_imx_user_guide.rst | 0 platforms/intel-cavs/commons/work-queue.rst | 0 release.rst | 0 scripts/requirements.txt | 0 tsc/representatives.rst | 0 21 files changed, 0 insertions(+), 0 deletions(-) mode change 100755 => 100644 CODEOWNERS mode change 100755 => 100644 algos/demux/demux.rst mode change 100755 => 100644 architectures/firmware/index.rst mode change 100755 => 100644 architectures/firmware/intel/cavs/cavs-boot/apollolake/index.rst mode change 100755 => 100644 architectures/firmware/intel/cavs/cavs-boot/cavs-dsp-boot-overview.rst mode change 100755 => 100644 architectures/firmware/intel/cavs/index.rst mode change 100755 => 100644 architectures/firmware/intel/index.rst mode change 100755 => 100644 architectures/firmware/sof-xtos/schedulers.rst mode change 100755 => 100644 architectures/firmware/sof-zephyr/mpp_layer/images/mpp_scheduling/edf_scheduling.diag mode change 100755 => 100644 architectures/firmware/sof-zephyr/rtos_layer/zephyr_kernel_overview.rst mode change 100755 => 100644 architectures/index.rst mode change 100755 => 100644 getting_started/build-guide/build-from-scratch.rst mode change 100755 => 100644 getting_started/build-guide/build-with-zephyr.rst mode change 100755 => 100644 getting_started/index.rst mode change 100755 => 100644 getting_started/intel_debug/introduction.rst mode change 100755 => 100644 getting_started/intel_debug/suggestions.rst mode change 100755 => 100644 getting_started/nxp/sof_imx_user_guide.rst mode change 100755 => 100644 platforms/intel-cavs/commons/work-queue.rst mode change 100755 => 100644 release.rst mode change 100755 => 100644 scripts/requirements.txt mode change 100755 => 100644 tsc/representatives.rst diff --git a/CODEOWNERS b/CODEOWNERS old mode 100755 new mode 100644 diff --git a/algos/demux/demux.rst b/algos/demux/demux.rst old mode 100755 new mode 100644 diff --git a/architectures/firmware/index.rst b/architectures/firmware/index.rst old mode 100755 new mode 100644 diff --git a/architectures/firmware/intel/cavs/cavs-boot/apollolake/index.rst b/architectures/firmware/intel/cavs/cavs-boot/apollolake/index.rst old mode 100755 new mode 100644 diff --git a/architectures/firmware/intel/cavs/cavs-boot/cavs-dsp-boot-overview.rst b/architectures/firmware/intel/cavs/cavs-boot/cavs-dsp-boot-overview.rst old mode 100755 new mode 100644 diff --git a/architectures/firmware/intel/cavs/index.rst b/architectures/firmware/intel/cavs/index.rst old mode 100755 new mode 100644 diff --git a/architectures/firmware/intel/index.rst b/architectures/firmware/intel/index.rst old mode 100755 new mode 100644 diff --git a/architectures/firmware/sof-xtos/schedulers.rst b/architectures/firmware/sof-xtos/schedulers.rst old mode 100755 new mode 100644 diff --git a/architectures/firmware/sof-zephyr/mpp_layer/images/mpp_scheduling/edf_scheduling.diag b/architectures/firmware/sof-zephyr/mpp_layer/images/mpp_scheduling/edf_scheduling.diag old mode 100755 new mode 100644 diff --git a/architectures/firmware/sof-zephyr/rtos_layer/zephyr_kernel_overview.rst b/architectures/firmware/sof-zephyr/rtos_layer/zephyr_kernel_overview.rst old mode 100755 new mode 100644 diff --git a/architectures/index.rst b/architectures/index.rst old mode 100755 new mode 100644 diff --git a/getting_started/build-guide/build-from-scratch.rst b/getting_started/build-guide/build-from-scratch.rst old mode 100755 new mode 100644 diff --git a/getting_started/build-guide/build-with-zephyr.rst b/getting_started/build-guide/build-with-zephyr.rst old mode 100755 new mode 100644 diff --git a/getting_started/index.rst b/getting_started/index.rst old mode 100755 new mode 100644 diff --git a/getting_started/intel_debug/introduction.rst b/getting_started/intel_debug/introduction.rst old mode 100755 new mode 100644 diff --git a/getting_started/intel_debug/suggestions.rst b/getting_started/intel_debug/suggestions.rst old mode 100755 new mode 100644 diff --git a/getting_started/nxp/sof_imx_user_guide.rst b/getting_started/nxp/sof_imx_user_guide.rst old mode 100755 new mode 100644 diff --git a/platforms/intel-cavs/commons/work-queue.rst b/platforms/intel-cavs/commons/work-queue.rst old mode 100755 new mode 100644 diff --git a/release.rst b/release.rst old mode 100755 new mode 100644 diff --git a/scripts/requirements.txt b/scripts/requirements.txt old mode 100755 new mode 100644 diff --git a/tsc/representatives.rst b/tsc/representatives.rst old mode 100755 new mode 100644 From fd72f51a1cb5be47c1e17938d2ba8d0f6feccddc Mon Sep 17 00:00:00 2001 From: Dmitrii Golovanov Date: Tue, 25 Mar 2025 10:58:38 +0100 Subject: [PATCH 2/4] docbuild: Add a note on additional libraries Add a note on additional libraries needed to build the hardcoded version of pillow package. Signed-off-by: Dmitrii Golovanov --- contribute/process/docbuild.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/contribute/process/docbuild.rst b/contribute/process/docbuild.rst index f1dd8f91..5a0c2817 100644 --- a/contribute/process/docbuild.rst +++ b/contribute/process/docbuild.rst @@ -163,6 +163,20 @@ tools: PIP_IGNORE_INSTALLED=0 pip3 install --user -r scripts/requirements-lax.txt + The hardcoded package versions might need additional libraries installed + in order to compile them. For example, to resolve the following error: + + .. code-block:: bash + + ERROR: Could not build wheels for pillow, which is required to install pyproject.toml-based projects + + you should install: + + .. code-block:: bash + + sudo apt install libjpeg-dev zlib1g-dev + + For Windows, install the needed tools manually: * Python (3.7+) from https://www.python.org/downloads/ From f23fcd9176b041124058b6d3ce66599a0238fd24 Mon Sep 17 00:00:00 2001 From: Dmitrii Golovanov Date: Tue, 25 Mar 2025 11:00:43 +0100 Subject: [PATCH 3/4] docbuild: Adjust HTML generation commands Adjust code snippets for HTML generation after #9788c4be changes to avoid doxygen build in source directory. Signed-off-by: Dmitrii Golovanov --- contribute/process/docbuild.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/contribute/process/docbuild.rst b/contribute/process/docbuild.rst index 5a0c2817..06570e03 100644 --- a/contribute/process/docbuild.rst +++ b/contribute/process/docbuild.rst @@ -238,8 +238,8 @@ Docker image (2) cd thesofproject # API documentation (Doxygen) - cmake -S sof/doc -B sof/doc -GNinja - ninja -C sof/doc -v doc + cmake -S sof/doc -B sof/build_doxygen -GNinja + ninja -C sof/build_doxygen -v doc # UML and reStructuredText make -C sof-docs VERBOSE=1 html @@ -305,7 +305,7 @@ publishing. .. note:: In some situations it is necessary to clean all the files and build from - the very beginning. To do this, use the ``make clean`` command. + the very beginning. To do this, use the ``make -C sof-docs clean`` command. Installation troubleshooting **************************** From bd7776305de6633f4043a9bf113c3a69c46835f0 Mon Sep 17 00:00:00 2001 From: Dmitrii Golovanov Date: Tue, 25 Mar 2025 11:18:10 +0100 Subject: [PATCH 4/4] build-guide: Use Zephyr HWMv2 board names Use Zephyr HWMv2 board names in `west build` command examples. Signed-off-by: Dmitrii Golovanov --- getting_started/build-guide/build-with-zephyr.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/getting_started/build-guide/build-with-zephyr.rst b/getting_started/build-guide/build-with-zephyr.rst index 781dc920..e3eb035d 100644 --- a/getting_started/build-guide/build-with-zephyr.rst +++ b/getting_started/build-guide/build-with-zephyr.rst @@ -163,17 +163,17 @@ Check out and build using west tool directly .. code-block:: bash - west build --build-dir build-tgl --board intel_adsp_cavs25 ./sof/app + west build --build-dir build-tgl --board intel_adsp/cavs25 ./sof/app - Note that the SOF project defines platform names that have Zephyr board counterparts. In the above example, the *Tigerlake* platform matches the ``inteL_adsp_cavs25`` Zephyr board. This is why the output directory is named ``build-tgl``; however, you may use any name you wish. + Note that the SOF project defines platform names that have Zephyr board counterparts. In the above example, the *Tigerlake* platform matches the ``intel_adsp/cavs25`` Zephyr board target (see `Zephyr HWMv2 board terminology `_). This is why the output directory is named ``build-tgl``; however, you may use any name you wish. .. note:: To add verbosity to the build output use the -v -v flags. Example: - ``west -v -v build --build-dir build-tgl --board intel_adsp_cavs25 ./sof/app`` + ``west -v -v build --build-dir build-tgl --board intel_adsp/cavs25 ./sof/app`` To perform a complete clean rebuild, use the --pristine flag. Example: - ``west -v -v build --build-dir build-tgl --pristine always --board intel_adsp_cavs25 ./sof/app`` + ``west -v -v build --build-dir build-tgl --pristine always --board intel_adsp/cavs25 ./sof/app`` The ``.elf`` file produced by the ``west build`` is missing a manifest and signature. A a result, you must sign the file using the **rimage tool**