<?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>7894</bug_id>
          
          <creation_ts>2015-06-16 08:47:05 +0000</creation_ts>
          <short_desc>Properly document distrodata.bbclass</short_desc>
          <delta_ts>2016-03-24 18:04:36 +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>unspecified</version>
          <rep_platform>All</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard>21 March 2016: IN PROGRESS REVIEW</status_whiteboard>
          <keywords></keywords>
          <priority>Medium</priority>
          <bug_severity>enhancement</bug_severity>
          <target_milestone>2.1 M4</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Paul Eggleton">bluelightning</reporter>
          <assigned_to name="Aníbal Limón">anibal.limon</assigned_to>
          <cc>benjamin.esquivel</cc>
    
    <cc>bluelightning</cc>
    
    <cc>poky.doc.watcher</cc>
    
    <cc>poky.watcher</cc>
    
    <cc>srifenbark</cc>
          
          
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>Yes (doc changes required)</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>51716</commentid>
    <comment_count>0</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2015-06-16 08:47:05 +0000</bug_when>
    <thetext>Now that we&apos;re reasonably sure that distrodata.bbclass isn&apos;t going away, we should document its functionality properly in the reference manual.

Anibal I&apos;m assigning this to you since you&apos;ve worked on the class the most - if you could help Scott with the background info he should be able to complete the documentation.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>58476</commentid>
    <comment_count>1</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2016-02-03 01:41:40 +0000</bug_when>
    <thetext>Anibal, 

If you could just provide a base description of the class from the user&apos;s perspective.  I can take that base information and go with it.  We can clean it up along the way. 

Thanks,
Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>58514</commentid>
    <comment_count>2</comment_count>
    <who name="Aníbal Limón">anibal.limon</who>
    <bug_when>2016-02-03 17:55:21 +0000</bug_when>
    <thetext>(In reply to comment #1)
&gt; Anibal, 
&gt; 
&gt; If you could just provide a base description of the class from the user&apos;s
&gt; perspective.  I can take that base information and go with it.  We can clean
&gt; it up along the way. 
&gt; 
&gt; Thanks,
&gt; Scott

Yes Scott, i&apos;ll give you the description and details by end of week.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>58694</commentid>
    <comment_count>3</comment_count>
    <who name="Aníbal Limón">anibal.limon</who>
    <bug_when>2016-02-05 23:49:53 +0000</bug_when>
    <thetext>Hi Scott,

I reviewed the current documentation [1] and explains well the main functionality of the class so there are two missing tasks that aren&apos;t documented checkpkg and checklicense i need to review the funcionality since i didn&apos;t work on it. Let me review it and i&apos;ll write here the docs.

Kind regards,
    alimon

[|] http://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html#ref-classes-distrodata</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>58696</commentid>
    <comment_count>4</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2016-02-05 23:56:30 +0000</bug_when>
    <thetext>Thanks.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>60116</commentid>
    <comment_count>5</comment_count>
    <who name="Aníbal Limón">anibal.limon</who>
    <bug_when>2016-03-17 20:45:02 +0000</bug_when>
    <thetext>At,

https://lists.yoctoproject.org/pipermail/yocto/2016-March/029157.html</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>60307</commentid>
    <comment_count>6</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2016-03-22 19:09:59 +0000</bug_when>
    <thetext>Anibal, 

I could not simply apply your doc patch.  I had to create a couple new task sections as well as update the distrodata class.  Here are the links.  Please review the information and let me know if these are okay.

Thanks,
Scott

* http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-classes-distrodata

* http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-tasks-distrodata

* http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-tasks-checkpkg</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>60312</commentid>
    <comment_count>7</comment_count>
    <who name="Aníbal Limón">anibal.limon</who>
    <bug_when>2016-03-22 20:21:20 +0000</bug_when>
    <thetext>(In reply to comment #6)
&gt; Anibal, 
&gt; 
&gt; I could not simply apply your doc patch.  I had to create a couple new task
&gt; sections as well as update the distrodata class.  Here are the links. 
&gt; Please review the information and let me know if these are okay.
&gt; 
&gt; Thanks,
&gt; Scott
&gt; 
&gt; *
&gt; http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-classes-
&gt; distrodata
&gt; 
&gt; *
&gt; http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-tasks-
&gt; distrodata
&gt; 
&gt; *
&gt; http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-tasks-
&gt; checkpkg

Hi Scott,

Thanks for your efforts on creating the task sections, the unique comment that i have is about the lines:

To build the distrodata task,
and
To build the checkpkg task,

Will be better to say something like: 

To use the distrodata task,
and 
To use the checkpkg task,

Since isn&apos;t a build that tasks generates a CSV with results.

Best regards,
    alimon</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>60406</commentid>
    <comment_count>8</comment_count>
    <who name="Aníbal Limón">anibal.limon</who>
    <bug_when>2016-03-24 18:04:36 +0000</bug_when>
    <thetext>At,

http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=b44d9e553a84e07e34c2c1a74523473631e8e1d5</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>