Bug 5895

Summary: Document the conf-notes.txt file
Product: [Documentation] Reference Reporter: Laszlo Papp <lpapp>
Component: handbookAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: Low CC: bluelightning, jessica.zhang, poky.doc.watcher, poky.watcher, srifenbark
Version: unspecified   
Target Milestone: 1.7 M3   
Hardware: x86   
OS: Multiple   
Whiteboard: 29 July 2014: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Laszlo Papp 2014-02-28 01:33:23 UTC
Currently, this is a hidden gem, and it seems to be almost "mandatory" to override in custom distribution layers with custom images to provide more accurate information about the available image types for building when sourcing the oe environment setup script.

This custom file in the distribution layers will be picked up similarly to the bblayers.conf.sample and local.conf.sample.
Comment 1 Scott Rifenbark 2014-05-19 07:41:54 UTC
Hi, 

I have updated a couple reference sections to address this issue.  Please review them:

http://www.yoctoproject.org/docs/1.7/ref-manual/ref-manual.html#structure-core-script

http://www.yoctoproject.org/docs/1.7/ref-manual/ref-manual.html#structure-memres-core-script

Thanks, 
Scott
Comment 2 Paul Eggleton 2014-05-22 15:50:22 UTC
The new section mentions that you can just edit this file, but that's not really what people should be doing since that's modifying the core. One way to do it is to set TEMPLATECONF (an environment variable, not a bitbake variable) to point to a directory where the custom conf-notes.txt can be found. In a repository this can be set within a .templateconf file - hopefully we document that somewhere as well.
Comment 3 Scott Rifenbark 2014-06-17 06:50:46 UTC
Hi, 

There is a new section now to address the usage part of setting up a template with configurations.  See http://www.yoctoproject.org/docs/1.7/dev-manual/dev-manual.html#creating-a-custom-template-configuration-directory.

I am leaving the bug at IN PROGRESS REVIEW for a while longer.

Scott
Comment 4 Scott Rifenbark 2014-06-19 04:57:37 UTC
Setting milestone to M3.  Still needs reviewed.

Scott
Comment 5 Scott Rifenbark 2014-07-29 06:47:55 UTC
Hi, 

I am setting this bug to RESOLVED and flipping the documentation flag to "Done."  The solution has been under review for over a month with no feedback. 

Thanks, 
Scott
Comment 6 Laszlo Papp 2014-07-29 06:51:29 UTC
Hi Scott,

Apologies for not having had time for Yocto lately. I think your improvement is great, thanks!
Comment 7 Scott Rifenbark 2014-07-29 10:29:10 UTC
No worries Laszlo.  Thanks for confirming the text. 

Scott