<?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>6050</bug_id>
          
          <creation_ts>2014-03-26 16:53:49 +0000</creation_ts>
          <short_desc>All task descriptions in documentation.conf should appear in Toaster</short_desc>
          <delta_ts>2014-04-04 15:35:48 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>7</classification_id>
          <classification>Build System, Metadata &amp; Runtime</classification>
          <product>Toaster</product>
          <component>toaster</component>
          <version>unspecified</version>
          <rep_platform>x86</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>VERIFIED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords></keywords>
          <priority>Medium</priority>
          <bug_severity>normal</bug_severity>
          <target_milestone>1.6 M5</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Belen Barros Pena">belen.barros.pena</reporter>
          <assigned_to name="Paul Eggleton">bluelightning</assigned_to>
          <cc>alexandru.damian</cc>
    
    <cc>belen.barros.pena</cc>
    
    <cc>bluelightning</cc>
    
    <cc>cristiana.voicu</cc>
    
    <cc>richard.purdie</cc>
          
          
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>No (bug/feature does not impact docs)</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>41781</commentid>
    <comment_count>0</comment_count>
    <who name="Belen Barros Pena">belen.barros.pena</who>
    <bug_when>2014-03-26 16:53:49 +0000</bug_when>
    <thetext>Right now, only a small number of the tasks described in documentation.conf are stored in the toaster database and therefore exposed via the help tooltips in the task tables. We need to find a way to expose all the task descriptions available in documentation.conf</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>41883</commentid>
    <comment_count>1</comment_count>
    <who name="David Reyna">david.reyna</who>
    <bug_when>2014-03-28 00:22:35 +0000</bug_when>
    <thetext>The missing &quot;do_*&quot; task descriptions are not in the bitbake environment, as tested by &quot;bitbake -e&quot;.

The proposed solution is to directly append the &quot;[doc]&quot; values for &quot;do_*&quot; names as found in &quot;documentation.conf&quot;. The path to &quot;documentation.conf&quot; file(s) can be found in the &quot;BBINCLUDED&quot; environment variable.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>41888</commentid>
    <comment_count>2</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2014-03-28 09:45:55 +0000</bug_when>
    <thetext>I would rather us figure out why these aren&apos;t coming through, because that is the real bug. In future it&apos;s likely we will move the do_*[doc] definitions in documentation.conf out to the various places where the corresponding functions are defined, which will mean a bypass like this will not work.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>41912</commentid>
    <comment_count>3</comment_count>
    <who name="David Reyna">david.reyna</who>
    <bug_when>2014-03-29 04:48:06 +0000</bug_when>
    <thetext>A few implementation comments:

* The reason that the five or so task descriptions were present in the Variables table and not the others is that (a) they were defined in the bitbake environment, and (b) they also had an assignment.

* The &apos;save_build_variables&apos; method in &apos;buildinfohelper.py&apos; can be adjusted to not skip environment variables with only a description, but while another 20 task descriptions will appear they are not a complete nor sufficient list.

* My solution is to (a) scan &apos;BBINCLUDED&apos; for all &apos;documentation.conf&apos; files, (b) if that file exists then parse all of the task names and descriptions, and (c) add them to the Variable table.

This is sufficient for this release, and can provide backwards compatibility as (some of) these descriptions move to new locations (re: Paul&apos;s comment).

Also in the next release we should consider holding these in a single table not keyed by builds, since they are defined at the bitbake level and not per project.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>41946</commentid>
    <comment_count>4</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2014-03-31 09:09:08 +0000</bug_when>
    <thetext>As I&apos;ve said I don&apos;t want to go down the road of looking for documentation.conf directly. I&apos;d suggest the following:

1) We should probably store these doc varflags in a separate table; that way we can keep the &quot;doc only&quot; variables filtered out of the variable list, and we&apos;re only searching through a short list of values every time we want to get the description of a particular variable/function.

2) If there are still ones missing after doing this, then we need to figure out why that is. Everything in documentation.conf should be able to come through, we shouldn&apos;t need any workarounds.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>41969</commentid>
    <comment_count>5</comment_count>
    <who name="David Reyna">david.reyna</who>
    <bug_when>2014-03-31 16:07:35 +0000</bug_when>
    <thetext>Paul, let me discuss your concerns. 

What is your specific concerned that one bitbake backend component reads the data of another bitbake component? 

The values from &quot;documentation.conf&quot; are simply not in the bitbake environment (which is I think your concern #2). I got from it at most 14 task descriptions, with ZERO overlap with the actual tasks used in my simple test build (bitbake base-files).

We could probably ask for the bitbake env people to be added all of it to the environment, but I suspect that they would much rather have Toaster spend a tiny bit of one-time per project data collection rather that cost every single bitbake execution this unnecessary overhead.

If it is a space and data isolation concern, your suggestion #1 is exactly the same as my closing comment. I did not strongly suggest it because I am not sure Alex wants to make any schema changes at this late date, but if he is OK I am certainly OK. 

I will point out that the overhead is rather miniscule compared to the size of rest of the project&apos;s data, the time to gather the data it almost nothing, and the interface has pretty much zero delay in looking up the values.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>41973</commentid>
    <comment_count>6</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2014-03-31 17:13:42 +0000</bug_when>
    <thetext>My concern is that the whole point of documentation.conf was that values from it would be accessible within BitBake. If that doesn&apos;t work we might as well not have implemented it that way at all.

I&apos;m not expecting the doc varflags to show up with bitbake -e. I am expecting toaster to collect them, but not by looking for the file and reading it. I can look at how the code is working for this tomorrow and advise on the proper solution.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>42214</commentid>
    <comment_count>7</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2014-04-03 10:21:49 +0000</bug_when>
    <thetext>I&apos;ve sent a fix to the bitbake-devel list for this:

http://lists.openembedded.org/pipermail/bitbake-devel/2014-April/004626.html</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>42291</commentid>
    <comment_count>8</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2014-04-04 13:26:44 +0000</bug_when>
    <thetext>Fix merged to master:

http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=432505d5636a0303dfe3db26db15055d98624dc8</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>42303</commentid>
    <comment_count>9</comment_count>
    <who name="Belen Barros Pena">belen.barros.pena</who>
    <bug_when>2014-04-04 15:35:48 +0000</bug_when>
    <thetext>verified in master:21f9cc27d764c2c232d751968bdff8e29947ba7b</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>