Prefix logging functions with '_'
authorBryn M. Reeves <bmr@redhat.com>
Wed, 14 Nov 2012 19:10:49 +0000 (19:10 +0000)
committerBryn M. Reeves <bmr@redhat.com>
Wed, 14 Nov 2012 19:10:49 +0000 (19:10 +0000)
Prefix the names of the logging functions debug(), warn(), and
error() with an underscore.

blkdevalias

index 873fbfe..b3693d4 100755 (executable)
@@ -40,15 +40,15 @@ BA_SCSI_ID_FLAGS="-g -u"
 # load config
 . $BA_CONF
 
-error () {
+_error () {
     echo "ERROR: $@" 1>&2
 }
 
-warn () {
+_warn () {
     echo "WARNING: $@" 1>&2
 }
 
-debug () {
+_debug () {
     [ "$BA_DEBUG" == "yes" ] && echo "$@" 1>&2
 }
 
@@ -58,14 +58,14 @@ print_wwid_mapping() {
     if [ "$WWID" == "" ]; then
         return
     fi
-    debug "ALIAS for WWID '$WWID' is: '${WWIDMAP[$WWID]}' (${TYPEMAP[$WWID]})"
+    _debug "ALIAS for WWID '$WWID' is: '${WWIDMAP[$WWID]}' (${TYPEMAP[$WWID]})"
 }
 
 # store the WWID map to disk
 ba_store_wwid_map() {
     TMP_MAP=$(mktemp --tmpdir=$BA_CONF_DIR)
     if [ ! -f "$TMP_MAP" ]; then
-        error "could not write temporary file"
+        _error "could not write temporary file"
         exit 1
     fi
     for WWID in ${!WWIDMAP[@]}; do
@@ -77,7 +77,7 @@ ba_store_wwid_map() {
 # read the WWID map from disk
 ba_load_wwid_map() {
     if [ ! -f "$BA_MAP_PATH" ] || [ ! -r "$BA_MAP_PATH"  ]; then
-        error "$BA_MAP_PATH does not exist or is not readable"
+        _error "$BA_MAP_PATH does not exist or is not readable"
         exit 1
     fi
     while read WWID ALIAS TYPE; do
@@ -96,17 +96,17 @@ ba_add_wwid_mapping() {
     WWID="$1"
     ALIAS="$2"
     TYPE="$3"
-    debug "ba_add_wwid_mapping WWID=\"$WWID\" ALIAS=\"$ALIAS\""
+    _debug "ba_add_wwid_mapping WWID=\"$WWID\" ALIAS=\"$ALIAS\""
     if [ "$WWID" == "" ]; then
-        warn "no wwid given"
+        _warn "no wwid given"
         return
     fi
     if [ "$ALIAS" == "" ]; then
-        warn "no alias given"
+        _warn "no alias given"
         return
     fi
     if [ "${NAMEMAP[$WWID]}" != "" ]; then
-        warn "$WWID already mapped to alias ${NAMEMAP[$WWID]}; replacing it."
+        _warn "$WWID already mapped to alias ${NAMEMAP[$WWID]}; replacing it."
     fi
     WWIDMAP[$WWID]="$ALIAS"
     NAMEMAP[$ALIAS]="$WWID"
@@ -121,7 +121,7 @@ ba_del_wwid_mapping() {
         return 1
     fi
     if [ "${WWIDMAP[$WWID]}" == "" ]; then
-        warn "WARNING: $WWID does not exist; doing nothing."
+        _warn "WARNING: $WWID does not exist; doing nothing."
         return 1
     fi
     ALIAS=${WWIDMAP[$WWID]}
@@ -161,14 +161,14 @@ EOF
     if [ "$_BA_DEV_PATH" != "" ]; then
         BA_DEV_PATH=$_BA_DEV_PATH;
     fi
-    debug "BA_DEV_PATH=\"$BA_DEV_PATH\""
-    debug "BA_USER=\"$BA_USER\""
-    debug "BA_GROUP=\"$BA_GROUP\""
+    _debug "BA_DEV_PATH=\"$BA_DEV_PATH\""
+    _debug "BA_USER=\"$BA_USER\""
+    _debug "BA_GROUP=\"$BA_GROUP\""
     echo -n "Writing wwid map configuration: "
     TMP_CONF=$(mktemp --tmpdir=$BA_CONF_PATH)
     if [ ! -f "$TMP_CONF" ]; then
         echo
-        error "could not write temporary file"
+        _error "could not write temporary file"
         exit 1
     fi
     echo "BA_DEV_PATH=\"$BA_DEV_PATH\"" >> $TMP_CONF
@@ -176,7 +176,7 @@ EOF
     echo "BA_GROUP=\"$BA_GROUP\"" >> $TMP_CONF
     mv $TMP_CONF $BA_CONF
     if [ "$?" != 0 ]; then
-        error "could not create configuration file $BA_CONF"
+        _error "could not create configuration file $BA_CONF"
         exit
     fi
     echo -e "done\n"
@@ -191,16 +191,16 @@ ba_createdisk () {
         echo "Usage: $0 createdisk <alias> <device>"
         exit 2
     fi
-    debug "ba_createdisk: WWID=\"$WWID\" DEV=\"$DEV\" ALIAS=\"$ALIAS\""
+    _debug "ba_createdisk: WWID=\"$WWID\" DEV=\"$DEV\" ALIAS=\"$ALIAS\""
 
     WWID=$(ba_scsi_id $DEV)
     if [ "$WWID" == "" ]; then
-        error "could not get SCSI ID for $DEV"
+        _error "could not get SCSI ID for $DEV"
         exit 1
     fi
     if [[ $DEV == *mpath* ]]; then
         TYPE=mpath
-        debug "wm_createdisk: WWID=\"$WWID\" DEV=\"$DEV\" ALIAS=\"$ALIAS\""
+        _debug "wm_createdisk: WWID=\"$WWID\" DEV=\"$DEV\" ALIAS=\"$ALIAS\""
     else
         TYPE=sd
     fi
@@ -218,7 +218,7 @@ ba_deletedisk () {
     fi
     WWID=${NAMEMAP[$ALIAS]}
     if [ "$WWID" == "" ]; then
-        error "\"$ALIAS\" does not exist"
+        _error "\"$ALIAS\" does not exist"
         echo "Usage: $0 deletedisk <alias>"
         exit 2
     fi
@@ -246,13 +246,13 @@ ba_querydisk () {
         exit 2
     fi
     WWID=${NAMEMAP[$ALIAS]}
-    debug "ba_querydisk: ALIAS=\"$ALIAS\" WWID=\"$WWID\" LISTDEV=\"$LISTDEV\""
+    _debug "ba_querydisk: ALIAS=\"$ALIAS\" WWID=\"$WWID\" LISTDEV=\"$LISTDEV\""
     if [ "$LISTDEV" == "1" ]; then
         DEV="/dev/$BA_DEV_PATH/$(readlink "/dev/$BA_DEV_PATH/$ALIAS")"
         MAJ="$[0x$(stat --format "%t" $DEV)]"
         MIN="$[0x$(stat --format "%T" $DEV)]"
         ONDEV="on device [$MAJ,$MIN]"
-        debug "ba_querydisk: DEV=\"$DEV\" MAJ=\"$MAJ\" MIN=\"$MIN\""
+        _debug "ba_querydisk: DEV=\"$DEV\" MAJ=\"$MAJ\" MIN=\"$MIN\""
     fi
     if [ "$WWID" != "" ]; then
         echo "$ALIAS is a valid blkdevalias disk $ONDEV"
@@ -262,7 +262,7 @@ ba_querydisk () {
 }
 
 ba_scandisks () {
-    warn "(unimplemented)"
+    _warn "(unimplemented)"
 }
 
 ba_map () {