diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2016-10-04 09:20:21 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-10-11 08:51:22 +0100 |
commit | 3b4987a32b55ff7da10ea0734eae0c67f6bc7624 (patch) | |
tree | b3ab97e1edd8c0e936a9f9daeee41601b164d507 /documentation | |
parent | b1e4d96e284d6eb080907ab629bddc88b3208161 (diff) | |
download | poky-3b4987a32b55ff7da10ea0734eae0c67f6bc7624.tar.gz |
ref-manual: Added note about bb.fatal() raising an exception.
Fixes [YOCTO #10363]
Added a small note to the bullet item about bb.fatal(). Noted
that the function raises an exception so the user does not
have to put a "return" statement after the function call.
(From yocto-docs rev: c27bae87192b7e109d995679c8c91fb3388d8d4c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/usingpoky.xml | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 36525c47b0..f7345547c5 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml | |||
@@ -902,6 +902,11 @@ | |||
902 | This logging function is similar to | 902 | This logging function is similar to |
903 | <filename>bb.error(</filename><replaceable>msg</replaceable><filename>)</filename> | 903 | <filename>bb.error(</filename><replaceable>msg</replaceable><filename>)</filename> |
904 | but also causes the calling task to fail. | 904 | but also causes the calling task to fail. |
905 | <note> | ||
906 | <filename>bb.fatal()</filename> raises an exception, | ||
907 | which means you do not need to put a "return" | ||
908 | statement after the function. | ||
909 | </note> | ||
905 | </para></listitem> | 910 | </para></listitem> |
906 | </itemizedlist> | 911 | </itemizedlist> |
907 | </para> | 912 | </para> |