Bug 8019

Summary:	Clarification of IMAGE_INSTALL variable
Product:	[Documentation] Reference	Reporter:	Topi Kuutela <topi.kuutela>
Component:	handbook	Assignee:	Scott Rifenbark <srifenbark>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	Medium	CC:	bluelightning, poky.doc.watcher, poky.watcher, ross.burton, srifenbark
Version:	unspecified
Target Milestone:	2.2 M4
Hardware:	All
OS:	Multiple
Whiteboard:
OS type for building Yocto:	---	Type of Regression:	---
Verified:		Documentation change:	Yes (doc changes required)

Description Topi Kuutela 2015-07-16 10:39:29 UTC

The current description of IMAGE_INSTALL is still confusing when it comes to usage in local.conf.

I propose changing the description as follows:
1. Declare IMAGE_INSTALL as inteded to be used only in image recipes.
2. Instead of describing the gotcha of IMAGE_INSTALL in local.conf, add reference to CORE_IMAGE_EXTRA_INSTALL which is already documented as local.conf only variable. 
This could be improved further by adding the CORE_IMAGE_EXTRA_INSTALL to IMAGE_INSTALL in core-image.bbclass instead of ?='ing it.

This change should also be reflected on other parts of the manual in which IMAGE_INSTALL is mentioned.

Related to previous changes and discussion on IMAGE_INSTALL on https://bugzilla.yoctoproject.org/show_bug.cgi?id=1897

Comment 1 Paul Eggleton 2015-07-22 15:00:16 UTC

Unfortunately CORE_IMAGE_EXTRA_INSTALL won't work for all images because it's only handled by core-image.bbclass - it won't do anything for image recipes that only inherit from image.bbclass.

Can you explain what specifically you found confusing regarding setting it from local.conf?

Comment 2 Topi Kuutela 2015-07-23 06:09:09 UTC

The possibility of using +=-syntax in local.conf, which gets overwritten by most (all?) example image recipes with no warning.

Comment 3 Scott Rifenbark 2015-09-22 15:03:10 UTC

There is quite a bit of explanation in the variable's description regarding the dangers of using the "+=" operator with IMAGE_INSTALL.  Do we need more?  I think it is pretty clear.  If not, can you elaborate more?

See http://www.yoctoproject.org/docs/1.9/ref-manual/ref-manual.html#var-IMAGE_INSTALL

Thanks, 
Scott

Comment 4 Scott Rifenbark 2016-01-15 16:04:37 UTC

Hi, 

Any further comments on this?

Thanks,
Scott

Comment 5 Stephen K Jolley 2016-02-16 17:24:18 UTC

I am pulling this out of NEEDINFO, since Topi no longer has a valid e-mail address.

Comment 6 Ross Burton 2016-04-15 13:39:33 UTC

Looks like yocto-docs 834aebb75dce1c905b1e0f142d0d7de6bb44e7d4 fixed this.