feat(unitproc):vbm: Add script name to verbose error message

[BK-2020-03.git] / unitproc / bktemp-vbm

diff --git a/unitproc/bktemp-vbm b/unitproc/bktemp-vbm
index c7a82b5e3a46cec314a3246f2ddd72300755d5b8..8fa7c1cac2c525f9c7742727c7ae6b762e31c034 100644 (file)
--- a/unitproc/bktemp-vbm
+++ b/unitproc/bktemp-vbm
@@ -3,21 +3,27 @@
 
 vbm() {
     # Description: Prints verbose message ("vbm") to stderr if optionVerbose is set to "true".
 
 vbm() {
     # Description: Prints verbose message ("vbm") to stderr if optionVerbose is set to "true".

-    # Usage: vbm "DEBUG:verbose message here"
-    # Version 0.1.0
+    # Usage: vbm "DEBUG :verbose message here"
+    # Version 0.1.3

     # Input: arg1: string
     #        vars: optionVerbose
     # Output: stderr
     # Input: arg1: string
     #        vars: optionVerbose
     # Output: stderr

-    # Depends: echo
+    # Depends: bash 5.0.3, echo 8.30, date 8.30

 
     if [ "$optionVerbose" = "true" ]; then
        functionTime=$(date --iso-8601=ns); # Save current time in nano seconds.
 
     if [ "$optionVerbose" = "true" ]; then
        functionTime=$(date --iso-8601=ns); # Save current time in nano seconds.

-       echo "[$functionTime] ""$*" 1>&2; # Display argument text.
+       echo "[$functionTime]:$0:""$*" 1>&2; # Display argument text.

     fi
 
     # End function
     return 0; # Function finished.
     fi
 
     # End function
     return 0; # Function finished.

-} # Verbose message display function.
+} # Displays message if optionVerbose true
+
+#==BEGIN sample code==
+vbm "STATUS:This is a status message.";
+optionVerbose="true";
+vbm "STATUS:This is another status message.";
+#==END sample code==

 
 # Author: Steven Baltakatei Sandoval
 # License: GPLv3+
 
 # Author: Steven Baltakatei Sandoval
 # License: GPLv3+