<?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>4931</bug_id>
          
          <creation_ts>2013-07-28 07:58:59 +0000</creation_ts>
          <short_desc>More documentation for individual bbclasses</short_desc>
          <delta_ts>2015-09-15 09:25:01 +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>x86</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>VERIFIED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard>11 March 2014 - RESOLVED</status_whiteboard>
          <keywords></keywords>
          <priority>Medium</priority>
          <bug_severity>normal</bug_severity>
          <target_milestone>Future</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Laszlo Papp">lpapp</reporter>
          <assigned_to name="Scott Rifenbark">srifenbark</assigned_to>
          <cc>bluelightning</cc>
    
    <cc>bogdanx.a.voiculescu</cc>
    
    <cc>poky.doc.watcher</cc>
    
    <cc>poky.watcher</cc>
    
    <cc>ross.burton</cc>
    
    <cc>sgw</cc>
    
    <cc>srifenbark</cc>
          
          <qa_contact name="Bogdan Alexandru Voiculescu">bogdanx.a.voiculescu</qa_contact>
          <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>35023</commentid>
    <comment_count>0</comment_count>
    <who name="Laszlo Papp">lpapp</who>
    <bug_when>2013-07-28 07:58:59 +0000</bug_when>
    <thetext>cmake is for instance high-priority as it is a widely used software.

.. but then there are other things, like qmake, et cetera.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35032</commentid>
    <comment_count>1</comment_count>
    <who name="Laszlo Papp">lpapp</who>
    <bug_when>2013-07-28 16:35:47 +0000</bug_when>
    <thetext>find /usr/local/arm-2009q1/ -name rfkill.h -&gt; nothing.

find /usr/local/arm-2013.05/ -name rfkill.h -&gt;
/usr/local/arm-2013.05/arm-none-linux-gnueabi/libc/usr/include/linux/rfkill.h

So, it is not a surprise. This is with busybox 1.21. The older version (1.19) worked just fine from denzil.

It would be nice to work this around in the Yocto project.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35033</commentid>
    <comment_count>2</comment_count>
    <who name="Laszlo Papp">lpapp</who>
    <bug_when>2013-07-28 18:47:47 +0000</bug_when>
    <thetext>Here is the explanation: http://comments.gmane.org/gmane.linux.busybox/30999

http://git.busybox.net/busybox/commit/?h=1_21_stable&amp;id=1cd769a154b04f4b058beed482a5dd7192437cdc</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35034</commentid>
    <comment_count>3</comment_count>
    <who name="Laszlo Papp">lpapp</who>
    <bug_when>2013-07-28 21:13:34 +0000</bug_when>
    <thetext>Oops, disregard my last two comments. They went into the wrong bugreport!</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35043</commentid>
    <comment_count>4</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2013-07-29 05:49:11 +0000</bug_when>
    <thetext>I will need direction on these changes.  Adding Paul and Saul to the bug list.  Please provide me with some information:

* what specific classes do we want to add to this chapter?  The bug&apos;s filing comment indicates cmake, qmake as examples.  Are there others?

* Once we determine which classes to include, base information from which I can work to create additional sections. 

Thanks, 
Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35044</commentid>
    <comment_count>5</comment_count>
    <who name="Laszlo Papp">lpapp</who>
    <bug_when>2013-07-29 05:51:08 +0000</bug_when>
    <thetext>The best would be to document all.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35045</commentid>
    <comment_count>6</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2013-07-29 05:55:24 +0000</bug_when>
    <thetext>Laszlo, 

Can you list those or point me to some spot that lists them?  I don&apos;t know what the list of classes would be.

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35046</commentid>
    <comment_count>7</comment_count>
    <who name="Laszlo Papp">lpapp</who>
    <bug_when>2013-07-29 05:59:44 +0000</bug_when>
    <thetext>You can read the documentation which are documented now, and then you can take a look at the bbclassses for comparison...</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35268</commentid>
    <comment_count>8</comment_count>
    <who name="Ross Burton">ross.burton</who>
    <bug_when>2013-08-01 13:17:25 +0000</bug_when>
    <thetext>The list of classes will have to be curated by a developer as some of the classes are deprecated or internal.  CC&apos;ing me and Paul, whoever gets around to producing a filtered list first wins a cookie.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35270</commentid>
    <comment_count>9</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2013-08-01 13:30:10 +0000</bug_when>
    <thetext>FYI there is a list of missing classes as a comment in the documentation source; I&apos;ve been at least keeping that up-to-date as much as possible in preparation for us having time to properly document them.

For the undocumented classes Scott needs some direction and preferably raw material. Also, there is already bug 1467 open that relates to this.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35621</commentid>
    <comment_count>10</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2013-08-13 12:31:02 +0000</bug_when>
    <thetext>Accepted bug.

I will work with Paul Eggleton to chip away at the list of undocumented classes.  

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>35622</commentid>
    <comment_count>11</comment_count>
    <who name="Laszlo Papp">lpapp</who>
    <bug_when>2013-08-13 12:35:30 +0000</bug_when>
    <thetext>Should I open a separate bugreport for a guide to writing .class files? It is not entirely clear to me how they are written ...</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>36827</commentid>
    <comment_count>12</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2013-09-17 22:03:40 +0000</bug_when>
    <thetext>Hi, 

I am moving this to the the next release (future).  I do not have time to adequately address it for the 1.5 release. 

Thanks, 
Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>38400</commentid>
    <comment_count>13</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2013-10-31 19:48:40 +0000</bug_when>
    <thetext>Here is the current list of undocumented classes as comments in the dev-manual.  What could we reasonably target for 1.6?

