6158 2014-04-14 10:27:43 +0000 Encourage best-practice configuration usage 2026-10-23 08:13:43 +0000 1 1 9 Documentation General Docs docs-general unspecified All Multiple IN PROGRESS DESIGN 20 January 2015: IN PROGRESS DESIGN Medium enhancement 6.2 M4 1 bluelightning antonin.godard belen.barros.pena bluelightning kristi mark.morton michael.opdenacker randy.macleod richard.purdie srifenbark tim.orling --- --- Yes (doc changes required) oldest_to_newest 42639 0 bluelightning 2014-04-14 10:27:43 +0000 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". 43491 1 srifenbark 2014-05-22 08:56:18 +0000 Setting this future. 43977 2 srifenbark 2014-06-16 11:39:38 +0000 See Bug 5601 for related information that needs to be captured. 47151 3 srifenbark 2014-11-21 19:59:40 +0000 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 48455 4 srifenbark 2015-01-30 20:26:19 +0000 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 54470 5 srifenbark 2015-09-22 15:29:12 +0000 Setting to 3.0 days. 77109 6 srifenbark 2017-09-25 15:53:55 +0000 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 77119 7 bluelightning 2017-09-25 19:29:57 +0000 I can't recall if I saw any tests of this earlier, but I think so, yes. 77122 8 srifenbark 2017-09-25 20:27:24 +0000 Ok - if it is still viable then I will try to get some progress on it with you Paul but after 2.4. Thanks 100005 9 randy.macleod 2024-10-24 15:03:58 +0000 Bulk move of 5.1 M4 to 5.2 M2 as approved by AlexB. 102181 10 antonin.godard 2025-06-06 07:42:30 +0000 Bulk move of bugs I am assigned to from Milestone 5.2M4 to 5.3M1.