<?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>5976</bug_id>
          
          <creation_ts>2014-03-15 04:58:10 +0000</creation_ts>
          <short_desc>Autobuilder class docs are non-existent.</short_desc>
          <delta_ts>2014-10-08 13:17:53 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>5</classification_id>
          <classification>Infrastructure</classification>
          <product>AutoBuilder</product>
          <component>autobuilder</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>enhancement</bug_severity>
          <target_milestone>1.8</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Beth Flanagan">elizabeth.flanagan</reporter>
          <assigned_to name="California Sullivan">california.l.sullivan</assigned_to>
          <cc>alexandru.c.georgescu</cc>
    
    <cc>bluelightning</cc>
    
    <cc>elizabeth.flanagan</cc>
    
    <cc>firemagelynn</cc>
    
    <cc>infras.ab.watcher</cc>
    
    <cc>Infras.watcher</cc>
    
    <cc>jessica.zhang</cc>
    
    <cc>lynncyrin</cc>
    
    <cc>madhumithabiw</cc>
    
    <cc>parimalaprahlada</cc>
    
    <cc>sgw</cc>
          
          <qa_contact name="Ionut Chisanovici">ionutx.chisanovici</qa_contact>
          <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>41254</commentid>
    <comment_count>0</comment_count>
    <who name="Beth Flanagan">elizabeth.flanagan</who>
    <bug_when>2014-03-15 04:58:10 +0000</bug_when>
    <thetext>We need to do a better job at documenting all the classes in  lib/python2.7/site-packages/autobuilder/.

As of now, we have:

lib/python2.7/site-packages/autobuilder/buildsteps/BuildEclipsePlugin.py     lib/python2.7/site-packages/autobuilder/buildsteps/PrepPkgIndex.py
lib/python2.7/site-packages/autobuilder/buildsteps/BuildImages.py            lib/python2.7/site-packages/autobuilder/buildsteps/PublishArtifacts.py
lib/python2.7/site-packages/autobuilder/buildsteps/BuildToolchainImages.py   lib/python2.7/site-packages/autobuilder/buildsteps/PublishLayerTarballs.py
lib/python2.7/site-packages/autobuilder/buildsteps/CheckOutLayers.py         lib/python2.7/site-packages/autobuilder/buildsteps/ResolveLayerHead.py
lib/python2.7/site-packages/autobuilder/buildsteps/CreateAutoConf.py         lib/python2.7/site-packages/autobuilder/buildsteps/RunBitbakeSelftest.py
lib/python2.7/site-packages/autobuilder/buildsteps/CreateBBLayersConf.py     lib/python2.7/site-packages/autobuilder/buildsteps/RunOeSelftest.py
lib/python2.7/site-packages/autobuilder/buildsteps/CreateCurrentLink.py      lib/python2.7/site-packages/autobuilder/buildsteps/RunPreamble.py
lib/python2.7/site-packages/autobuilder/buildsteps/CreateIntelBSPPackage.py  lib/python2.7/site-packages/autobuilder/buildsteps/RunSanityTests.py
lib/python2.7/site-packages/autobuilder/buildsteps/GetDistroVersion.py       lib/python2.7/site-packages/autobuilder/buildsteps/SetDest.py
lib/python2.7/site-packages/autobuilder/buildsteps/GetLayerVersion.py        lib/python2.7/site-packages/autobuilder/buildsteps/Sleep.py
lib/python2.7/site-packages/autobuilder/buildsteps/HelloWorld.py             lib/python2.7/site-packages/autobuilder/buildsteps/SyncPersistDB.py
lib/python2.7/site-packages/autobuilder/buildsteps/__init__.py               lib/python2.7/site-packages/autobuilder/buildsteps/TestFailStep.py
lib/python2.7/site-packages/autobuilder/buildsteps/MaintainPersistDB.py      lib/python2.7/site-packages/autobuilder/buildsteps/TriggerBuilds.py
lib/python2.7/site-packages/autobuilder/buildsteps/NoOp.py                   lib/python2.7/site-packages/autobuilder/buildsteps/YoctoBlocker.py

None of which appear to be documented. Documentation should follow standard python docstring standards as described in:

http://legacy.python.org/dev/peps/pep-0257/
and
http://legacy.python.org/dev/peps/pep-0008/</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>41257</commentid>
    <comment_count>1</comment_count>
    <who name="Lynn Cyrin">lynncyrin</who>
    <bug_when>2014-03-15 10:54:55 +0000</bug_when>
    <thetext>[probably should have made the comment before I reassigned]

I&apos;ll work on this!</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>41258</commentid>
    <comment_count>2</comment_count>
    <who name="Beth Flanagan">elizabeth.flanagan</who>
    <bug_when>2014-03-15 18:26:29 +0000</bug_when>
    <thetext>This is a tracking bug. When you decide which classes you&apos;re going to modify:

1. Open a bug for them.
2. Put this bug as depending on that.
3. Take that bug.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>41747</commentid>
    <comment_count>3</comment_count>
    <who name="Parimala">parimalaprahlada</who>
    <bug_when>2014-03-26 11:00:53 +0000</bug_when>
    <thetext>I am an OPW applicant.  I am looking at documenting the classes in lib/python2.7/site-packages/autobuilder.  Will be sending the patch soon</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>44906</commentid>
    <comment_count>4</comment_count>
    <who name="Beth Flanagan">elizabeth.flanagan</who>
    <bug_when>2014-07-31 23:47:31 +0000</bug_when>
    <thetext>Any update on this, Lynn?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>44911</commentid>
    <comment_count>5</comment_count>
    <who name="Lynn Cyrin">lynncyrin</who>
    <bug_when>2014-08-01 03:56:34 +0000</bug_when>
    <thetext>I had some class docs stuff sitting on a branch for a very long time while I worked on the README stuff.

But the part of the README stuff that I&apos;m on is really hard to move forward from so I&apos;d rather swap back to this class docs stuff

TLDR; no not really</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>45505</commentid>
    <comment_count>6</comment_count>
    <who name="Beth Flanagan">elizabeth.flanagan</who>
    <bug_when>2014-09-09 19:24:52 +0000</bug_when>
    <thetext>*** Bug 6071 has been marked as a duplicate of this bug. ***</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>45957</commentid>
    <comment_count>7</comment_count>
    <who name="Beth Flanagan">elizabeth.flanagan</who>
    <bug_when>2014-09-30 00:59:56 +0000</bug_when>
    <thetext>https://docs.google.com/document/d/1VeShmhDnqN27HXMX5emgmHFoK8Cu9SzVYilmGjtMTtI

Also committed to master</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>46193</commentid>
    <comment_count>8</comment_count>
    <who name="Ionut Chisanovici">ionutx.chisanovici</who>
    <bug_when>2014-10-08 13:17:53 +0000</bug_when>
    <thetext>Verified.

Cheers,
Ionut C</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>