&lt;!-- Undocumented classes are:
        allarch.bbclass
        archive*.bbclass
        binconfig.bbclass
        bin_package.bbclass
        blacklist.bbclass
        bootimg.bbclass
        boot-directdisk.bbclass
        bugzilla.bbclass
        buildhistory.bbclass
        buildstats.bbclass
        ccache.bbclass
        chrpath.bbclass
        clutter.bbclass
        cmake.bbclass
        cml1.bbclass
        copyleft_compliance.bbclass
        core-image.bbclass
        cross.bbclass
        cross-canadian.bbclass
        crosssdk.bbclass
        deploy.bbclass
        distrodata.bbclass
        distro_features_check.bbclass
        dummy.bbclass
        extrausers.bbclass
        fontcache.bbclass
        gconf.bbclass
        gettext.bbclass
        gnomebase.bbclass
        gnome.bbclass
        grub-efi.bbclass
        gsettings.bbclass
        gtk-doc.bbclass
        gtk-icon-cache.bbclass
        gtk-immodules-cache.bbclass
        gzipnative.bbclass
        icecc.bbclass
        image-empty.bbclass
        image-live.bbclass
        image-vmdk.bbclass
        image-mklibs.bbclass
        image-prelink.bbclass
        image-swab.bbclass
        image_types.bbclass
        image_types_uboot.bbclass
        insserv.bbclass
        kernel-arch.bbclass
        kernel-module-split.bbclass
        kernel-yocto.bbclass
        lib_package.bbclass
        linux-kernel-base.bbclass
        license.bbclass
        logging.bbclass
        meta.bbclass
        metadata_scm.bbclass
        migrate_localcount.bbclass
        mime.bbclass
        mirrors.bbclass
        multilib*.bbclass
        native.bbclass
        nativesdk.bbclass
        oelint.bbclass
        own-mirrors.bbclass
        packagedata.bbclass
        packageinfo.bbclass
        patch.bbclass
        perlnative.bbclass
        pixbufcache.bbclass
        pkg_distribute.bbclass
        pkg_metainfo.bbclass
        populate_sdk*.bbclass
        prexport.bbclass
        primport.bbclass
        prserv.bbclass
        ptest.bbclass
        python-dir.bbclass
        pythonnative.bbclass
        qemu.bbclass
        qmake*.bbclass
        qt4*.bbclass
        recipe_sanity.bbclass
        relocatable.bbclass
        scons.bbclass
        sdl.bbclass
        setuptools.bbclass
        sip.bbclass
        siteconfig.bbclass
        sourcepkg.bbclass
        spdx.bbclass
        sstate.bbclass
        staging.bbclass
        syslinux.bbclass
        systemd.bbclass
        terminal.bbclass
        tinderclient.bbclass
        toolchain-scripts.bbclass
        typecheck.bbclass
        uboot-config.bbclass
        utility-tasks.bbclass
        utils.bbclass
        vala.bbclass
        waf.bbclass
--&gt;</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>38419</commentid>
    <comment_count>14</comment_count>
    <who name="Laszlo Papp">lpapp</who>
    <bug_when>2013-11-01 11:02:55 +0000</bug_when>
    <thetext>I do not know how much time the paid employees have. There are some important in my opinion, like:

1) cmake
2) qmake
3) systemd
4) sstate
5) gnome
6) patch
7) siteconfig

etc.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>38751</commentid>
    <comment_count>15</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2013-11-13 19:01:58 +0000</bug_when>
    <thetext>I&apos;ve just started a thread with the beginnings of the raw material for this on the yocto mailing list:

https://lists.yoctoproject.org/pipermail/yocto/2013-November/019415.html</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>38752</commentid>
    <comment_count>16</comment_count>
    <who name="Laszlo Papp">lpapp</who>
    <bug_when>2013-11-13 19:04:15 +0000</bug_when>
    <thetext>Thanks for the initiative.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>38886</commentid>
    <comment_count>17</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2013-11-18 18:22:11 +0000</bug_when>
    <thetext>I have the mail from Paul and will begin updating these as I have time.  Changing state to IN PROGRESS DESIGN.

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>39577</commentid>
    <comment_count>18</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2013-12-23 20:35:46 +0000</bug_when>
    <thetext>I have completed the first complete cut on these and have gone through some iterations with Paul Eggleton for review.  I am putting the bug into REVIEW status for general review now.  

You can view the complete *.bbclass reference documentation at http://wwww.yoctoproject.org/docs/1.6/ref-manual/ref-manual.html#ref-classes.

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>41105</commentid>
    <comment_count>19</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2014-03-11 20:11:47 +0000</bug_when>
    <thetext>Hi, 

I am marking this bug as RESOLVED and the doc flag as &quot;Done&quot;.  We have had the classes in for quite some time now with no comments back.  So I think they have settled out now.

Thanks, 
Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>54058</commentid>
    <comment_count>20</comment_count>
    <who name="Bogdan Alexandru Voiculescu">bogdanx.a.voiculescu</who>
    <bug_when>2015-09-15 09:25:01 +0000</bug_when>
    <thetext>Documentation added http://www.yoctoproject.org/docs/1.8/ref-manual/ref-manual.html#ref-classes

still missing: 

image-empty.bbclass
dummy.bbclass
image-empty.bbclass
migrate_localcount.bbclass
pkg_distribute.bbclass
pkg_metainfo.bbclass
recipe_sanity.bbclass
sourcepkg.bbclass


Openning 8298 for remaining classes.</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>