Improve utilities dbg_msg documentation

Added documentation for the various severity levels a dbg_msg function
call can have (info, warn, error).
This commit is contained in:
Marty Oehme 2020-12-22 11:27:23 +01:00
parent dfe8e03d66
commit f0f3f6661b
Signed by: Marty
GPG Key ID: B7538B8F50A1C800
1 changed files with 8 additions and 0 deletions

View File

@ -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