Add documentation for adjust_part to the build_image usage.
BUG=None
TEST=Ran examples. Verified they did what I expected them to do.
Change-Id: If28f55b04630b85b19bbfa25c4284575c1476839
Reviewed-on: https://chromium-review.googlesource.com/173573
Reviewed-by: Chris Sosa <sosa@chromium.org>
Commit-Queue: Chris Sosa <sosa@chromium.org>
Tested-by: Chris Sosa <sosa@chromium.org>
diff --git a/build_image b/build_image
index 7008100..48e93d0 100755
--- a/build_image
+++ b/build_image
@@ -14,7 +14,7 @@
# Developer-visible flags.
DEFINE_string adjust_part "" \
- "Adjustments to apply to the partition table"
+ "Adjustments to apply to partition table (LABEL:[+-=]SIZE) e.g. ROOT-A:+1G"
DEFINE_string board "${DEFAULT_BOARD}" \
"The board to build an image for."
DEFINE_string boot_args "noinitrd" \
@@ -51,6 +51,14 @@
build_image --board=<board> dev test - builds developer and test images.
build_image --board=<board> factory_install - builds a factory install shim.
+
+Note if you want to build an image with custom size partitions, either consider
+adding a new disk layout in build_library/legacy_disk_layout.json OR use
+--adjust_part. See the help above but here are a few examples:
+
+--adjust_part='STATE:+1G' -- add one GB to the size the stateful partition
+--adjust_part='ROOT-A:-1G' -- remove one GB from the primary rootfs partition
+--adjust_part='STATE:=1G' -- make the stateful partition 1 GB
...
"
show_help_if_requested "$@"