sof/scripts
Marc Herbert ec3ccab1b0 xtensa-build-all: document PRIVATE_KEY_OPTION and deprecate -k
Following commit 88b69cc2e5 ("scripts: xtensa-build-all: Add support
for building TGL and signing with MEU") we now have an unified and
flexible PRIVATE_KEY_OPTION that can do anything with very little code.

The -k option was never a good idea in the first place because it
already required an environment variable anyway (RIMAGE_PRIVATE_KEY)
instead of a command line argument so the code should have just checked
whether RIMAGE_PRIVATE_KEY was defined, that would have been
enough. Requiring the user to "double-confirm" with -k has been adding
extra complication for both the user interface and the implementation.

xtensa-build-all is effectively a "CMake configuration convenience"
script, however it shouldn't become an additional layer of indirection
and complexity and its interface should expose CMake (which is already a
layer of indirection!) as directly as possible.

See longer discussion in PR #3187

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2020-10-19 15:15:52 +01:00
..
cmake cmake: add warning when git submodule changes are found 2020-09-29 11:19:25 +01:00
docker_build docker: alsa: allow alsa development in container 2020-08-10 13:51:40 +01:00
kconfig license: use spdx identifier in python files 2019-06-02 16:38:17 +01:00
scan script: clang scan-build for xtensa 2020-03-04 11:02:56 +01:00
README.docker scripts: remove all soft related stuff 2019-01-10 15:10:10 +00:00
build-tools.sh build-tools.sh: remove all the "Entering directory..." noise 2020-09-17 09:56:19 +01:00
checkpatch.pl check patch: ABI warning only once per file, not once per line 2020-07-10 15:48:57 +01:00
const_structs.checkpatch dai: supply caps and other info from within drivers 2019-05-03 03:14:43 -07:00
docker-qemu.sh license: use spdx identifier in shell scripts 2019-06-02 16:38:17 +01:00
docker-run.sh docker-run.sh: pass-through PRIVATE_KEY_OPTION 2020-09-25 13:41:33 +01:00
gen-doc.sh gen-doc.sh: Use getopts for parsing arguments 2020-03-31 15:10:34 +01:00
host-build-all.sh host-build-all.sh: print deprecation warning 2020-09-01 10:42:56 +01:00
host-testbench.sh host-testbench.sh: clean up output files when tests are successful 2020-09-01 16:26:15 +01:00
qemu-check.sh qemu-check.sh: restore error messages when test fails 2020-06-30 11:30:19 +01:00
rebuild-testbench.sh rebuild-testbench.sh: remove CMAKE_VERBOSE_MAKEFILE 2020-09-01 16:26:15 +01:00
sof-post-commit-hook.sh license: use spdx identifier in shell scripts 2019-06-02 16:38:17 +01:00
sof-pre-commit-hook.sh license: use spdx identifier in shell scripts 2019-06-02 16:38:17 +01:00
sof-target-install.sh license: use spdx identifier in shell scripts 2019-06-02 16:38:17 +01:00
sof_fw.kb ci: klocwork: add example config file to avoid FPs 2019-02-22 12:16:05 +01:00
spelling.txt sof: add git pre- and post-commit hooks 2018-01-23 21:08:05 +00:00
xtensa-build-all.sh xtensa-build-all: document PRIVATE_KEY_OPTION and deprecate -k 2020-10-19 15:15:52 +01:00

README.docker

The docker container provided in docker_build sets up a build environment for
building Sound Open Firmware. A working docker installation is needed to run
the docker build container.

Note: In order to run docker as non sudo/root user please run.

sudo usermod -aG docker your-user-name

Then logout and login again.

Quick Start:

First, build the docker container. This step needs to be done initially and
when the toolchain or alsa dependencies are updated.

cd scripts/docker_build

./docker-build.sh

After the container is built, it can be used to run the scripts.

To build for baytrail:
./scripts/docker-run.sh ./scripts/xtensa-build-all.sh -l byt
or (may need password test0000 for rimage install)
./scripts/docker-run.sh ./scripts/xtensa-build-all.sh byt

To rebuild the topology and logger:
./scripts/docker-run.sh ./scripts/build-tools.sh

An incremental sof.git build:
./scripts/docker-run.sh make

Or enter a shell:
./scripts/docker-run.sh bash