From b2aa5283e6d6f21e854fa3524e923395477a23e7 Mon Sep 17 00:00:00 2001
From: David Hendricks <davidhendricks@gmail.com>
Date: Sat, 7 May 2016 11:44:05 -0700
Subject: board_status: Add longopt equivalents for older options
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Long options can be useful when writing examples and documentation
as they are more expressive and obvious to the reader.

Change-Id: I39496765ba1f15ccc2ffe1ad730f0f95702f82b8
Signed-off-by: David Hendricks <dhendrix@chromium.org>
Reviewed-on: https://review.coreboot.org/14736
Tested-by: build bot (Jenkins)
Reviewed-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 util/board_status/board_status.sh | 61 ++++++++++++++++++++++++---------------
 1 file changed, 37 insertions(+), 24 deletions(-)

(limited to 'util/board_status')

diff --git a/util/board_status/board_status.sh b/util/board_status/board_status.sh
index 74d01091ea..4716f2cefa 100755
--- a/util/board_status/board_status.sh
+++ b/util/board_status/board_status.sh
@@ -172,22 +172,24 @@ show_help() {
 	${0} <option>
 
 Options
-    -h
-        Show this message.
-    -C
+    -C, --clobber
         Clobber temporary output when finished. Useful for debugging.
-    -i  <image>
+    -h, --help
+        Show this message.
+    -i, --image  <image>
         Path to coreboot image (Default is $COREBOOT_IMAGE).
-    -r  <host>
+    -r, --remote-host  <host>
         Obtain machine information from remote host (using ssh).
-    --ssh-port <port>
-        Use a specific SSH port.
-    -s  </dev/xxx>
+    -s, --serial-device  </dev/xxx>
         Obtain boot log via serial device.
-    -S  <speed>
+    -S, --serial-speed  <speed>
         Set the port speed for the serial device (Default is $SERIAL_PORT_SPEED).
-    -u
+    -u, --upload-results
         Upload results to coreboot.org.
+
+Long options:
+    --ssh-port <port>
+        Use a specific SSH port.
 "
 }
 
@@ -197,41 +199,52 @@ if [ $? -ne 4 ]; then
 	exit $EXIT_FAILURE
 fi
 
-ARGS=$(getopt -o Chi:r:s:S:u -l "ssh-port:" -n "$0" -- "$@");
+LONGOPTS="clobber,help,image:,remote-host:,upload-results"
+LONGOPTS="${LONGOPTS},serial-device:,serial-speed:"
+LONGOPTS="${LONGOPTS},ssh-port:"
+
+ARGS=$(getopt -o Chi:r:s:S:u -l "$LONGOPTS" -n "$0" -- "$@");
 if [ $? != 0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi
 eval set -- "$ARGS"
 while true ; do
 	case "$1" in
-		-h)
+		# generic options
+		-C|--clobber)
+			CLOBBER_OUTPUT=1
+			;;
+		-h|--help)
 			show_help
 			exit $EXIT_SUCCESS
 			;;
-		-C)
-			CLOBBER_OUTPUT=1
-			;;
-		-i)
+		-i|--image)
 			shift
 			COREBOOT_IMAGE="$1"
 			;;
-		-r)
+		-r|--remote-host)
 			shift
 			REMOTE_HOST="$1"
 			;;
-		--ssh-port)
-			shift
-			REMOTE_PORT_OPTION="-p $1"
+		-u|--upload-results)
+			UPLOAD_RESULTS=1
 			;;
-		-s)
+
+		# serial port options
+		-s|--serial-device)
 			shift
 			SERIAL_DEVICE="$1"
 			;;
-		-S)
+		-S|--serial-speed)
 			shift
 			SERIAL_PORT_SPEED="$1"
 			;;
-		-u)
-			UPLOAD_RESULTS=1
+
+		# ssh options
+		--ssh-port)
+			shift
+			REMOTE_PORT_OPTION="-p $1"
 			;;
+
+		# error handling
 		--)
 			shift
 			if [ -n "$*" ]; then
-- 
cgit v1.2.3