Bug 7894 - Properly document distrodata.bbclass
Summary: Properly document distrodata.bbclass
Status: RESOLVED FIXED
Alias: None
Product: Reference
Classification: Documentation
Component: handbook (show other bugs)
Version: unspecified
Hardware: All Multiple
: Medium enhancement
Target Milestone: 2.1 M4
Assignee: Aníbal Limón
QA Contact:
URL:
Whiteboard: 21 March 2016: IN PROGRESS REVIEW
Depends on:
Blocks:
 
Reported: 2015-06-16 08:47 UTC by Paul Eggleton
Modified: 2016-03-24 18:04 UTC (History)
5 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Paul Eggleton 2015-06-16 08:47:05 UTC 
Now that we're reasonably sure that distrodata.bbclass isn't going away, we should document its functionality properly in the reference manual.

Anibal I'm assigning this to you since you've worked on the class the most - if you could help Scott with the background info he should be able to complete the documentation.
Comment 1 Scott Rifenbark 2016-02-03 01:41:40 UTC 
Anibal, 

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

Thanks,
Scott
Comment 2 Aníbal Limón 2016-02-03 17:55:21 UTC 
(In reply to comment #1)
> Anibal, 
> 
> If you could just provide a base description of the class from the user's
> perspective.  I can take that base information and go with it.  We can clean
> it up along the way. 
> 
> Thanks,
> Scott

Yes Scott, i'll give you the description and details by end of week.
Comment 3 Aníbal Limón 2016-02-05 23:49:53 UTC 
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't documented checkpkg and checklicense i need to review the funcionality since i didn't work on it. Let me review it and i'll write here the docs.

Kind regards,
    alimon

[|] http://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html#ref-classes-distrodata
Comment 4 Scott Rifenbark 2016-02-05 23:56:30 UTC 
Thanks.
Comment 6 Scott Rifenbark 2016-03-22 19:09:59 UTC 
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
Comment 7 Aníbal Limón 2016-03-22 20:21:20 UTC 
(In reply to comment #6)
> 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

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't a build that tasks generates a CSV with results.

Best regards,
    alimon