<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://bugzilla.yoctoproject.org/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.6"
          urlbase="https://bugzilla.yoctoproject.org/"
          
          maintainer="it-coreprojects-helpdesk@linuxfoundation.org"
>

    <bug>
          <bug_id>5601</bug_id>
          
          <creation_ts>2013-11-25 18:41:16 +0000</creation_ts>
          <short_desc>Merging the Glossary and the Variable Context sections</short_desc>
          <delta_ts>2017-09-25 20:26:02 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>9</classification_id>
          <classification>Documentation</classification>
          <product>Mega Manual</product>
          <component>mega-manual</component>
          <version>unspecified</version>
          <rep_platform>x86</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>WONTFIX</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard>20 January 2015: IN PROGRESS REVIEW</status_whiteboard>
          <keywords></keywords>
          <priority>Medium</priority>
          <bug_severity>enhancement</bug_severity>
          <target_milestone>Future</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Belen Barros Pena">belen.barros.pena</reporter>
          <assigned_to name="Scott Rifenbark">srifenbark</assigned_to>
          <cc>belen.barros.pena</cc>
    
    <cc>bluelightning</cc>
    
    <cc>kristi</cc>
    
    <cc>richard.purdie</cc>
    
    <cc>srifenbark</cc>
          
          
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>No (bug/feature does not impact docs)</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>39082</commentid>
    <comment_count>0</comment_count>
    <who name="Belen Barros Pena">belen.barros.pena</who>
    <bug_when>2013-11-25 18:41:16 +0000</bug_when>
    <thetext>In order to provide variable context information within Toaster via documentation.conf, the Reference Manual should add context information to each variable, instead of providing context information in a separate section.

The context information should be synced with documentation.conf, together with the short description (see bug 5600)</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>42066</commentid>
    <comment_count>1</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2014-04-01 21:57:23 +0000</bug_when>
    <thetext>Enhancement moving to 1.7.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>43489</commentid>
    <comment_count>2</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2014-05-22 08:46:57 +0000</bug_when>
    <thetext>Changing to future.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>43976</commentid>
    <comment_count>3</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2014-06-16 11:38:26 +0000</bug_when>
    <thetext>I am adding some design notes for when this bug is worked on (post 1.7).

The solution for this bug is tied in with Bug 6158, which is related.  Part of the description for each variable will provide this context information along with the best place for a user to set that configuration up (e.g. local.conf, distro, etc.).

For the YP manual side:

 * I need to isolate variable context information for each variable.
   The information will be appropriate for the documentation.conf file.
 
 * The context information should appear as part of the normal variable
   description.
   
 * The context information needs to be wrapped in a DocBook ID string such 
   that an outside script can easily find the string by processing the 
   ref-variables.xml file.

For the Script side (engineering)

 * Need to create a script that will process the ref-variables.xml file
   and extract the context information for each variable.  The information
   will be used in the documentation.conf file so that it does not
   have to be hand-edited.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>48457</commentid>
    <comment_count>4</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2015-01-30 21:10:36 +0000</bug_when>
    <thetext>I have moved this bug to IN PROGRESS REVIEW.  See bug 5600 for complete details.

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>49931</commentid>
    <comment_count>5</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2015-03-30 22:02:38 +0000</bug_when>
    <thetext>Not sure where we stand on this either.  The descriptions are in the variable entries.  I think I am going to back out the PNG files that would have been used for context.  I don&apos;t think we have time for this.

scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>49963</commentid>
    <comment_count>6</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2015-03-31 12:59:57 +0000</bug_when>
    <thetext>I think we&apos;ll have to leave this for 1.9 unfortunately.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>54469</commentid>
    <comment_count>7</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2015-09-22 15:28:12 +0000</bug_when>
    <thetext>Setting the perfect days to 3.0 for this.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>77108</commentid>
    <comment_count>8</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2017-09-25 15:51:37 +0000</bug_when>
    <thetext>Closely tied with Bug 5600, which has been inactive for quite some time.  Can we call this done?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>77118</commentid>
    <comment_count>9</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2017-09-25 19:28:48 +0000</bug_when>
    <thetext>I think we can probably say it&apos;s unlikely we&apos;ll get to the corresponding functionality in Toaster, so we can close this for now.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>77121</commentid>
    <comment_count>10</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2017-09-25 20:26:02 +0000</bug_when>
    <thetext>Perfect -- I set the doc flag to &quot;No&quot; in this case. 

Thanks</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>