cqfd: smoothen up user interface

The user interface is refactored to rely on explicit action verbs such
as "run", "release" or "init" instead of short options.

Documentation is updated accordingly.

Change-Id: I69bc72525cc13b1644200a5610ed161f6d768644

Author: joufellasfl

CHANGELOG

@@ -2,6 +2,7 @@
 
 == Untagged changes
 
+* Use action verbs in user interface
 * Do not have user depend on SSH_AUTH_SOCK
 
 == Version v1

common/sfl/README.cqfd

@@ -76,7 +76,7 @@ The following command creates the initial build container after
 entering your project's git repository:
 
  $ cd path/to/fooinc/buildroot/
- $ sfl/cqfd -i
+ $ sfl/cqfd init
 
 +cqfd+ will use the provided Dockerfile to create a normalized runtime
 build environment for your project.
@@ -94,15 +94,16 @@ Alternatively, you may want to specify a custom build command to be
 executed from inside the build container. To do this, use the -b
 option:
 
- $ sfl/cqfd -b "make clean"
+ $ sfl/cqfd run make clean
+ $ sfl/cqfd run "make linux-dirclean && make foobar-dirclean"
 
 ==== Release
 
-The +-j+ option allows creating a release tarball for your
-project. The release files (as specified in your +.sflproject+) will
-be included inside the release archive.
+The release command behaves exactly like run, but creates a release
+tarball for your project additionally. The release files (as specified
+in your +.sflproject+) will be included inside the release archive.
 
- $ sfl/cqfd -j
+ $ sfl/cqfd release
 
 The resulting release file is then called
 ${JOB_NAME}_${BUILD_ID}.tar.xz, where JOB_NAME is either your Jenkins

common/sfl/cqfd

@@ -11,24 +11,19 @@ ESUCCESS=0
 PROGNAME=`basename $0`
 TOPDIR=`cd $(dirname $0)/..; pwd`
 
-## usage() - print usage on stdin
+## usage() - print usage on stdout
 usage() {
 cat <<EOF
-Usage: $PROGNAME [OPTIONS]
-
-* If you have a .sflproject: $PROGNAME
-* If you want to build with a special command: $PROGNAME -b <"CMD">
-* If you want default build command: $PROGNAME <OPTIONS>
-
-Options are:
-	-b <build command>		    Specify a build command to pass to
-					      docker.
-	-g <client_reponame>		    The name of the docker image
-					      Default is client_reponame,
-					      Note: use before -i
-	-j				    Make an archive out of release
-					      files
-	-i				    Initialize build container.
+Usage: $PROGNAME [COMMAND] [ARGUMENTS]
+
+Commands:
+    init     Initialize project build container
+    run      Run argument(s) inside build container
+    release  Run argument(s) and release software
+    help     Show this help text
+
+    By default, run is assumed, and the run command is the one
+    configured in .sflproject.
 EOF
 }
 
@@ -141,33 +136,30 @@ if [ -n "$CUST_CODENAME" -a -n "$CUST_PROJECT" ]; then
 	DOCKER_IMG_NAME="${CUST_CODENAME}_${CUST_PROJECT}"
 fi
 
-while getopts "ijhb:g:" OPTION; do
-	case "$OPTION" in
-	h)
-		usage
-		exit $ESUCCESS
-		;;
-	b)
-		BUILD_CMD="$OPTARG"
-		;;
-	g)
-		DOCKER_IMG_NAME="$OPTARG"
-		;;
-	j)
-		MAKE_ARCHIVE=1
-		;;
-	i)
-		# We expect a Dockerfile is always present
-		[ -f "$DOCKER_FILE" ] || die " $DOCKER_FILE not found"
-		[ -n "$DOCKER_IMG_NAME" ] || die "No customer codename set"
-		docker_build $DOCKER_IMG_NAME
-		exit $?
-		;;
-	*)
-		die "Unknown parameter $OPTION"
-		;;
-	esac
-done
+case "$1" in
+help|-h|--help)
+	usage
+	exit $ESUCCESS
+	;;
+init)
+	# We expect a Dockerfile is always present
+	[ -f "$DOCKER_FILE" ] || die " $DOCKER_FILE not found"
+	[ -n "$DOCKER_IMG_NAME" ] || die "No customer codename set"
+	docker_build $DOCKER_IMG_NAME
+	exit $?
+	;;
+run|release)
+	[ "$1" = "release" ] && MAKE_ARCHIVE=1
+	shift
+	[ $# -ge 1 ] && BUILD_CMD="$@"
+	;;
+?*)
+	die "Unknown command: $1"
+	;;
+*)
+	# empty or no argument case
+	;;
+esac
 
 if [ -z "$BUILD_CMD" ]; then
 	die "No build.command defined in .sflproject !"