Bug 8941 - Unclear information about auto.conf
Summary: Unclear information about auto.conf
Status: VERIFIED FIXED
Alias: None
Product: Mega Manual
Classification: Documentation
Component: mega-manual (show other bugs)
Version: 2.1
Hardware: x86 Multiple
: Medium normal
Target Milestone: 2.1 M4
Assignee: Scott Rifenbark
QA Contact: Bogdan Alexandru Voiculescu
URL:
Whiteboard: 01 April 2016: RESLOVED
Depends on:
Blocks:
 
Reported: 2016-01-18 13:45 UTC by Bogdan Alexandru Voiculescu
Modified: 2016-04-14 14:29 UTC (History)
2 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: New (Never tested)
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 2016-01-18 13:45:43 UTC
When trying to understand how to use auto.conf I found some misleading steps in mega-manual: 
"The files site.conf and auto.conf are not created by the environment initialization script. If you want these configuration files, you must create them yourself: "
So I must create auto.conf manually!
Still one paragraph bellow is specified we do not create this file by our hands: 
"
auto.conf: This file is not hand-created. Rather, the file is usually created and written to by an autobuilder. The settings put into the file are typically the same as you would find in the conf/local.conf or the conf/site.conf files. "

Please clarify this in manual.

Paul, could you please help?
Comment 1 Scott Rifenbark 2016-01-18 17:43:45 UTC
Hi, 

Yes - that is confusing.  I updated the wording to what I think is really going on.  Paul should check it over.  Here is the section in the ref-manual: http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#user-configuration.

Let me know.

Thanks, 
Scott
Comment 2 Scott Rifenbark 2016-02-09 22:45:55 UTC
let this run for another month then will set to RESOLVED if no further feedback.

Scott
Comment 3 Bogdan Alexandru Voiculescu 2016-02-10 08:02:50 UTC
I am ok with the modifications.
Should we assign it to Paul?
Comment 4 Scott Rifenbark 2016-02-10 18:50:56 UTC
Thanks Bogdan, 

Paul is on the CC list for this bug.  I will wait a while to see if he has anything to say about the fix.

Scott
Comment 5 Paul Eggleton 2016-02-10 20:33:28 UTC
I'm fairly happy with the new content. The note box does duplicate the later statement about auto.conf / site.conf containing the same sorts of settings as local.conf though, but that's not a major issue.

The only thing possibly worth adding is a mention of the order in which these files are read - which is site.conf, auto.conf and then local.conf. The normal rules about the different types of assignment statement apply, but for example 
if you have VARIABLE = "value1" in auto.conf and VARIABLE = "value2" in local.conf, VARIABLE's value will be "value2" since local.conf gets parsed later.
Comment 6 Scott Rifenbark 2016-02-15 16:22:15 UTC
See the last paragraph in http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#user-configuration and let me know if that addresses this extra point.

Scott
Comment 7 Scott Rifenbark 2016-04-01 18:18:25 UTC
Hi, 

No further comments on this.  I am setting to RESOLVED and marking the doc flag to "done."

Thanks, 
Scott
Comment 8 Bogdan Alexandru Voiculescu 2016-04-14 14:29:24 UTC
This is resolved now.