<?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>11731</bug_id>
          
          <creation_ts>2017-06-28 20:19:55 +0000</creation_ts>
          <short_desc>Docs: poky and meta-intel branch names in quick start guide represent a moving target</short_desc>
          <delta_ts>2017-09-07 20:22:27 +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>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>07 Sept 2017: RESOLVED</status_whiteboard>
          <keywords></keywords>
          <priority>Medium</priority>
          <bug_severity>enhancement</bug_severity>
          <target_milestone>2.4 M4</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Henry Bruce">henry.bruce</reporter>
          <assigned_to name="Saul Wold">sgw</assigned_to>
          <cc>brian.avery</cc>
    
    <cc>kristi</cc>
    
    <cc>srifenbark</cc>
          
          
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>Done (doc changes complete)</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>74607</commentid>
    <comment_count>0</comment_count>
    <who name="Henry Bruce">henry.bruce</who>
    <bug_when>2017-06-28 20:19:55 +0000</bug_when>
    <thetext>For developers new to Yocto Project the Quick Start Guide is often the first place they pick up guidance on how to develop. The guide refers the release branches and developers are usually unaware that these refer to meta-data data this is changing over time. 

Imagine two developers Fred and Tim. Fred does a build on a given date and Tim who pulls and builds the meta-data 2 weeks later will likely have a different built. 

We should explain the Quick Start Guide always points to the best (i.e. bug fixed and CVE applied) meta-data while release tags should be used to keep on a known good build. We should also explain that although release branches have consistent naming across poky, meta-oe, meta-intel (and maybe others?), tags do not.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>74610</commentid>
    <comment_count>1</comment_count>
    <who name="Kristi">kristi</who>
    <bug_when>2017-06-28 21:49:24 +0000</bug_when>
    <thetext>Henry, 

I&apos;m taking this bug, and yes, I see what you mean. I will change those two examples so they&apos;re checking out on a tag to give them a known spot on the branch and alleviating the &quot;moving target&quot; issue. 

Kristi</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>74645</commentid>
    <comment_count>2</comment_count>
    <who name="brian avery">brian.avery</who>
    <bug_when>2017-06-29 15:14:13 +0000</bug_when>
    <thetext>while it may not belong in the quick start guide, I believe the main documentation needs a chapter on branches and tags explaining how both work and what the intent of each is.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>74667</commentid>
    <comment_count>3</comment_count>
    <who name="Kristi">kristi</who>
    <bug_when>2017-06-29 23:10:06 +0000</bug_when>
    <thetext>Henry - I&apos;ve updated the relevant sections to use tag checkouts:

http://www.yoctoproject.org/docs/temp/yocto-project-qs/yocto-project-qs.html#releases

http://www.yoctoproject.org/docs/temp/yocto-project-qs/yocto-project-qs.html#building-an-image-for-hardware

Regarding Comment 2, Scott has addressed that in the following dev-manual sections:

http://www.yoctoproject.org/docs/2.4/dev-manual/dev-manual.html#checking-out-by-branch-in-poky

http://www.yoctoproject.org/docs/2.4/dev-manual/dev-manual.html#checkout-out-by-tag-in-poky

Please look this stuff over, and if there are any issues let me know. 

Thanks
Kristi</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>76656</commentid>
    <comment_count>4</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2017-09-07 20:22:27 +0000</bug_when>
    <thetext>No feedback in over a month.  Presumed correct.  Setting to RESOLVED and putting the doc flag to &quot;done.&quot;

Scott</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>