diff options
| author | Jack Rosenthal <jrosenth@chromium.org> | 2022-01-11 10:30:24 -0700 |
|---|---|---|
| committer | Commit Bot <commit-bot@chromium.org> | 2022-01-12 05:22:59 +0000 |
| commit | d0b23756668c0421831c70bd0850ef371f59c46c (patch) | |
| tree | 6889d76fba1a82b0a4daa48f3e04d352fd04e169 | |
| parent | 4e91015e0f553c433adf25815605d8f526080e1e (diff) | |
| download | chrome-ec-d0b23756668c0421831c70bd0850ef371f59c46c.tar.gz | |
zephyr: docs: Use project names for zmake commands
Switch documentation referring to the project path of a zmake build to
project name. Project path is still technically supported, but only
for project directories with exactly one project defined, which will
become fewer and fewer as we start launching real EC projects.
BUG=b:193815337
BRANCH=none
TEST=view in gitiles
Signed-off-by: Jack Rosenthal <jrosenth@chromium.org>
Change-Id: Ia2c50363874b8997a8308bbf304f9773965086c8
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3381044
Reviewed-by: Denis Brockus <dbrockus@chromium.org>
| -rw-r--r-- | docs/reducing_ec_image_size.md | 22 | ||||
| -rw-r--r-- | docs/zephyr/zephyr_build.md | 2 | ||||
| -rw-r--r-- | docs/zephyr/ztest.md | 2 |
3 files changed, 13 insertions, 13 deletions
diff --git a/docs/reducing_ec_image_size.md b/docs/reducing_ec_image_size.md index 4b5c5bbf31..fc3cb9b270 100644 --- a/docs/reducing_ec_image_size.md +++ b/docs/reducing_ec_image_size.md @@ -90,24 +90,24 @@ builds of zephyr-ec boards. Changing the logging level to INFO, displays the flash and SRAM usage of board. ``` -$ zmake -l INFO configure -b zephyr/projects/volteer/volteer +$ zmake -l INFO configure -b volteer INFO: Clearing old build directory /mnt/host/source/src/platform/ec/build/zephyr/projects/volteer/volteer ... -INFO: [/mnt/host/source/src/platform/ec/build/zephyr/projects/volteer/volteer:ro]Memory region Used Size Region Size %age Used -INFO: [/mnt/host/source/src/platform/ec/build/zephyr/projects/volteer/volteer:ro]FLASH: 238852 B 512 KB 45.56% -INFO: [/mnt/host/source/src/platform/ec/build/zephyr/projects/volteer/volteer:ro]SRAM: 57144 B 62 KB 90.01% -INFO: [/mnt/host/source/src/platform/ec/build/zephyr/projects/volteer/volteer:ro]IDT_LIST: 0 GB 2 KB 0.00% -INFO: [/mnt/host/source/src/platform/ec/build/zephyr/projects/volteer/volteer:rw]Memory region Used Size Region Size %age Used -INFO: [/mnt/host/source/src/platform/ec/build/zephyr/projects/volteer/volteer:rw]FLASH: 238852 B 512 KB 45.56% -INFO: [/mnt/host/source/src/platform/ec/build/zephyr/projects/volteer/volteer:rw]SRAM: 57144 B 62 KB 90.01% -INFO: [/mnt/host/source/src/platform/ec/build/zephyr/projects/volteer/volteer:rw]IDT_LIST: 0 GB 2 KB 0.00% +INFO: [volteer:ro]Memory region Used Size Region Size %age Used +INFO: [volteer:ro]FLASH: 238852 B 512 KB 45.56% +INFO: [volteer:ro]SRAM: 57144 B 62 KB 90.01% +INFO: [volteer:ro]IDT_LIST: 0 GB 2 KB 0.00% +INFO: [volteer:rw]Memory region Used Size Region Size %age Used +INFO: [volteer:rw]FLASH: 238852 B 512 KB 45.56% +INFO: [volteer:rw]SRAM: 57144 B 62 KB 90.01% +INFO: [volteer:rw]IDT_LIST: 0 GB 2 KB 0.00% ``` For easier to read output, you can run the ninja build tool directly and see the RO and RW footprint. ``` -$ zmake configure zephyr/projects/volteer/volteer/ +$ zmake configure volteer $ ninja -C build/zephyr/projects/volteer/volteer/build-ro ninja: Entering directory 'build/zephyr/projects/volteer/volteer/build-ro' [1/324] Preparing syscall dependency handling @@ -138,7 +138,7 @@ images outside chroot before running the commands below. ``` # Configure the Volteer zephyr project, storing the build files in /tmp/zephyr-volteer -$ zmake configure -B /tmp/zephyr-volteer zephyr/projects/volteer/volteer -t zephyr +$ zmake configure -B /tmp/zephyr-volteer volteer # Build the RO image $ ninja -C /tmp/zephyr-volteer/build-ro diff --git a/docs/zephyr/zephyr_build.md b/docs/zephyr/zephyr_build.md index f930366b83..7d78e801ab 100644 --- a/docs/zephyr/zephyr_build.md +++ b/docs/zephyr/zephyr_build.md @@ -114,7 +114,7 @@ a rough guide. First configure the build with the project you want: ```bash -zmake configure -B /tmp/z/vol zephyr/projects/volteer/volteer/ +zmake configure -B /tmp/z/vol volteer ``` Then build with just the target directory: diff --git a/docs/zephyr/ztest.md b/docs/zephyr/ztest.md index 021b3391bd..4a33d0a103 100644 --- a/docs/zephyr/ztest.md +++ b/docs/zephyr/ztest.md @@ -178,7 +178,7 @@ uses. Use `zmake` to build and run the test: ``` -(cr) $ zmake -l DEBUG configure --test -B build/ztest/base32 zephyr/test/base32 +(cr) $ zmake -l DEBUG configure --test -B build/ztest/base32 test-base32 ... UART_0 connected to pseudotty: /dev/pts/1 *** Booting Zephyr OS build zephyr-v2.4.0-1-g63b2330a85cd *** |