Bug 8298 - No documentation for some classes from: meta/classes
Summary: No documentation for some classes from: meta/classes
Status: VERIFIED FIXED
Alias: None
Product: Reference
Classification: Documentation
Component: handbook (show other bugs)
Version: 1.9
Hardware: x86 Multiple
: Medium normal
Target Milestone: 2.0
Assignee: Jose Lamego
QA Contact: Bogdan Alexandru Voiculescu
URL:
Whiteboard: 13 Oct 2015 - IN PROGRESS REVIEW
Depends on:
Blocks:
 
Reported: 2015-09-15 09:13 UTC by Bogdan Alexandru Voiculescu
Modified: 2015-10-22 15:03 UTC (History)
4 users (show)

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


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Bogdan Alexandru Voiculescu 2015-09-15 09:13:56 UTC
populate_sdk_ext class is not documented in http://www.yoctoproject.org/docs/1.8/ref-manual/ref-manual.html#ref-classes
Comment 1 Bogdan Alexandru Voiculescu 2015-09-15 09:24:31 UTC
also missing: 

image-empty.bbclass
dummy.bbclass
image-empty.bbclass
migrate_localcount.bbclass
pkg_distribute.bbclass
pkg_metainfo.bbclass
recipe_sanity.bbclass
sourcepkg.bbclass
Comment 2 Paul Eggleton 2015-09-15 10:03:19 UTC
Are you looking at 1.8/master? dummy.bbclass was removed back in 2012. The following classes in master are also missing from the documentation:

image-buildinfo.bbclass
fs-uuid.bbclass
sign_rpm.bbclass
image-vm.bbclass
kernel-fitimage.bbclass
kernel-uboot.bbclass
kernel-uimage.bbclass
rootfsdebugfiles.bbclass
kernelsrc.bbclass
Comment 3 Bogdan Alexandru Voiculescu 2015-09-15 11:10:27 UTC
I compared the list from here https://bugzilla.yoctoproject.org/show_bug.cgi?id=4931 with the documentation.

Paul, is any way of getting all the bb.classes, so I could have an umbrella bug for all?
Comment 4 Paul Eggleton 2015-09-15 13:08:57 UTC
I was just looking under meta/classes/ - that's where all of the bbclass files can be found.
Comment 5 Bogdan Alexandru Voiculescu 2015-09-15 13:22:22 UTC
so full list would be: 
autotools_stage.bbclass
cpan-base.bbclass
cpan_build.bbclass
distutils3-base.bbclass
distutils3-native-base.bbclass
distutils-base.bbclass
distutils-common-base.bbclass
distutils-native-base.bbclass
distutils-tools.bbclass
fs-uuid.bbclass
image-buildinfo.bbclass
image-vm.bbclass
kernel-fitimage.bbclass
kernel-grub.bbclass
kernelsrc.bbclass
kernel-uboot.bbclass
kernel-uimage.bbclass
libc-common.bbclass
libc-package.bbclass
migrate_localcount.bbclass
multilib.bbclass
multilib_global.bbclass
multilib_header.bbclass
populate_sdk_base.bbclass
populate_sdk_ext.bbclass
python3native.bbclass
qmake2.bbclass
qmake_base.bbclass
qt4e.bbclass
qt4x11.bbclass
recipe_sanity.bbclass
rootfs_deb.bbclass
rootfsdebugfiles.bbclass
rootfs_ipk.bbclass
rootfs_rpm.bbclass
sign_rpm.bbclass
testimage-auto.bbclass
useradd_base.bbclass
Comment 6 Paul Eggleton 2015-09-15 13:43:52 UTC
Some of those are mentioned in the class reference though (e.g. some of the sections use a wildcard).
Comment 7 Bogdan Alexandru Voiculescu 2015-09-16 07:14:42 UTC
I observed some are not covered by those with wildcard: one example is 'populate_sdk_ext'; we should have it all covered. I suggest to let the full list, in order to verify them all when closing the bug and not to be mislead by those with wildcards.
Comment 8 Scott Rifenbark 2015-09-16 15:15:10 UTC
I will need some baseline descriptions of the missing classes from Paul Eggleton.  Once I get those, I will get some descriptions in for review. 

