<?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>10523</bug_id>
          
          <creation_ts>2016-10-28 12:25:58 +0000</creation_ts>
          <short_desc>api-documentation DISTRO_FEATURE should be enabled and tested on at least one build configuration</short_desc>
          <delta_ts>2016-12-06 17:26:27 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>5</classification_id>
          <classification>Infrastructure</classification>
          <product>AutoBuilder</product>
          <component>autobuilder</component>
          <version>2.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>2.3 M1</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Alexander Kanavin">alex.kanavin</reporter>
          <assigned_to name="Joshua Lock">joshuagloe</assigned_to>
          <cc>infras.ab.watcher</cc>
    
    <cc>Infras.watcher</cc>
    
    <cc>jose.perez.carranza</cc>
    
    <cc>meta.mr.watcher</cc>
    
    <cc>meta.watcher</cc>
    
    <cc>pidge</cc>
    
    <cc>ross.burton</cc>
          
          <qa_contact name="Juan Ramos">juan.fernandox.ramos.frayle</qa_contact>
          <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>67721</commentid>
    <comment_count>0</comment_count>
    <who name="Alexander Kanavin">alex.kanavin</who>
    <bug_when>2016-10-28 12:25:58 +0000</bug_when>
    <thetext>See https://bugzilla.yoctoproject.org/show_bug.cgi?id=8584 for why this needs to be a site configuration change instead of being enabled by default (or enforced) in poky.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>67851</commentid>
    <comment_count>1</comment_count>
    <who name="Paul Eggleton">bluelightning</who>
    <bug_when>2016-11-02 02:37:44 +0000</bug_when>
    <thetext>It sounds like we&apos;ve decided against enabling this for the SDK images we build due to the size increase. If that&apos;s the cae, why do we want to do it by default for our SDKs?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>67857</commentid>
    <comment_count>2</comment_count>
    <who name="Ross Burton">ross.burton</who>
    <bug_when>2016-11-02 12:25:48 +0000</bug_when>
    <thetext>Not doing it for the SDKs because it blows up the AB is one thing - the core-image-lsb-sdk has always been close to the maximum size and for example the piglit upgrade also caused it to get too large for hddimg.

I&apos;d be reasonable happy with a compromise that SDK images and (E)SDK tarballs include doc-pkgs if they are present, so that simply turning on the api-documentation distro feature adds the documentation.  We can not do that for Poky out of the box, but we probably should have at least one run on the AB somewhere to verify regressions.

I do think we need numbers for the size increase - how much does the SDK grow by when documentation is enabled, and are there any simple ways to reduce that size if it is too much.  Compressed manpages, unexpected files in the documentation that can be removed, etc (in this case, a SDK image is likely an easier target to iterate on).</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>67872</commentid>
    <comment_count>3</comment_count>
    <who name="Alexander Kanavin">alex.kanavin</who>
    <bug_when>2016-11-02 16:57:43 +0000</bug_when>
    <thetext>I have the numbers now. The core-image-lsb-sdk image without the docs is 3982025728 bytes, with the docs it&apos;s 4399133696 bytes. After compression, it&apos;s 583615440 and 633771939 bytes respectively. The difference is 417107968 bytes, or 50156499 bytes when compressed.

This doesn&apos;t seem so bad to me, so I&apos;ll make a patch to add the doc-pkgs to SDKs if api-documentation is in DISTRO_FEATURES. As for SDK images, that won&apos;t happen until we slim them down well below 4 gigabytes (which triggers an AB failure because of FAT limitations).</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>68208</commentid>
    <comment_count>4</comment_count>
    <who name="Ross Burton">ross.burton</who>
    <bug_when>2016-11-09 22:37:59 +0000</bug_when>
    <thetext>Alex&apos;s patch landed in oe-core d2b7b3fca328449cd87997be7f897b59433a153d.

The one remaining task is to exercise the documentation build on the AB somehow.  It&apos;s a distro feature that we haven&apos;t (yet) enabled by default in oe-core nodistro or poky due to the build time overhead, but it does need testing.

I guess the options are
1) add a new build set nightly-apidocs that tweaks the distro feature
2) add api-documentation to poky-lsb
3) something else?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>68210</commentid>
    <comment_count>5</comment_count>
    <who name="Ross Burton">ross.burton</who>
    <bug_when>2016-11-10 10:29:32 +0000</bug_when>
    <thetext>Richard suggested:

3) add to nightly-qa-extras

This seems like a good idea to me.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>68438</commentid>
    <comment_count>6</comment_count>
    <who name="Joshua Lock">joshuagloe</who>
    <bug_when>2016-11-18 13:10:09 +0000</bug_when>
    <thetext>Ross submitted a patch to add an api-documentation build to nightly-qa-extras:

https://lists.yoctoproject.org/pipermail/yocto/2016-November/033052.html</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>