* [PATCH] Import OE-core logger
@ 2018-06-04 7:17 Jan Kiszka
2018-06-05 9:24 ` Maxim Yu. Osipov
0 siblings, 1 reply; 3+ messages in thread
From: Jan Kiszka @ 2018-06-04 7:17 UTC (permalink / raw)
To: isar-users
From: Jan Kiszka <jan.kiszka@siemens.com>
This ensures bash recipe messages go to the logger, not just the recipe
log files. It also adds the missing bbplain, bberror and bbdebug
functions.
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
---
meta/classes/base.bbclass | 13 +-----
meta/classes/logging.bbclass | 105 +++++++++++++++++++++++++++++++++++++++++++
2 files changed, 106 insertions(+), 12 deletions(-)
create mode 100644 meta/classes/logging.bbclass
diff --git a/meta/classes/base.bbclass b/meta/classes/base.bbclass
index d1df8cc3..99730e59 100644
--- a/meta/classes/base.bbclass
+++ b/meta/classes/base.bbclass
@@ -24,18 +24,7 @@ die() {
bbfatal "$*"
}
-bbnote() {
- echo "NOTE:" "$*"
-}
-
-bbwarn() {
- echo "WARNING:" "$*"
-}
-
-bbfatal() {
- echo "FATAL:" "$*"
- exit 1
-}
+inherit logging
# Derived from bitbake: bitbake/classes/base.bbclass
addtask showdata
diff --git a/meta/classes/logging.bbclass b/meta/classes/logging.bbclass
new file mode 100644
index 00000000..3277aa34
--- /dev/null
+++ b/meta/classes/logging.bbclass
@@ -0,0 +1,105 @@
+#
+# Imported from OE-core project
+#
+# SPDX-License-Identifier: MIT
+
+# 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.
+
+LOGFIFO = "${T}/fifo.${@os.getpid()}"
+
+# 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
+bbplain() {
+ if [ -p ${LOGFIFO} ] ; then
+ printf "%b\0" "bbplain $*" > ${LOGFIFO}
+ else
+ echo "$*"
+ fi
+}
+
+# Notify the user of a noteworthy condition.
+# Output: logs
+bbnote() {
+ if [ -p ${LOGFIFO} ] ; then
+ printf "%b\0" "bbnote $*" > ${LOGFIFO}
+ else
+ echo "NOTE: $*"
+ fi
+}
+
+# Print a warning to the log. Warnings are non-fatal, and do not
+# indicate a build failure.
+# Output: logs console
+bbwarn() {
+ if [ -p ${LOGFIFO} ] ; then
+ printf "%b\0" "bbwarn $*" > ${LOGFIFO}
+ else
+ echo "WARNING: $*"
+ fi
+}
+
+# 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 console
+bberror() {
+ if [ -p ${LOGFIFO} ] ; then
+ printf "%b\0" "bberror $*" > ${LOGFIFO}
+ else
+ echo "ERROR: $*"
+ fi
+}
+
+# Print a fatal error to the log. Fatal errors indicate build failure
+# and halt the build, exiting with an error code.
+# Output: logs console
+bbfatal() {
+ if [ -p ${LOGFIFO} ] ; then
+ printf "%b\0" "bbfatal $*" > ${LOGFIFO}
+ else
+ echo "ERROR: $*"
+ fi
+ exit 1
+}
+
+# Like bbfatal, except prevents the suppression of the error log by
+# bitbake's UI.
+# Output: logs console
+bbfatal_log() {
+ if [ -p ${LOGFIFO} ] ; then
+ printf "%b\0" "bbfatal_log $*" > ${LOGFIFO}
+ else
+ echo "ERROR: $*"
+ fi
+ 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"
+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
+ NONDIGITS=$(echo "$DBGLVL" | tr -d [:digit:])
+ if [ "$NONDIGITS" ]; then
+ bbfatal "$USAGE"
+ fi
+
+ # All debug output is printed to the logs
+ if [ -p ${LOGFIFO} ] ; then
+ printf "%b\0" "bbdebug $DBGLVL $*" > ${LOGFIFO}
+ else
+ echo "DEBUG: $*"
+ fi
+}
--
2.13.6
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] Import OE-core logger
2018-06-04 7:17 [PATCH] Import OE-core logger Jan Kiszka
@ 2018-06-05 9:24 ` Maxim Yu. Osipov
2018-06-05 9:33 ` Jan Kiszka
0 siblings, 1 reply; 3+ messages in thread
From: Maxim Yu. Osipov @ 2018-06-05 9:24 UTC (permalink / raw)
To: Jan Kiszka, isar-users
On 06/04/2018 09:17 AM, Jan Kiszka wrote:
> From: Jan Kiszka <jan.kiszka@siemens.com>
>
> This ensures bash recipe messages go to the logger, not just the recipe
> log files. It also adds the missing bbplain, bberror and bbdebug
> functions.
Fixed a couple of trailing whitespaces and applied to next,
Thanks,
Maxim.
> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
> ---
> meta/classes/base.bbclass | 13 +-----
> meta/classes/logging.bbclass | 105 +++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 106 insertions(+), 12 deletions(-)
> create mode 100644 meta/classes/logging.bbclass
>
> diff --git a/meta/classes/base.bbclass b/meta/classes/base.bbclass
> index d1df8cc3..99730e59 100644
> --- a/meta/classes/base.bbclass
> +++ b/meta/classes/base.bbclass
> @@ -24,18 +24,7 @@ die() {
> bbfatal "$*"
> }
>
> -bbnote() {
> - echo "NOTE:" "$*"
> -}
> -
> -bbwarn() {
> - echo "WARNING:" "$*"
> -}
> -
> -bbfatal() {
> - echo "FATAL:" "$*"
> - exit 1
> -}
> +inherit logging
>
> # Derived from bitbake: bitbake/classes/base.bbclass
> addtask showdata
> diff --git a/meta/classes/logging.bbclass b/meta/classes/logging.bbclass
> new file mode 100644
> index 00000000..3277aa34
> --- /dev/null
> +++ b/meta/classes/logging.bbclass
> @@ -0,0 +1,105 @@
> +#
> +# Imported from OE-core project
> +#
> +# SPDX-License-Identifier: MIT
> +
> +# 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.
> +
> +LOGFIFO = "${T}/fifo.${@os.getpid()}"
> +
> +# 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
> +bbplain() {
> + if [ -p ${LOGFIFO} ] ; then
> + printf "%b\0" "bbplain $*" > ${LOGFIFO}
> + else
> + echo "$*"
> + fi
> +}
> +
> +# Notify the user of a noteworthy condition.
> +# Output: logs
> +bbnote() {
> + if [ -p ${LOGFIFO} ] ; then
> + printf "%b\0" "bbnote $*" > ${LOGFIFO}
> + else
> + echo "NOTE: $*"
> + fi
> +}
> +
> +# Print a warning to the log. Warnings are non-fatal, and do not
> +# indicate a build failure.
> +# Output: logs console
> +bbwarn() {
> + if [ -p ${LOGFIFO} ] ; then
> + printf "%b\0" "bbwarn $*" > ${LOGFIFO}
> + else
> + echo "WARNING: $*"
> + fi
> +}
> +
> +# 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 console
> +bberror() {
> + if [ -p ${LOGFIFO} ] ; then
> + printf "%b\0" "bberror $*" > ${LOGFIFO}
> + else
> + echo "ERROR: $*"
> + fi
> +}
> +
> +# Print a fatal error to the log. Fatal errors indicate build failure
> +# and halt the build, exiting with an error code.
> +# Output: logs console
> +bbfatal() {
> + if [ -p ${LOGFIFO} ] ; then
> + printf "%b\0" "bbfatal $*" > ${LOGFIFO}
> + else
> + echo "ERROR: $*"
> + fi
> + exit 1
> +}
> +
> +# Like bbfatal, except prevents the suppression of the error log by
> +# bitbake's UI.
> +# Output: logs console
> +bbfatal_log() {
> + if [ -p ${LOGFIFO} ] ; then
> + printf "%b\0" "bbfatal_log $*" > ${LOGFIFO}
> + else
> + echo "ERROR: $*"
> + fi
> + 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"
> +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
> + NONDIGITS=$(echo "$DBGLVL" | tr -d [:digit:])
> + if [ "$NONDIGITS" ]; then
> + bbfatal "$USAGE"
> + fi
> +
> + # All debug output is printed to the logs
> + if [ -p ${LOGFIFO} ] ; then
> + printf "%b\0" "bbdebug $DBGLVL $*" > ${LOGFIFO}
> + else
> + echo "DEBUG: $*"
> + fi
> +}
>
--
Maxim Osipov
ilbers GmbH
Maria-Merian-Str. 8
85521 Ottobrunn
Germany
+49 (151) 6517 6917
mosipov@ilbers.de
http://ilbers.de/
Commercial register Munich, HRB 214197
General Manager: Baurzhan Ismagulov
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] Import OE-core logger
2018-06-05 9:24 ` Maxim Yu. Osipov
@ 2018-06-05 9:33 ` Jan Kiszka
0 siblings, 0 replies; 3+ messages in thread
From: Jan Kiszka @ 2018-06-05 9:33 UTC (permalink / raw)
To: Maxim Yu. Osipov, isar-users
On 2018-06-05 11:24, Maxim Yu. Osipov wrote:
> On 06/04/2018 09:17 AM, Jan Kiszka wrote:
>> From: Jan Kiszka <jan.kiszka@siemens.com>
>>
>> This ensures bash recipe messages go to the logger, not just the recipe
>> log files. It also adds the missing bbplain, bberror and bbdebug
>> functions.
>
> Fixed a couple of trailing whitespaces and applied to next,
>
This was a 1:1 import from OE. Now it's only (hopefully) logically
identical.
Jan
> Thanks,
> Maxim.
>
>
>> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
>> ---
>> meta/classes/base.bbclass | 13 +-----
>> meta/classes/logging.bbclass | 105
>> +++++++++++++++++++++++++++++++++++++++++++
>> 2 files changed, 106 insertions(+), 12 deletions(-)
>> create mode 100644 meta/classes/logging.bbclass
>>
>> diff --git a/meta/classes/base.bbclass b/meta/classes/base.bbclass
>> index d1df8cc3..99730e59 100644
>> --- a/meta/classes/base.bbclass
>> +++ b/meta/classes/base.bbclass
>> @@ -24,18 +24,7 @@ die() {
>> bbfatal "$*"
>> }
>> -bbnote() {
>> - echo "NOTE:" "$*"
>> -}
>> -
>> -bbwarn() {
>> - echo "WARNING:" "$*"
>> -}
>> -
>> -bbfatal() {
>> - echo "FATAL:" "$*"
>> - exit 1
>> -}
>> +inherit logging
>> # Derived from bitbake: bitbake/classes/base.bbclass
>> addtask showdata
>> diff --git a/meta/classes/logging.bbclass b/meta/classes/logging.bbclass
>> new file mode 100644
>> index 00000000..3277aa34
>> --- /dev/null
>> +++ b/meta/classes/logging.bbclass
>> @@ -0,0 +1,105 @@
>> +#
>> +# Imported from OE-core project
>> +#
>> +# SPDX-License-Identifier: MIT
>> +
>> +# 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.
>> +
>> +LOGFIFO = "${T}/fifo.${@os.getpid()}"
>> +
>> +# 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
>> +bbplain() {
>> + if [ -p ${LOGFIFO} ] ; then
>> + printf "%b\0" "bbplain $*" > ${LOGFIFO}
>> + else
>> + echo "$*"
>> + fi
>> +}
>> +
>> +# Notify the user of a noteworthy condition.
>> +# Output: logs
>> +bbnote() {
>> + if [ -p ${LOGFIFO} ] ; then
>> + printf "%b\0" "bbnote $*" > ${LOGFIFO}
>> + else
>> + echo "NOTE: $*"
>> + fi
>> +}
>> +
>> +# Print a warning to the log. Warnings are non-fatal, and do not
>> +# indicate a build failure.
>> +# Output: logs console
>> +bbwarn() {
>> + if [ -p ${LOGFIFO} ] ; then
>> + printf "%b\0" "bbwarn $*" > ${LOGFIFO}
>> + else
>> + echo "WARNING: $*"
>> + fi
>> +}
>> +
>> +# 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 console
>> +bberror() {
>> + if [ -p ${LOGFIFO} ] ; then
>> + printf "%b\0" "bberror $*" > ${LOGFIFO}
>> + else
>> + echo "ERROR: $*"
>> + fi
>> +}
>> +
>> +# Print a fatal error to the log. Fatal errors indicate build failure
>> +# and halt the build, exiting with an error code.
>> +# Output: logs console
>> +bbfatal() {
>> + if [ -p ${LOGFIFO} ] ; then
>> + printf "%b\0" "bbfatal $*" > ${LOGFIFO}
>> + else
>> + echo "ERROR: $*"
>> + fi
>> + exit 1
>> +}
>> +
>> +# Like bbfatal, except prevents the suppression of the error log by
>> +# bitbake's UI.
>> +# Output: logs console
>> +bbfatal_log() {
>> + if [ -p ${LOGFIFO} ] ; then
>> + printf "%b\0" "bbfatal_log $*" > ${LOGFIFO}
>> + else
>> + echo "ERROR: $*"
>> + fi
>> + 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"
>> +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
>> + NONDIGITS=$(echo "$DBGLVL" | tr -d [:digit:])
>> + if [ "$NONDIGITS" ]; then
>> + bbfatal "$USAGE"
>> + fi
>> +
>> + # All debug output is printed to the logs
>> + if [ -p ${LOGFIFO} ] ; then
>> + printf "%b\0" "bbdebug $DBGLVL $*" > ${LOGFIFO}
>> + else
>> + echo "DEBUG: $*"
>> + fi
>> +}
>>
>
>
--
Siemens AG, Corporate Technology, CT RDA IOT SES-DE
Corporate Competence Center Embedded Linux
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2018-06-05 9:33 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-06-04 7:17 [PATCH] Import OE-core logger Jan Kiszka
2018-06-05 9:24 ` Maxim Yu. Osipov
2018-06-05 9:33 ` Jan Kiszka
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox