Merge remote-tracking branch 'origin/robo/docker-go-script' into robo/integration-39

Author: robobenklein

build-linux.sh

@@ -10,11 +10,6 @@ fi
 
 while [[ "$1" != "" ]]; do
   case "$1" in
-    "--help"|"-h")
-      echo "$0 <script args> <extra args are passed to cmake>"
-      popd
-      exit 0
-      ;;
     "--")
       # stop parsing args and let cmake take the rest
       shift
@@ -37,6 +32,37 @@ while [[ "$1" != "" ]]; do
       echo " -DENABLE_TESTING=OFF"
       ENABLE_TESTING="OFF"
       ;;
+    "-h"|"--help")
+      cat << EOF
+RIP build script for linux
+
+usage: ./build-linux.sh [options] [--] [extra args passed to cmake]
+
+Creates the dir 'build/' / 'build_armhf/'.
+Runs Cmake with whatever extra args you gave it.
+Attempts a multithreaded build.
+Runs a single-threaded build if the multithreaded is unsuccessful.
+
+Overridable Environment Variables:
+  NO_CD
+          Set this variable to prevent this script from changing back to the RIP directory.
+
+Options:
+  --help
+          Display this message and exit.
+  -c | --clean
+          Remove the build folder before starting the build.
+  -n | --no-cd
+          Do not CD into this scripts' own directory when building.
+          (Perform the same build steps on the current directory.)
+          Used to build robot projects and others which depend on RIP.
+  -p | --production
+          Sets the Cmake variable ENABLE_TESTING to 'OFF'
+          (Default is 'ON')
+          Add this flag if you are building executables to copy to a Pi.
+EOF
+      exit 0
+      ;;
   esac
   shift
 done

go-docker.sh

@@ -41,6 +41,45 @@ while [[ "$1" != "" ]] ; do
       fi
       break
       ;;
+    '-h'|'--help')
+      cat << EOF
+RIP Docker Script 'go-docker.sh'
+
+Usage: ./go-docker.sh [options] [script args] [program ars ...]
+
+Overridable Environment Variables:
+  RPXC_IMAGE="utkrobotics/rip_rpi:latest"
+          See also: --rpxc-tag flag
+  RPXC_SCRIPT_LOCATION="./docker/rpi/rpxc/rpxc"
+          Location of the RPXC script used to enter and setup the rip_rpi container from the host.
+          Location relative to this shell script.
+  RPXC_SYSROOT="/rpxc/sysroot"
+          Location of sysroot *inside* the docker container.
+          Do not change unless using a compatible/different docker image.
+  RIPPROG
+          Uses the same values as --prog flag does. (Shown in menu.)
+
+  (for building containers...)
+  RPI_DIST
+          Sets the raspberry pi distro when building rip_rpi. (i.e. 'jessie'/'stretch')
+  RPI_DOCKER_TAG
+          Set the target docker tag for the rip_rpi build.
+
+Options: <required> [optional]
+  --help
+          Display this help and exit.
+  --prog <program selection>
+          Select a program directly without being prompted by whiptail/dialog.
+  --rpi [--] [command to run in container]
+          Run the RPI emulation container directly with an optional command instead of a shell.
+  --rpxc-tag <tag name>
+          Specify an alternate tag (different from latest) to use for the docker repo.
+          Used like 'utkrobotics/rip_rpi:<tag_name>'
+  -- [anything else]
+          Ignore flags after the '--' and pass them to the program selection.
+EOF
+      exit 0
+      ;;
     *)
       echo "Unknown option: $1"
       exit 1