<?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>14508</bug_id>
          
          <creation_ts>2021-08-13 08:42:54 +0000</creation_ts>
          <short_desc>Add references to classes, tasks and variables</short_desc>
          <delta_ts>2023-01-02 13:35:45 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>9</classification_id>
          <classification>Documentation</classification>
          <product>General Docs</product>
          <component>docs-general</component>
          <version>3.3</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="Michael Opdenacker">michael.opdenacker</reporter>
          <assigned_to name="Michael Opdenacker">michael.opdenacker</assigned_to>
          <cc>foss+yocto</cc>
    
    <cc>michael.opdenacker</cc>
    
    <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>91181</commentid>
    <comment_count>0</comment_count>
    <who name="Michael Opdenacker">michael.opdenacker</who>
    <bug_when>2021-08-13 08:42:54 +0000</bug_when>
    <thetext>There are places in the documentation where we are currently lacking proper references to classes, tasks and variables defined elsewhere in the manuals.

For example:
  s/``do_fetch``/:ref:`ref-tasks-fetch`/
  s/``do_install``/:ref:`ref-tasks-install`/
  ... etc. for all the standard tasks

Without those, some of our scripts have missed some definitions.
Credits to Quentin Schulz for highlighting this need.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>94065</commentid>
    <comment_count>1</comment_count>
    <who name="Michael Opdenacker">michael.opdenacker</who>
    <bug_when>2022-09-23 18:35:33 +0000</bug_when>
    <thetext>I sent a patch series to address at least the missing links to tasks:
https://lore.kernel.org/yocto-docs/20220923175219.6652-1-michael.opdenacker@bootlin.com/T/#t</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>94456</commentid>
    <comment_count>2</comment_count>
    <who name="Michael Opdenacker">michael.opdenacker</who>
    <bug_when>2022-11-28 09:16:11 +0000</bug_when>
    <thetext>And this one:
https://lore.kernel.org/yocto-docs/20221122141217.97681-1-michael.opdenacker@bootlin.com/T/#t</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>94488</commentid>
    <comment_count>3</comment_count>
    <who name="Michael Opdenacker">michael.opdenacker</who>
    <bug_when>2022-12-07 20:42:32 +0000</bug_when>
    <thetext>Sent a 3rd series adding missing references to variables:
https://lists.yoctoproject.org/g/docs/message/3521</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>94606</commentid>
    <comment_count>4</comment_count>
    <who name="Michael Opdenacker">michael.opdenacker</who>
    <bug_when>2023-01-02 13:35:45 +0000</bug_when>
    <thetext>Now fixes thanks to this final commit:
https://git.yoctoproject.org/yocto-docs/commit/?id=7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>