Scott
Comment 9 Scott Rifenbark 2015-10-03 19:29:22 UTC
Hi, 

Here are some links for review based on the text emailed to me for the new class descriptions.  Some of the classes are grouped using "*" characters as part of their name.  There are some issues doing this from the information I had.  Please look them over carefully and see if the groupings are correct and any unique information bundled under a "*" type class is captured:

These first three classes are all autotools* classes (autotools, autotools_stage, and autotools-brokensep).  I was a bit confused on how to treat these three separate classes.  The notes said to make autotools_stage like autotools.  Initially, I was going to create a single class description for "autotools*) that would cover all three.  However, there is different information for the autotools-brokensep class.  So, I separated them into three descriptions.  Note that the autotools and autotools_stage classes appear to be identical.  Let me know what direction to go here.  Here are the links for the three classes:

 * http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-autotools-stage

* http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-autotools

* http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-autotools-brokensep

Here is the link for "cpan*.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-cpan

Here is the link for "distutils-*.bblclass" classes: http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-distutils.  I am not sure about this bundled description.  It supposedly spans several distutils-* classes.  It was hard to figure out exactly the information from the bullets to apply to the group.  

Here is the link for the "distutils3*.bbclass" classes: http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-distutils3.  Same comment here.  This single class grouping covers multiple classes.  Someone needs to look this general group description over and be sure that the technical information is correct.

Here is the link for the "fs-uuid.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-fs-uuid

Here is the link for the "image-buildinfo.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-image-buildinfo

Here is the link for the "image-vm.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-image-vm

Here is the link for the "kernel-fitimage.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-kernel-fitimage

Here is the link for the "kernel-grub.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-kernel-grub

Here is the link for the "kernelsrc.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-kernelsrc

Here is the link for the "kernel-uboot.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-kernel-uboot

Here is the link for the "kernel-uimage.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-kernel-uimage

Here is the link for the "libc*.bbclass" classes: http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-libc*

Here is the link for the "migrate_localcount.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-migrate_localcount

Here is the link to the "populate_sdk_*.bbclass" where we added a new bullet of information: http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-populate-sdk-*

Here is the link to the "python3native.bbclass":  http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-python3native

Here is the link to the "recipe_sanity.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-recipe_sanity

Here is the link to the "sign_rpm.bbclass": http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-sign_rpm

Here is the link to the "testimage*.bbclass" classes: http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-testimage*

Here is the link to the "useradd*.bbclass" classes: http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-useradd.  Some confusion on this one.  There is a "useradd-staticids.bbclass" description.  Does this get bundled user "useradd*.bbclass"?
Comment 10 Jose Lamego 2015-10-09 19:05:11 UTC
Scott, these are my comments. The rest of modifications look good, please let me know if more is needed.

(7.3. autotools.bbclass) Agree, the autotools and autotools_stage are identical so both can be bundled under a * class (autotools*.bbclass). For autotools_brokensep, I suggest to append its reference in the bundle as a final paragraph, without subheading or separator of any kind.

(7.36 distutils-*.bbclass) Rename bundle to distutils*.bbclass, because distutils.bbclass is also covered.
In first paragraph: change "The distutils-*..." to "The distutils*..."
In second bullet: change "...require the distutils-* classes in..." to "...require the distutils.bbclass in..." 
In last paragraph: change "...some of the distutils-* classes..." to "...some of the distutils* classes...". Insert a new line start before "The distutils-tools class..." so every sub-class has it own paragraph within the bundle.

(7.37. distutils3*.bbclass) In first paragraph: change "The distutils3 class..." to "The distutils3* classes..."

(7.128. sign_rpm.bbclass) Remove duplicated "The sign_rpm class"

(7.138. testimage.bbclass) Remove this reference, as it is now bundled in following testimage*.bbclass

(7.139. testimage*.bbclass) In last paragraph: change "Tests run automatically on..." to "The testimage-auto.bbclass runs tests on...". Insert a new line start before "For information on how to enable..."

(7.149. useradd*.bbclass) Append the reference for useradd-staticids.bbclass to this bundle. In appended Notes section: change "You do not use this class..." to "You do not use the useradd-staticids class..."

