[gnome-continuous-yocto/gnomeostree-3.28-rocko: 2970/8267] ref-manual: Added note about bb.fatal() raising an exception.

[Emmanuele Bassi <ebassi src gnome org>]

commit 3b4987a32b55ff7da10ea0734eae0c67f6bc7624
Author: Scott Rifenbark <srifenbark gmail com>
Date:   Tue Oct 4 09:20:21 2016 -0700

    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>

 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 36525c4..f734554 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -902,6 +902,11 @@
                     This logging function is similar to
                     <filename>bb.error(</filename><replaceable>msg</replaceable><filename>)</filename>
                     but also causes the calling task to fail.
+                    <note>
+                        <filename>bb.fatal()</filename> raises an exception,
+                        which means you do not need to put a "return"
+                        statement after the function.
+                    </note>
                     </para></listitem>
             </itemizedlist>
         </para>