crosutils: add boilerplate comments for factory scripts

Adding boilerplate comments for factory scripts that may be executed inside
CrOS source tree or a limited factory bundle extraction.

BUG=chrome-os-partner:5979
TEST=none, only comment update

Change-Id: Ifd5b07e9d44f4ce74073e5e32370040d2d6728d8
Reviewed-on: http://gerrit.chromium.org/gerrit/7908
Reviewed-by: Hung-Te Lin <hungte@chromium.org>
Tested-by: Hung-Te Lin <hungte@chromium.org>
This commit is contained in:
Hung-Te Lin 2011-09-18 20:30:46 +08:00
parent ab4c4e1c69
commit 17eeff6fcb
3 changed files with 6 additions and 0 deletions

View File

@ -11,6 +11,7 @@
# miniomaha lives in src/platform/dev/ and miniomaha partition sets live # miniomaha lives in src/platform/dev/ and miniomaha partition sets live
# in src/platform/dev/static. # in src/platform/dev/static.
# --- BEGIN FACTORY SCRIPTS BOILERPLATE ---
# This script may be executed in a full CrOS source tree or an extracted factory # This script may be executed in a full CrOS source tree or an extracted factory
# bundle with limited tools, so we must always load scripts from $SCRIPT_ROOT # bundle with limited tools, so we must always load scripts from $SCRIPT_ROOT
# and search for binary programs in $SCRIPT_ROOT/../bin # and search for binary programs in $SCRIPT_ROOT/../bin
@ -19,6 +20,7 @@ SCRIPT="$(readlink -f "$0")"
SCRIPT_ROOT="$(dirname "$SCRIPT")" SCRIPT_ROOT="$(dirname "$SCRIPT")"
. "$SCRIPT_ROOT/lib/cros_image_common.sh" || exit 1 . "$SCRIPT_ROOT/lib/cros_image_common.sh" || exit 1
image_find_tool "cgpt" "$SCRIPT_ROOT/../bin" image_find_tool "cgpt" "$SCRIPT_ROOT/../bin"
# --- END FACTORY SCRIPTS BOILERPLATE ---
if [ -f "$SCRIPT_ROOT/../dev/devserver.py" ]; then if [ -f "$SCRIPT_ROOT/../dev/devserver.py" ]; then
# Running within an extracted factory bundle # Running within an extracted factory bundle

View File

@ -9,6 +9,7 @@
# CAUTION: Recovery shim images are not supported yet because they require the # CAUTION: Recovery shim images are not supported yet because they require the
# kernel partitions to be laid out in a special way # kernel partitions to be laid out in a special way
# --- BEGIN FACTORY SCRIPTS BOILERPLATE ---
# This script may be executed in a full CrOS source tree or an extracted factory # This script may be executed in a full CrOS source tree or an extracted factory
# bundle with limited tools, so we must always load scripts from $SCRIPT_ROOT # bundle with limited tools, so we must always load scripts from $SCRIPT_ROOT
# and search for binary programs in $SCRIPT_ROOT/../bin # and search for binary programs in $SCRIPT_ROOT/../bin
@ -17,6 +18,7 @@ SCRIPT="$(readlink -f "$0")"
SCRIPT_ROOT="$(dirname "$SCRIPT")" SCRIPT_ROOT="$(dirname "$SCRIPT")"
. "$SCRIPT_ROOT/lib/cros_image_common.sh" || exit 1 . "$SCRIPT_ROOT/lib/cros_image_common.sh" || exit 1
image_find_tool "cgpt" "$SCRIPT_ROOT/../bin" image_find_tool "cgpt" "$SCRIPT_ROOT/../bin"
# --- END FACTORY SCRIPTS BOILERPLATE ---
# CGPT Header: PMBR, header, table; sec_table, sec_header # CGPT Header: PMBR, header, table; sec_table, sec_header
CGPT_START_SIZE=$((1 + 1 + 32)) CGPT_START_SIZE=$((1 + 1 + 32))

View File

@ -8,6 +8,7 @@
# build_image.sh and generates an image that can be used for auto # build_image.sh and generates an image that can be used for auto
# update. # update.
# --- BEGIN FACTORY SCRIPTS BOILERPLATE ---
# This script may be executed in a full CrOS source tree or an extracted factory # This script may be executed in a full CrOS source tree or an extracted factory
# bundle with limited tools, so we must always load scripts from $SCRIPT_ROOT # bundle with limited tools, so we must always load scripts from $SCRIPT_ROOT
# and search for binary programs in $SCRIPT_ROOT/../bin # and search for binary programs in $SCRIPT_ROOT/../bin
@ -16,6 +17,7 @@ SCRIPT="$(readlink -f "$0")"
SCRIPT_ROOT="$(dirname "$SCRIPT")" SCRIPT_ROOT="$(dirname "$SCRIPT")"
. "$SCRIPT_ROOT/lib/cros_image_common.sh" || exit 1 . "$SCRIPT_ROOT/lib/cros_image_common.sh" || exit 1
image_find_tool "cgpt" "$SCRIPT_ROOT/../bin" image_find_tool "cgpt" "$SCRIPT_ROOT/../bin"
# --- END FACTORY SCRIPTS BOILERPLATE ---
set -e set -e
# We need 2-3 non-zero parameters. # We need 2-3 non-zero parameters.