<?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>14502</bug_id>
          
          <creation_ts>2021-08-06 08:37:02 +0000</creation_ts>
          <short_desc>Check documentation of variables that appear in both bitbake and yocto docs</short_desc>
          <delta_ts>2022-10-04 08:47:10 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>9</classification_id>
          <classification>Documentation</classification>
          <product>Variables Glossary</product>
          <component>variables-glossary</component>
          <version>unspecified</version>
          <rep_platform>x86</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords></keywords>
          <priority>Medium</priority>
          <bug_severity>normal</bug_severity>
          <target_milestone>4.2 M1</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Quentin Schulz">foss+yocto</reporter>
          <assigned_to name="Michael Opdenacker">michael.opdenacker</assigned_to>
          <cc>randy.macleod</cc>
          
          
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>Yes (doc changes required)</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>91130</commentid>
    <comment_count>0</comment_count>
    <who name="Quentin Schulz">foss+yocto</who>
    <bug_when>2021-08-06 08:37:02 +0000</bug_when>
    <thetext>I&apos;ve discovered that BBPATH in yocto-docs is missing an important piece of information: it applies to configuration files too, not only bbclass. This was correctly documented in bitbake documentation but is overridden in yocto-docs.

At least this variable don needs to be fixed but we should check all &quot;duplicates&quot; to see if the overridden documentation makes sense in yocto-docs and that bitbake docs have as at least as much info as yocto-docs&apos;.

For BBPATH, I think we might be able to just remove it from yocto-docs.

On a side note, wondering if we couldn&apos;t integrate links in yocto-docs to terms defined in bitbake documentation. I&apos;ve always found the experience not very user-friendly wrt where variables are documented. E.g. some variables are only documented in bitbake docs, so if I look for it in the variables glossary, I won&apos;t find it. Maybe there&apos;s something we can do here. But that outside of this bug scope :)</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>94047</commentid>
    <comment_count>1</comment_count>
    <who name="Michael Opdenacker">michael.opdenacker</who>
    <bug_when>2022-09-22 08:18:27 +0000</bug_when>
    <thetext>Proposed a fix for BBPATH:
https://lists.yoctoproject.org/g/docs/message/3202

I&apos;m keeping a note about checking other variables, but this would be a too broad scope for this bug, which would remain open forever otherwise.

Same for the last item, for the moment, we can&apos;t automatically add the BitBake terms to the variable index in the Yocto Project manual. I&apos;ll keep this in my notes.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>94048</commentid>
    <comment_count>2</comment_count>
    <who name="Michael Opdenacker">michael.opdenacker</who>
    <bug_when>2022-09-22 08:22:40 +0000</bug_when>
    <thetext>Comment from Quentin Schulz:

What I just thought of right now is to add another custom extension which would traverse the intersphinx mapping for bitbake terms and insert them in the glossary the way you&apos;re doing it above, but just automated.

I have no idea if that is feasible, but I feel like it&apos;d be a better solution than trying to maintain this kind of redirection.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>94100</commentid>
    <comment_count>3</comment_count>
    <who name="Michael Opdenacker">michael.opdenacker</who>
    <bug_when>2022-10-03 13:25:25 +0000</bug_when>
    <thetext>Now fixed in master:
https://git.yoctoproject.org/yocto-docs/commit/?id=5feb4e174e0aec6a48b1131889a5b8547b9b9921</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>