Commit 744b2b91 authored by Thomas Abraham's avatar Thomas Abraham Committed by Arvind Chauhan
Browse files

sgi/busybox_boot: improve the documentation of the busybox_boot command



Improve the user help message of the busybox_boot command for the SGI platforms.
The help message now includes examples of the command usage.

Change-Id: Idc41c31eb8b2437e851baef5e234da7785e631f3
Signed-off-by: Thomas Abraham's avatarThomas Abraham <thomas.abraham@arm.com>
parent 20da6a35
......@@ -48,16 +48,36 @@ __print_supported_sgi_platforms()
print_usage ()
{
echo "busybox_boot:"
echo "Usage: ./busybox_boot.sh -p <platform> [-n <true|false>] [-a \"model params\"] [-j \"0|1\"]"
echo ""
echo "Busybox boot on System Guidance for Infrastructure Models."
echo "Boots upto busybox console on a specified System Guidance for Infrastructure"
echo "platform."
echo ""
echo "busybox_boot -p [platform]"
echo " -p - SGI platform name"
echo "Supported command line parameters - "
echo " -p specifies the SGI platform to be selected. See below for list of"
echo " SGI platforms supported \(mandatory\)"
echo " -n enable or disable network controller support on the platform \(optional\)."
echo " If not specified, network support is disabled by default."
echo " -a Additional model parameters \(optional\)."
echo " -j Enable or disable auto termination of the model after booting upto"
echo " a busybox shell \(optional\). If not specified, default behaviour is"
echo " to keep the model executing."
echo ""
echo "Examples:"
__print_supported_sgi_platforms
echo ""
echo "Example 1: ./busybox_boot.sh -p sgi575"
echo " This command starts the execution of the SGI-575 model and the software boots"
echo " upto the busybox prompt"
echo ""
echo "Example 2: ./busybox_boot.sh -p sgi575 -n true"
echo " This command starts the execution of the SGI-575 model and the software boots"
echo " upto the busybox prompt. The model supports networking allowing the software"
echo " running within the model to access the network."
echo ""
echo " busybox_boot -p sgi575"
echo "Example 3: ./busybox_boot.sh -p sgi575 -n true -a \"board.flash0.diagnostics=1\""
echo " This command starts the execution of the SGI-575 model with networking"
echo " enabled and the software boots upto the busybox prompt. Additional"
echo " parameters to the model are supplied using the -a command line parameter."
echo ""
}
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment