diff options
| author | Jameson Thies <jthies@google.com> | 2022-07-07 20:14:53 +0000 |
|---|---|---|
| committer | Chromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2022-07-08 01:00:23 +0000 |
| commit | 5cfa5b9e0bcafd19eb8109db95b23a2082d611b5 (patch) | |
| tree | fae0448adcb262ffdb115227cb3651c176f935c4 | |
| parent | 075079e03f909bd366a64301ea07c7d9d5844d7b (diff) | |
| download | chrome-ec-5cfa5b9e0bcafd19eb8109db95b23a2082d611b5.tar.gz | |
docs: Add note about removing history to reduce EC image size
src/platform/ec/docs/reducing_ec_image_size.md includes a small section
stating that the help command can be removed from the EC console free up
flash space in the EC. Similarly, the history command can be removed.
This CL updates the reducing_ec_image_size.md doc to note that both help
and history can be removed to save EC space.
BRANCH=None
BUG=None
TEST=None
Signed-off-by: Jameson Thies <jthies@google.com>
Change-Id: Iee566ea574c85607eca8a481fec6d2ffdd332405
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3750112
Reviewed-by: Abe Levkoy <alevkoy@chromium.org>
| -rw-r--r-- | docs/reducing_ec_image_size.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/reducing_ec_image_size.md b/docs/reducing_ec_image_size.md index 5e09c99e51..fc5d0c1500 100644 --- a/docs/reducing_ec_image_size.md +++ b/docs/reducing_ec_image_size.md @@ -347,13 +347,14 @@ Disable all debug from ASSERT() calls.<br> EC is reset using a software breakpoi It is not recommended to disable `CONFIG_PLATFORM_EC_DEBUG_ASSERT_REBOOTS` on shipping firmware. -### Disable console help +### Disable console help and history The help strings can be removed from the final build, saving about 5000 bytes of -flash space. +flash space. The history command can also be disabled to save another 200 bytes +of flash space. -For cros-ec builds, add `#undef CONFIG_CONSOLE_CMDHELP` to the -board.h/baseboard.h file. +For cros-ec builds, add `#undef CONFIG_CONSOLE_CMDHELP` and `#undef +CONFIG_CONSOLE_HISTORY` to the board.h/baseboard.h file. zephyr-ec builds use Zephyr's shell subsystem and by default enable the `CONFIG_SHELL_MINIMAL` option. This option already disables shell help along |