summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPeter Marheine <pmarheine@chromium.org>2021-10-11 11:57:48 +1100
committerCommit Bot <commit-bot@chromium.org>2021-10-12 01:00:21 +0000
commiteeb5d0d332c8c762fab1b79afd2f187f88c12621 (patch)
tree974369551dc0a799db412571e81c3976c26da374 /docs
parent372d52aabc5b262a18bca806138a1c24242d8535 (diff)
downloadchrome-ec-eeb5d0d332c8c762fab1b79afd2f187f88c12621.tar.gz
zmake: fail gracefully if missing SDK
The documentation didn't comment on the need to install a Zephyr SDK package when working outside the chroot, and didn't provide any useful output if one was missing (just failing with an assertion). Add mention of the SDK to the documentation and fail with a more useful message if it's missing and requested. BUG=None TEST=Useful message is shown if SDK is missing BRANCH=None Change-Id: I05fee5294c27197d62b3f726cdd5579571ce9e1b Signed-off-by: Peter Marheine <pmarheine@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3216964 Reviewed-by: Andrew McRae <amcrae@google.com> Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/zephyr_build.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/zephyr_build.md b/docs/zephyr_build.md
index 5a3c809724..1ca7030ed0 100644
--- a/docs/zephyr_build.md
+++ b/docs/zephyr_build.md
@@ -110,6 +110,14 @@ ln -s somewhere/u-boot/tools/binman/binman
As above, ensure that `~/.local/bin` in on your PATH
+### Install Zephyr toolchain
+
+If using the Zephyr toolchain (`-t zephyr`), follow the [upstream
+documentation] to install the Zephyr build tools.
+
+[upstream documentation]: https://docs.zephyrproject.org/getting_started/index.html#install-a-toolchain
+
+
### Building
You can use `zmake help` to obtain help on how to use zmake. The following is