Bug 1931

Summary: Need better documentation on the IMAGE_INSTALL variable
Product: [Documentation] Reference Reporter: Scott Rifenbark <srifenbark>
Component: handbookAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED DUPLICATE QA Contact:
Severity: enhancement    
Priority: Low CC: poky.doc.watcher, poky.watcher, sgw, song.liu
Version: 1.0   
Target Milestone: 1.2 M4   
Hardware: All   
OS: Multiple   
Whiteboard: Done
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: ---

Description Scott Rifenbark 2012-01-25 11:55:30 UTC
The IMAGE_INSTALL variable is listed curtly in the glossary with the following:

   IMAGE_INSTALL - The list of packages used to build images

We need more information on this variable.  One thing, it sounds as if the user should not be setting it?  If that is the case, we need to declare that.  Also need to provide how the variable is used if it has any ramifications to the user.  If not, why do we even have it defined in the glossary.

The variable is also described in Section 3.2.1 of the reference manual, "Customizing Images Using Custom .bb Files". (http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#usingpoky-extend-customimage-custombb).  This section implies that the user can control the contents of the image.  

The variable also appears in the next section (3.2.2 Customizing Images Using Custom Tasks) - http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#usingpoky-extend-customiage-customtasks. In this section IMAGE_INSTALL is mentioned in the context of needing to add 'task-custom-apps' and/or 'task-custom-tools' to the variable.  Again, this section implies user control over IMAGE_INSTALL.  

In Section 3.2.3 Customizing Images Using Custom IMAGE_FEATURES and EXTRA_IMAGE_FEATURES - http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#usingpoky-extend-customimage-imagefeatures the variable is talked about in the context of it being generated automatically.  

This is not very good documentation on IMAGE_INSTALL.  It could be improved.
I am opening a separate bug on it aimed at the documents.
Comment 1 Scott Rifenbark 2012-02-01 14:54:17 UTC
Updated the description for IMAGE_INSTALL in the YP Reference Manual as well as noted its proper use from the local.conf file.

*** This bug has been marked as a duplicate of bug 1897 ***