| Summary: | Suggested (currently missing) documentation for oe-pkgdata-util | ||
|---|---|---|---|
| Product: | [Documentation] Reference | Reporter: | ulfalizer |
| Component: | handbook | Assignee: | Scott Rifenbark <srifenbark> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | Undecided | CC: | bluelightning, poky.doc.watcher, poky.watcher, srifenbark |
| Version: | 2.2 | ||
| Target Milestone: | 2.2 M4 | ||
| Hardware: | x86 | ||
| OS: | Multiple | ||
| Whiteboard: | 07 Sept 2016: RESOLVED | ||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | Done (doc changes complete) | |
Small nit: "Only packages that have already been built can be queried" could say "only information on packages that have already been built can be queried". Small nit 2: "Lists the names of the packages that contains the given paths" should say "contain", not "contains". 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 Thanks! :)
Just a few nits below:
- The final "directory" in "if you want to inspect the ${WORKDIR}/packages-split
directory" 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
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.
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 Note the "self-nit v2" I added in a separate comment as well. It's meant as a new version of the first nit. :) If you're fine with that change, you could close the bug afterwards too. Thanks, Ulf 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 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 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 |
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 [<pattern>]: Lists all packages that have been built, optionally limiting the match to packages that match <pattern>. * oe-pkgdata-util list-pkg-files <package> ...: 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 <path> ...: Lists the names of the packages that contains the given paths. For example, 'oe-pkgdata-util find-path /usr/share/man/man1/make.1' might return 'make-doc: /usr/share/man/man1/make.1'. * oe-pkgdata-util lookup-recipe <package> ...: Lists the name of the recipe that produces the given packages. See 'oe-pkgdata-util --help' and 'oe-pkgdata-util <subcommand> --help' for more information on oe-pkgdata-util. Cheers, Ulf