summaryrefslogtreecommitdiff
path: root/meta/classes/logging.bbclass
diff options
context:
space:
mode:
authorDarren Hart <dvhart@linux.intel.com>2011-04-22 09:25:23 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-04-28 09:52:29 +0100
commit7cb3f0206619b725e404282fa7a3ac50b4609f1e (patch)
treee35be586460e78036fbdbbee438152df885f4a92 /meta/classes/logging.bbclass
parent513aa1dc61c26476f10a643f8dafc3d025f408c4 (diff)
downloadopenembedded-core-7cb3f0206619b725e404282fa7a3ac50b4609f1e.tar.gz
openembedded-core-7cb3f0206619b725e404282fa7a3ac50b4609f1e.tar.bz2
openembedded-core-7cb3f0206619b725e404282fa7a3ac50b4609f1e.zip
logging: add bb* logging mechanisms for bash recipe functions
The following logging mechanisms are to be used in bash functions of recipes. They are intended to map one to one in intention and output format with the python recipe logging functions of a similar naming convention: bb.plain(), bb.note(), etc. For the time being, all of these print only to the task logs. Future enhancements may integrate these calls with the bitbake logging infrastructure, allowing for printing to the console as appropriate. The interface and intention statements reflect that future goal. Once it is in place, no changes will be necessary to recipes using these logging mechanisms. I opted to write new functions instead of modifying the oe* logging functions from base.bbclass (and utils.bbclass in oe) for a couple reasons. First, one of my goals was to generate a uniform logging API between bash and python in recipes. Second, there are no users of oe* logging in meta (oe-core) or meta-yocto, while several oe recipes do use them. I wanted to make a clean start with the freedom to change behavior without forcing the oe recipes to change or experience unexpected logging changes. Eventually, the oe recipes can be migrated to the new bb* logging routines and the existing oe* routines can be retired (deleted). Signed-off-by: Darren Hart <dvhart@linux.intel.com> Cc: Chris Larson <clarson@kergoth.com>
Diffstat (limited to 'meta/classes/logging.bbclass')
-rw-r--r--meta/classes/logging.bbclass72
1 files changed, 72 insertions, 0 deletions
diff --git a/meta/classes/logging.bbclass b/meta/classes/logging.bbclass
new file mode 100644
index 0000000000..78d65bda3a
--- /dev/null
+++ b/meta/classes/logging.bbclass
@@ -0,0 +1,72 @@
+# The following logging mechanisms are to be used in bash functions of recipes.
+# They are intended to map one to one in intention and output format with the
+# python recipe logging functions of a similar naming convention: bb.plain(),
+# bb.note(), etc.
+#
+# For the time being, all of these print only to the task logs. Future
+# enhancements may integrate these calls with the bitbake logging
+# infrastructure, allowing for printing to the console as appropriate. The
+# interface and intention statements reflect that future goal. Once it is
+# in place, no changes will be necessary to recipes using these logging
+# mechanisms.
+
+# Print the output exactly as it is passed in. Typically used for output of
+# tasks that should be seen on the console. Use sparingly.
+# Output: logs console
+# NOTE: console output is not currently implemented.
+bbplain() {
+ echo "$*"
+}
+
+# Notify the user of a noteworthy condition.
+# Output: logs console
+# NOTE: console output is not currently implemented.
+bbnote() {
+ echo "NOTE: $*"
+}
+
+# Print a warning to the log. Warnings are non-fatal, and do not
+# indicate a build failure.
+# Output: logs
+bbwarn() {
+ echo "WARNING: $*"
+}
+
+# Print an error to the log. Errors are non-fatal in that the build can
+# continue, but they do indicate a build failure.
+# Output: logs
+bberror() {
+ echo "ERROR: $*"
+}
+
+# Print a fatal error to the log. Fatal errors indicate build failure
+# and halt the build, exiting with an error code.
+# Output: logs
+bbfatal() {
+ echo "ERROR: $*"
+ exit 1
+}
+
+# Print debug messages. These are appropriate for progress checkpoint
+# messages to the logs. Depending on the debug log level, they may also
+# go to the console.
+# Output: logs console
+# Usage: bbdebug 1 "first level debug message"
+# bbdebug 2 "second level debug message"
+# NOTE: console output is not currently implemented.
+bbdebug() {
+ USAGE='Usage: bbdebug [123] "message"'
+ if [ $# -lt 2 ]; then
+ bbfatal "$USAGE"
+ fi
+
+ # Strip off the debug level and ensure it is an integer
+ DBGLVL=$1; shift
+ if ! [[ "$DBGLVL" =~ ^[0-9]+ ]]; then
+ bbfatal "$USAGE"
+ fi
+
+ # All debug output is printed to the logs
+ echo "DEBUG: $*"
+}
+