Bug 6158

Summary:	Encourage best-practice configuration usage
Product:	[Documentation] General Docs	Reporter:	Paul Eggleton <bluelightning>
Component:	docs-general	Assignee:	Antonin Godard <antonin.godard>
Status:	IN PROGRESS DESIGN ---	QA Contact:
Severity:	enhancement
Priority:	Medium	CC:	belen.barros.pena, bluelightning, kristi, mark.morton, michael.opdenacker, randy.macleod, richard.purdie, srifenbark, tim.orling
Version:	unspecified
Target Milestone:	6.2 M4
Hardware:	All
OS:	Multiple
Whiteboard:	20 January 2015: IN PROGRESS DESIGN
OS type for building Yocto:	---	Type of Regression:	---
Verified:		Documentation change:	Yes (doc changes required)

Description Paul Eggleton 2014-04-14 10:27:43 UTC

In a lot of places we suggest to add things to local.conf. For quick testing this is fine, but I think that we ought to be encouraging best practice particularly for certain variables by recommending that people set them in their custom distro config (or machine config, depending on the variable).

Some of this is about marking variables in the glossary, but I think it's also about the recommendations we make as part of "how-to" sections where we tell already people where to set variables - most of the time we just say "set this in local.conf".

Comment 1 Scott Rifenbark 2014-05-22 08:56:18 UTC

Setting this future.

Comment 2 Scott Rifenbark 2014-06-16 11:39:38 UTC

See Bug 5601 for related information that needs to be captured.

Comment 3 Scott Rifenbark 2014-11-21 19:59:40 UTC

Hi, 

I have created a form for the variables that uses a small PNG file to visually represent where a user would set a variable.  For now, the PNG image is simply a placeholder.  We need to agree on some short wordings to place in the figure to represent local.conf, machine conf file, user-doesn't set, etc.  

Part of this context information needs to be used for the documentation.conf file as well (see bug 5601 for related information).  Once we get the context areas nailed down, we can include that information between each variable's <info></info> tag, which currently holds just the short description used by documentation.conf.

You can see the work in progress at http://www.yoctoproject.org/docs/1.8/ref-manual/ref-manual.html#ref-variables-glos

Scott

Comment 4 Scott Rifenbark 2015-01-30 20:26:19 UTC

Paul, 

I need to get some feedback from you on the PNG files we want to use here to indicate context for these variables.  Once I have that, I can move forward.

Scott

Comment 5 Scott Rifenbark 2015-09-22 15:29:12 UTC

Setting to 3.0 days.

Comment 6 Scott Rifenbark 2017-09-25 15:53:55 UTC

This bug has lost traction... At one point I had a small little figure worked out to tell the user where to best set a variable.  Is that still a viable solution?  

Scott

Comment 7 Paul Eggleton 2017-09-25 19:29:57 UTC

I can't recall if I saw any tests of this earlier, but I think so, yes.

Comment 8 Scott Rifenbark 2017-09-25 20:27:24 UTC

Ok - if it is still viable then I will try to get some progress on it with you Paul but after 2.4. 

Thanks

Comment 9 Randy MacLeod 2024-10-24 15:03:58 UTC

Bulk move of 5.1 M4 to 5.2 M2 as approved by AlexB.

Comment 10 Antonin Godard 2025-06-06 07:42:30 UTC

Bulk move of bugs I am assigned to from Milestone 5.2M4 to 5.3M1.