<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://bugzilla.yoctoproject.org/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.6"
          urlbase="https://bugzilla.yoctoproject.org/"
          
          maintainer="it-coreprojects-helpdesk@linuxfoundation.org"
>

    <bug>
          <bug_id>10363</bug_id>
          
          <creation_ts>2016-10-03 22:20:01 +0000</creation_ts>
          <short_desc>Suggested note to clarify that bb.fatal() raises an exception</short_desc>
          <delta_ts>2016-10-04 16:23:39 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>9</classification_id>
          <classification>Documentation</classification>
          <product>Reference</product>
          <component>handbook</component>
          <version>2.2</version>
          <rep_platform>x86</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard>04 Oct 2016: RESOLVED</status_whiteboard>
          <keywords></keywords>
          <priority>Undecided</priority>
          <bug_severity>normal</bug_severity>
          <target_milestone>2.2 M4</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter>ulfalizer</reporter>
          <assigned_to name="Scott Rifenbark">srifenbark</assigned_to>
          <cc>poky.doc.watcher</cc>
    
    <cc>poky.watcher</cc>
    
    <cc>richard.purdie</cc>
          
          
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>Done (doc changes complete)</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>66845</commentid>
    <comment_count>0</comment_count>
    <who name="">ulfalizer</who>
    <bug_when>2016-10-03 22:20:01 +0000</bug_when>
    <thetext>Hello,

It might be unclear that bb.fatal() throws an exception, making people put &apos;return&apos; after it. Adding this note after the bb.fatal() description in &apos;2.3.11. Recipe Logging Mechanisms&apos; could help:

  Note {
  bb.fatal() throws an exception, meaning you do not need to put a &apos;return&apos;
  statement after it.
  }


Exactly which exception it is (BBHandledException) might be an implementation detail, so maybe it should be left out.

Cheers,
Ulf</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>66846</commentid>
    <comment_count>1</comment_count>
    <who name="">ulfalizer</who>
    <bug_when>2016-10-03 22:22:13 +0000</bug_when>
    <thetext>Self-nit: &quot;Raises an exception&quot; is the standard Python terminology.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>66847</commentid>
    <comment_count>2</comment_count>
    <who name="">ulfalizer</who>
    <bug_when>2016-10-03 22:36:28 +0000</bug_when>
    <thetext>Feel free to close right away without review for tiny stuff like this btw, even if you make small edits. I could always reopen it if I see an error. :)

Cheers,
Ulf</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>66856</commentid>
    <comment_count>3</comment_count>
    <who name="Richard Purdie">richard.purdie</who>
    <bug_when>2016-10-04 09:48:23 +0000</bug_when>
    <thetext>I did worry when I saw the title of this bug, I think exactly what happens behind the scenes with bb.fatal is an implementation detail and could well change but I think you&apos;ve made that clear.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>66872</commentid>
    <comment_count>4</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2016-10-04 16:23:39 +0000</bug_when>
    <thetext>Ulf, 

See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#recipe-logging-mechanisms for the new note. 

Setting to RESOLVED and putting the doc flag to &quot;done.&quot;

Scott</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>