Bug 5976

Summary: Autobuilder class docs are non-existent.
Product: [Infrastructure] AutoBuilder Reporter: Beth Flanagan <elizabeth.flanagan>
Component: autobuilderAssignee: California Sullivan <california.l.sullivan>
Status: VERIFIED FIXED QA Contact: Ionut Chisanovici <ionutx.chisanovici>
Severity: enhancement    
Priority: Medium+ CC: alexandru.c.georgescu, bluelightning, elizabeth.flanagan, firemagelynn, infras.ab.watcher, Infras.watcher, jessica.zhang, lynncyrin, madhumithabiw, parimalaprahlada, sgw
Version: unspecified   
Target Milestone: 1.8   
Hardware: x86   
OS: Multiple   
Whiteboard:
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)

Description Beth Flanagan 2014-03-15 04:58:10 UTC
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/
Comment 1 Lynn Cyrin 2014-03-15 10:54:55 UTC
[probably should have made the comment before I reassigned]

I'll work on this!
Comment 2 Beth Flanagan 2014-03-15 18:26:29 UTC
This is a tracking bug. When you decide which classes you're going to modify:

1. Open a bug for them.
2. Put this bug as depending on that.
3. Take that bug.
Comment 3 Parimala 2014-03-26 11:00:53 UTC
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
Comment 4 Beth Flanagan 2014-07-31 23:47:31 UTC
Any update on this, Lynn?
Comment 5 Lynn Cyrin 2014-08-01 03:56:34 UTC
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'm on is really hard to move forward from so I'd rather swap back to this class docs stuff

TLDR; no not really
Comment 6 Beth Flanagan 2014-09-09 19:24:52 UTC
*** Bug 6071 has been marked as a duplicate of this bug. ***
Comment 7 Beth Flanagan 2014-09-30 00:59:56 UTC
https://docs.google.com/document/d/1VeShmhDnqN27HXMX5emgmHFoK8Cu9SzVYilmGjtMTtI

Also committed to master
Comment 8 Ionut Chisanovici 2014-10-08 13:17:53 UTC
Verified.

Cheers,
Ionut C