Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file modified CODEOWNERS
100755 → 100644
Empty file.
Empty file modified algos/demux/demux.rst
100755 → 100644
Empty file.
Empty file modified architectures/firmware/index.rst
100755 → 100644
Empty file.
Empty file.
Empty file.
Empty file modified architectures/firmware/intel/cavs/index.rst
100755 → 100644
Empty file.
Empty file modified architectures/firmware/intel/index.rst
100755 → 100644
Empty file.
Empty file modified architectures/firmware/sof-xtos/schedulers.rst
100755 → 100644
Empty file.
Empty file.
Empty file.
Empty file modified architectures/index.rst
100755 → 100644
Empty file.
20 changes: 17 additions & 3 deletions contribute/process/docbuild.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down Expand Up @@ -224,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

Expand Down Expand Up @@ -291,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
****************************
Expand Down
Empty file modified getting_started/build-guide/build-from-scratch.rst
100755 → 100644
Empty file.
8 changes: 4 additions & 4 deletions getting_started/build-guide/build-with-zephyr.rst
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.zephyrproject.org/latest/hardware/porting/board_porting.html#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**
Expand Down
Empty file modified getting_started/index.rst
100755 → 100644
Empty file.
Empty file modified getting_started/intel_debug/introduction.rst
100755 → 100644
Empty file.
Empty file modified getting_started/intel_debug/suggestions.rst
100755 → 100644
Empty file.
Empty file modified getting_started/nxp/sof_imx_user_guide.rst
100755 → 100644
Empty file.
Empty file modified platforms/intel-cavs/commons/work-queue.rst
100755 → 100644
Empty file.
Empty file modified release.rst
100755 → 100644
Empty file.
Empty file modified scripts/requirements.txt
100755 → 100644
Empty file.
Empty file modified tsc/representatives.rst
100755 → 100644
Empty file.