deprecate, warn about hyphenated forms of riak-admin

Author: hmmr

rel/files/riak

@@ -66,19 +66,23 @@ case "$1" in
 	;;
     admin)
 	shift
-	maybe_su `which riak-admin` $*
+        # when we are called as `riak admin`, pass a flag to
+        # riak-admin script to suppress the deprecation warning (which
+        # would be printed if that script were called directly, i.e.,
+        # `riak-admin`)
+	maybe_su `which riak-admin` --suppress-deprecation-warning $*
 	;;
     chkconfig)
 	shift
-	maybe_su `which riak-chkconfig` $*
+	maybe_su `which riak-chkconfig` --suppress-deprecation-warning $*
 	;;
     repl)
 	shift
-	maybe_su `which riak-repl` $*
+	maybe_su `which riak-repl` --suppress-deprecation-warning $*
 	;;
     debug)
 	shift
-	maybe_su `which riak-debug` $*
+	maybe_su `which riak-debug` --suppress-deprecation-warning $*
 	;;
     *)
         ESCAPED_ARGS=`echo "$@" | sed -e 's/\([\\\(\\\){}"\x27]\)/\\\\\1/g'`

rel/files/riak-admin

@@ -2,6 +2,21 @@
 # -*- tab-width:4;indent-tabs-mode:nil -*-
 # ex: ts=4 sw=4 et
 
+# suppress_hyphen_deprec_warning is defined in top-level vars.config
+# but not in pkg/*/vars.config
+SUPPRESS_HYPH_DEPREC_WARN={{suppress_hyphen_deprec_warning}}
+
+# the --suppress-deprecation-warning flag is injected in riak launcher
+# script, meaning that if riak-admin is invoked from riak (as `riak
+# admin`), we should not print the warning.
+if [ x$1 = x"--suppress-deprecation-warning" ]; then
+    shift
+elif [ x${SUPPRESS_HYPH_DEPREC_WARN} != x"yes" ]; then
+    echo "The hyphenated form of this command is deprecated. \
+Please fix your scripts to call \`riak admin\` instead.
+"
+fi
+
 # Identify the script name
 SCRIPT="riak-admin"
 

rel/files/riak-chkconfig

@@ -2,6 +2,15 @@
 # -*- tab-width:4;indent-tabs-mode:nil -*-
 # ex: ts=4 sw=4 et
 
+SUPPRESS_HYPH_DEPREC_WARN={{suppress_hyphen_deprec_warning}}
+if [ x$1 = x"--suppress-deprecation-warning" ]; then
+    shift
+elif [ x${SUPPRESS_HYPH_DEPREC_WARN} != x"yes" ]; then
+    echo "The hyphenated form of this command is deprecated. \
+Please fix your scripts to call \`riak chkconfig\` instead.
+"
+fi
+
 PLATFORM_BASE_DIR={{platform_base_dir}}
 PLATFORM_BASE_DIR=${PLATFORM_BASE_DIR:-$(cd $(dirname "$0")/.. && pwd -P)}
 RPC_HOP="${PLATFORM_BASE_DIR}/bin/riak rpc"

rel/files/riak-debug

@@ -22,6 +22,15 @@
 ##
 ## -------------------------------------------------------------------
 
+SUPPRESS_HYPH_DEPREC_WARN={{suppress_hyphen_deprec_warning}}
+if [ x$1 = x"--suppress-deprecation-warning" ]; then
+    shift
+elif [ x${SUPPRESS_HYPH_DEPREC_WARN} != x"yes" ]; then
+    echo "The hyphenated form of this command is deprecated. \
+Please fix your scripts to call \`riak debug\` instead.
+"
+fi
+
 # If you start to think "We should execute some Erlang in here", then go work
 # on Riaknostic, which is called with `riak admin diag` below.
 

rel/files/riak-repl

@@ -2,6 +2,14 @@
 # -*- tab-width:4;indent-tabs-mode:nil -*-
 # ex: ts=4 sw=4 et
 
+SUPPRESS_HYPH_DEPREC_WARN={{suppress_hyphen_deprec_warning}}
+if [ x$1 = x"--suppress-deprecation-warning" ]; then
+    shift
+elif [ x${SUPPRESS_HYPH_DEPREC_WARN} != x"yes" ]; then
+    echo "The hyphenated form of this command is deprecated. \
+Please fix your scripts to call \`riak repl\` instead"
+fi
+
 # Identify the script name
 SCRIPT=`basename $0`
 

rel/pkg/alpine/riak-nosu

@@ -39,19 +39,19 @@ case "$1" in
 	;;
     admin)
 	shift
-	riak-admin $*
+	riak-admin --suppress-deprecation-warning $*
 	;;
     chkconfig)
 	shift
-	riak-chkconfig $*
+	riak-chkconfig --suppress-deprecation-warning $*
 	;;
     repl)
 	shift
-	riak-repl $*
+	riak-repl --suppress-deprecation-warning $*
 	;;
     debug)
 	shift
-	riak-debug $*
+	riak-debug --suppress-deprecation-warning $*
 	;;
     *)
         ESCAPED_ARGS=`echo "$@" | sed -e 's/\([\\\(\\\){}"\x27]\)/\\\\\1/g'`

rel/vars.config

@@ -47,6 +47,10 @@
 %%{pipe_dir,           "$PLATFORM_BASE_DIR/tmp/riak"}.
 %%{pid_dir,            "$PLATFORM_BASE_DIR/var/run/riak"}.
 
+%% suppress hyphenated form deprecation warning for releases made with
+%% `make rel` (as opposed to releases made for packaging)
+{suppress_hyphen_deprec_warning,  "yes"}.
+
 %%
 %% cuttlefish
 %%