Bug 2085 - Document undocumented variables according to bbvars.py
Summary: Document undocumented variables according to bbvars.py
Status: RESOLVED FIXED
Alias: None
Product: Reference
Classification: Documentation
Component: handbook (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Low minor
Target Milestone: Future
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 29 May 2015: RESOLVED
Depends on:
Blocks:
 
Reported: 2012-03-13 16:11 UTC by Darren Hart
Modified: 2015-05-29 19:23 UTC (History)
5 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Darren Hart 2012-03-13 16:11:43 UTC 
Difficulty: Moderate
Estimate: 1 Hour (per variable)
Submitter: dvhart

Start with the variables with the highest count
First add a doctag to meta/conf/documentation.conf
Second prepare a patch to documentation/poky-ref-manual/poky-ref-manual.xml 

$ scripts/contrib/bbvars.py -d documentation/poky-ref-manual/poky-ref-manual.xml -t meta/conf/documentation.conf -m meta
Comment 1 Scott Rifenbark 2012-04-24 22:48:21 UTC 
Accepted.  Needs to be categorized under "Reference Manual" when that category is created.
Comment 2 Scott Rifenbark 2013-09-19 00:45:53 UTC 
I made good progress in adding many variables for the 1.5 release.  But, this obviously has to remain open probably forever.
Comment 3 Scott Rifenbark 2013-10-31 18:11:53 UTC 
I am marking this bug target as "future".  It probably will stay like that for along time.
Comment 4 Scott Rifenbark 2014-06-17 11:11:19 UTC 
Hi, 

This bug remains IN PROGRESS DESIGN for now.  I am updating with a fresh comment to note the state of things.  Since the last entry made to this bug many, many new variables have been added to the ref-manual glossary.  Existing related bugs (Bug 5600 and Bug 5601) now exist also which will tie the documentation.conf file synchronously with the glossary in the ref-manual.

I will continue to simply let this bug ride with a IN PROGRESS DESIGN status as I continually work to add more variables.

Scott
Comment 5 Scott Rifenbark 2015-01-30 20:22:31 UTC 
Hi, 

Just wanted to update this... I have kept this bug in this state forever as I am constently adding new variable descriptions.  Perhaps we can change the state now to RESOLVED?  The Glossary is vastly expanded from when the bug was first compiled.

Thanks, 
Scott
Comment 6 Scott Rifenbark 2015-05-29 19:23:40 UTC 
Hi, 

I am marking this bug RESOLVED.  It has been open for a long time and we have made great progress on variables.  If we want a bug such as this to exist, then someone can open a new one up that takes into account the progress we have made over the three years since it has been open.

Thanks, 
Scott