From f0f3f6661baef4a1271d84ccfed07019548e52a9 Mon Sep 17 00:00:00 2001
From: Marty Oehme <marty.oehme@gmail.com>
Date: Tue, 22 Dec 2020 11:27:23 +0100
Subject: [PATCH] Improve utilities dbg_msg documentation

Added documentation for the various severity levels a dbg_msg function
call can have (info, warn, error).
---
 utilities.sh | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/utilities.sh b/utilities.sh
index 99c2b9b..eed3562 100644
--- a/utilities.sh
+++ b/utilities.sh
@@ -41,6 +41,14 @@ line_exists_or_append() {
   fi
 }
 # Print a debug message to stdout
+# Takes arguments in the form:
+#   dbg_msg application-name [severity] message
+#
+# Application name and message are mandatory.
+# Severity level should be one of
+# error | warn | info
+# in decreasing severity.
+# If no severity level is applied, it defaults to info.
 dbg_msg() {
   local application="$1"
   shift