(7.150 useradd-staticids.bbclass) Remove this reference after appending it to useradd*.bbclass.
Comment 11 Scott Rifenbark 2015-10-13 16:58:50 UTC
(In reply to comment #10)

Jose, 

I have applied all this feedback.  Below are the links so you can verify.

Thanks,
Scott


> Scott, these are my comments. The rest of modifications look good, please
> let me know if more is needed.
> 
> (7.3. autotools.bbclass) Agree, the autotools and autotools_stage are
> identical so both can be bundled under a * class (autotools*.bbclass). For
> autotools_brokensep, I suggest to append its reference in the bundle as a
> final paragraph, without subheading or separator of any kind.

Jose - Please look at http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-autotools and let me know if this is ok.

> 
> (7.36 distutils-*.bbclass) Rename bundle to distutils*.bbclass, because
> distutils.bbclass is also covered.
> In first paragraph: change "The distutils-*..." to "The distutils*..."
> In second bullet: change "...require the distutils-* classes in..." to
> "...require the distutils.bbclass in..." 
> In last paragraph: change "...some of the distutils-* classes..." to
> "...some of the distutils* classes...". Insert a new line start before "The
> distutils-tools class..." so every sub-class has it own paragraph within the
> bundle.

See http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-distutils

> 
> (7.37. distutils3*.bbclass) In first paragraph: change "The distutils3
> class..." to "The distutils3* classes..."

See http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-distutils3

> 
> (7.128. sign_rpm.bbclass) Remove duplicated "The sign_rpm class"

Fixed - http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-sign_rpm

> 
> (7.138. testimage.bbclass) Remove this reference, as it is now bundled in
> following testimage*.bbclass

This is no longer there and all cross-references in the YP set have been adjusted.

> 
> (7.139. testimage*.bbclass) In last paragraph: change "Tests run
> automatically on..." to "The testimage-auto.bbclass runs tests on...".
> Insert a new line start before "For information on how to enable..."

See http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-testimage*

> 
> (7.149. useradd*.bbclass) Append the reference for useradd-staticids.bbclass
> to this bundle. In appended Notes section: change "You do not use this
> class..." to "You do not use the useradd-staticids class..."

See http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-useradd

> 
> (7.150 useradd-staticids.bbclass) Remove this reference after appending it
> to useradd*.bbclass.

This has been removed and merged into useradd*.bbclass as directed.  Cross-references throughout the YP manual set adjusted.
Comment 12 Jose Lamego 2015-10-13 20:15:03 UTC
(in reply to Comment #11)

Scott, all changes look good. Please let me know if we are waiting for additional feedback.

Thanks
Comment 13 Scott Rifenbark 2015-10-14 15:28:03 UTC
Hi Jose, 

I still have it in IN PROGRESS REVIEW. I don't particularly need more feedback to close it if you have approved all the changes.  Just give me the word and I will set to RESOLVED/FIXED and reset the doc flag to "Done."

Scott
Comment 14 Jose Lamego 2015-10-14 15:42:09 UTC
All ok by me. Thanks Scott!

Jose
Comment 15 Scott Rifenbark 2015-10-14 15:53:01 UTC
Cool - thanks for changing status.  I flipped the doc flag to "Done."

Scott
Comment 16 Bogdan Alexandru Voiculescu 2015-10-22 13:52:36 UTC
Verified on http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes; just rootfsdebugfiles still missing: should I fill a separate bug?
Comment 17 Jose Lamego 2015-10-22 14:02:12 UTC
(in reply to comment #16)

Thank you Bogdan, I missed that one.

Scott: please append the following bullet in "7.120. rootfs*.bbclass":

- The rootfsdebugfiles class, which installs additional files found on the build host directly into the rootfs.

Let me know if more is needed.
Jose
Comment 18 Scott Rifenbark 2015-10-22 14:36:42 UTC
Hi, 

No need to create a new bug.  I added this in to the manual.  See http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-rootfs*.

Thanks, 
Scott
Comment 19 Bogdan Alexandru Voiculescu 2015-10-22 15:00:04 UTC
Thank you Jose and Scott! This was very fast :)
Comment 20 Scott Rifenbark 2015-10-22 15:03:50 UTC
(In reply to comment #19)
> Thank you Jose and Scott! This was very fast :)

Simple fix... thanks