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:
parent
dfe8e03d66
commit
f0f3f6661b
1 changed files with 8 additions and 0 deletions
|
@ -41,6 +41,14 @@ line_exists_or_append() {
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
# Print a debug message to stdout
|
# 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() {
|
dbg_msg() {
|
||||||
local application="$1"
|
local application="$1"
|
||||||
shift
|
shift
|
||||||
|
|
Loading…
Reference in a new issue