Bug 5855

Summary: Document the possible values of the BUILDHISTORY_FEATURES variable
Product: [Documentation] Reference Reporter: Laszlo Papp <lpapp>
Component: handbookAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Medium CC: bluelightning, poky.doc.watcher, poky.watcher, richard.purdie, srifenbark
Version: unspecified   
Target Milestone: 1.6   
Hardware: x86   
OS: Multiple   
Whiteboard: 11 March 2014 - RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Laszlo Papp 2014-02-20 14:00:10 UTC
Based on the underlying source code [1], it seems to be that the potential values can be the following:

* image

* package

* sdk

To be fair, the current documentation gives an example for the image, but it does not mention how to enable e.g. the package feature only, which seems to be what we need in our case unless I misunderstand that feature.

[1] http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/classes/buildhistory.bbclass#n10
Comment 1 Scott Rifenbark 2014-02-20 19:08:26 UTC
Hi, 

I will need some help on this so I am adding Paul to the CC list.  There seems to be quite a few BUILDHISTORY_* variables.  We currently don't document any of them.  I am wondering if we should be?

The "Using Build History to Gather Image Information Only" section is what shows how to use the image value.  Would a separate section showing package and sdk be appropriate?  If so, this is where I would need some information.

Thanks, 
Scott
Comment 2 Laszlo Papp 2014-02-20 19:18:12 UTC
I forgot to be explicit, but I think this variable could be also added to the variable glossary at the bottom, just in case.
Comment 3 Laszlo Papp 2014-02-24 10:10:58 UTC
Hmm, my original post is incorrect in that sense that I apparently need the "image" BUILDHISTORY feature to get package names and versions, etc, rather than the "package" feature.
Comment 4 Paul Eggleton 2014-02-24 10:31:06 UTC
"image" means analysis of the contents of images (including, among other things, the list of installed packages)

"package" means analysis of the contents of individual package

"sdk" means analysis of the contents of SDKs
Comment 5 Scott Rifenbark 2014-02-24 14:02:02 UTC
Laszlo, 

I am going to document the BUILDHISTORY_* variables in the glossary.  That at least should provide some information so people will know what they get when they provide "image", "package", or "sdk".

Paul, 

Thanks for the extra information.

Scott
Comment 7 Laszlo Papp 2014-03-07 19:55:08 UTC
Scott, it looks OK to me.

There is an issue in here: http://www.yoctoproject.org/docs/1.6/ref-manual/ref-manual.html#understanding-what-the-build-history-contains

because it is writing TMPDIR, but it was not introduced by your changes, so it could be fixed separately.

Thank you for your work.
Comment 8 Scott Rifenbark 2014-03-07 20:48:04 UTC
Laszlo, 

Thanks for the quick look at these.  I updated the opening sentence in the section http://wwww.yoctoproject.org/docs/1.6/ref-manual/ref-manual.html#understanding-what-the-build-history-contains so that it says the build history information is kept in $TOPDIR/buildhistory.  

Thanks for your continued efforts with the documentation!

Scott
Comment 9 Scott Rifenbark 2014-03-11 20:14:33 UTC
Hi, 

I think we are good on this one.  I took care of the separate issue that Laszlo pointed out in his last comment.  Marking as RESOLVED and turning the Doc flag to "Done".

Scott