<?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>10216</bug_id>
          
          <creation_ts>2016-09-03 15:14:05 +0000</creation_ts>
          <short_desc>Suggested (currently missing) documentation for oe-pkgdata-util</short_desc>
          <delta_ts>2016-09-08 00:08:14 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>9</classification_id>
          <classification>Documentation</classification>
          <product>Reference</product>
          <component>handbook</component>
          <version>2.2</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 2016: RESOLVED</status_whiteboard>
          <keywords></keywords>
          <priority>Undecided</priority>
          <bug_severity>normal</bug_severity>
          <target_milestone>2.2 M4</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter>ulfalizer</reporter>
          <assigned_to name="Scott Rifenbark">srifenbark</assigned_to>
          <cc>bluelightning</cc>
    
    <cc>poky.doc.watcher</cc>
    
    <cc>poky.watcher</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>65785</commentid>
    <comment_count>0</comment_count>
    <who name="">ulfalizer</who>
    <bug_when>2016-09-03 15:14:05 +0000</bug_when>
    <thetext>Hello,

oe-pkgdata-util currently seems to be completely undocumented. I suggest adding
the following section:

  2.3.3. Viewing Package Information with oe-pkgdata-util
  
  oe-pkgdata-util is a command-line utility that queries [PKGDATA_DIR] to
  display various package-related information. Only packages that have already
  been built can be queried.
  
  Listed below are a few of the available oe-pkgdata-util subcommands. The
  standard * and ? globbing wildcards can be used in package names and paths.
  
    * oe-pkgdata-util list-pkgs [&lt;pattern&gt;]: Lists all packages that have been
      built, optionally limiting the match to packages that match &lt;pattern&gt;.
  
    * oe-pkgdata-util list-pkg-files &lt;package&gt; ...: Lists the files and
      directories contained in the given packages.
  
      Note {
      A different way to view the contents of a package is to look at the
      ${WORKDIR}/packages-split directory of the recipe that generates the
      package. This directory is created by the [do_package] task and has one
      subdirectory for each package the recipe generates, containing the files
      stored in that package.
      
      If you want to inspect the ${WORKDIR}/packages-split directory, make sure
      that you are not running with
      [rm_work](http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#ref-classes-rm-work)
      enabled when building the recipe.
      }
  
    * oe-pkgdata-util find-path &lt;path&gt; ...: Lists the names of the packages
      that contains the given paths. For example,
      &apos;oe-pkgdata-util find-path /usr/share/man/man1/make.1&apos; might return
      &apos;make-doc: /usr/share/man/man1/make.1&apos;.
  
    * oe-pkgdata-util lookup-recipe &lt;package&gt; ...: Lists the name of the recipe
      that produces the given packages.
  
  See &apos;oe-pkgdata-util --help&apos; and &apos;oe-pkgdata-util &lt;subcommand&gt; --help&apos; for
  more information on oe-pkgdata-util.


Cheers,
Ulf</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>65787</commentid>
    <comment_count>1</comment_count>
    <who name="">ulfalizer</who>
    <bug_when>2016-09-03 16:27:53 +0000</bug_when>
    <thetext>Small nit: &quot;Only packages that have already been built can be queried&quot; could say &quot;only information on packages that have already been built can be queried&quot;.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>65788</commentid>
    <comment_count>2</comment_count>
    <who name="">ulfalizer</who>
    <bug_when>2016-09-03 20:12:03 +0000</bug_when>
    <thetext>Small nit 2: &quot;Lists the names of the packages that contains the given paths&quot; should say &quot;contain&quot;, not &quot;contains&quot;.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>65889</commentid>
    <comment_count>3</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2016-09-07 20:34:51 +0000</bug_when>
    <thetext>Ulf, 

See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#viewing-package-information-with-oe-pkgdata-util for the added section.  Let me know if it is okay.

Regarding nit #2 -- Nice realization... that is a subtle grammar error that nails a lot of people :)

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>65892</commentid>
    <comment_count>4</comment_count>
    <who name="">ulfalizer</who>
    <bug_when>2016-09-07 21:04:56 +0000</bug_when>
    <thetext>Thanks! :)

Just a few nits below:

 - The final &quot;directory&quot; in &quot;if you want to inspect the ${WORKDIR}/packages-split
   directory&quot; seems to accidentally have gotten monospaced.

 - Self-nit: This version of the find-path description might flow a bit better:

     oe-pkgdata-util find-path path ...: Lists the names of the packages that
     contain the given paths. For example, the following tells us that the
     make-doc package contains /usr/share/man/man1/make.1:
    
         $ oe-pkgdata-util find-path /usr/share/man/man1/make.1
         make-doc: /usr/share/man/man1/make.1


 - Self-nit:

     If you want to inspect the ${WORKDIR}/packages-split directory, make sure
     that you are not running with rm_work enabled when building the recipe.

   could be shortened to

     If you want to inspect the ${WORKDIR}/packages-split directory, make sure that
     rm_work is not enabled when you build the recipe.


Cheers,
Ulf</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>65894</commentid>
    <comment_count>5</comment_count>
    <who name="">ulfalizer</who>
    <bug_when>2016-09-07 21:21:39 +0000</bug_when>
    <thetext>Self-nit v2: Reversing the order of the path and the package matches the
command more closely. :P

    For example, the following tells us that /usr/share/man/man1/make.1
    is contained in the make-doc package.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>65895</commentid>
    <comment_count>6</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2016-09-07 21:44:58 +0000</bug_when>
    <thetext>Ulf, 

Good changes.  Thanks.  See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#viewing-package-information-with-oe-pkgdata-util.

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>65896</commentid>
    <comment_count>7</comment_count>
    <who name="">ulfalizer</who>
    <bug_when>2016-09-07 21:49:06 +0000</bug_when>
    <thetext>Note the &quot;self-nit v2&quot; I added in a separate comment as well. It&apos;s meant as a new version of the first nit. :)

If you&apos;re fine with that change, you could close the bug afterwards too.

Thanks,
Ulf</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>65898</commentid>
    <comment_count>8</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2016-09-07 22:19:33 +0000</bug_when>
    <thetext>Completely missed that one... sorry.  It is in at http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#viewing-package-information-with-oe-pkgdata-util

setting to RESOLVED and putting the doc flag to done.

Thanks,
Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>65900</commentid>
    <comment_count>9</comment_count>
    <who name="">ulfalizer</who>
    <bug_when>2016-09-07 23:43:06 +0000</bug_when>
    <thetext>Ops... found one more mistake. The correct description of lookup-recipe is as follows (s/recipe/recipes/, s/produces/produce/):

  oe-pkgdata-util lookup-recipe package ...: Lists the name of the recipes that
  produce the given packages. 


Sorry about that,
Ulf</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>65901</commentid>
    <comment_count>10</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2016-09-08 00:08:14 +0000</bug_when>
    <thetext>Got it - Closing again.

Thanks
Scott

http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#viewing-package-information-with-oe-pkgdata-util</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>