summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-09-07 13:31:08 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-09-23 15:27:33 +0100
commit8c2172b8be6c5bd6ab46ce9a8e12ea4bc51155d1 (patch)
tree22dfb7494e0bcc64c98680f635ebffa142d2b5a7 /documentation/ref-manual
parent43b5d140c64b2dbfe76c29ec23e8ecad62015bd7 (diff)
downloadpoky-8c2172b8be6c5bd6ab46ce9a8e12ea4bc51155d1.tar.gz
ref-manual: New section on using oe-pkgdata-util
Fixes [YOCTO #10216] Creted a new section titled "Viewing Package Information with oe-pkgdata-util". This section describes how to view information for already build packages through the use of the oi-pkgdata-util command. (From yocto-docs rev: 8d9465f320f973ecaeecb3eae594b29c0d7f4960) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/usingpoky.xml78
1 files changed, 78 insertions, 0 deletions
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index 1b5978e7c9..2719ef1ee0 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -248,6 +248,84 @@
248 </para> 248 </para>
249 </section> 249 </section>
250 250
251 <section id='viewing-package-information-with-oe-pkgdata-util'>
252 <title>Viewing Package Information with <filename>oe-pkgdata-util</filename></title>
253
254 <para>
255 You can use the <filename>oe-pkgdata-util</filename> command-line
256 utility to query
257 <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>
258 and display various package-related information.
259 When you use the utility, you must use it to view information
260 on packages that have already been built.
261 </para>
262
263 <para>
264 Following are a few of the available
265 <filename>oe-pkgdata-util</filename> subcommands.
266 <note>
267 You can use the standard * and ? globbing wildcards as part of
268 package names and paths.
269 </note>
270 <itemizedlist>
271 <listitem><para>
272 <filename>oe-pkgdata-util list-pkgs [</filename><replaceable>pattern</replaceable><filename>]</filename>:
273 Lists all packages that have been built, optionally
274 limiting the match to packages that match
275 <replaceable>pattern</replaceable>.
276 </para></listitem>
277 <listitem><para>
278 <filename>oe-pkgdata-util list-pkg-files&nbsp;</filename><replaceable>package</replaceable><filename>&nbsp;...</filename>:
279 Lists the files and directories contained in the given
280 packages.
281 <note>
282 <para>
283 A different way to view the contents of a package is
284 to look at the
285 <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/packages-split</filename>
286 directory of the recipe that generates the
287 package.
288 This directory is created by the
289 <link linkend='ref-tasks-package'><filename>do_package</filename></link>
290 task and has one subdirectory for each package the
291 recipe generates, which contains the files stored in
292 that package.</para>
293 <para>
294 If you want to inspect the
295 <filename>${WORKDIR}/packages-split directory</filename>,
296 make sure that you are not running with
297 <link linkend='ref-classes-rm-work'><filename>rm_work</filename></link>
298 enabled when building the recipe.</para>
299 </note>
300 </para></listitem>
301 <listitem><para>
302 <filename>oe-pkgdata-util find-path&nbsp;</filename><replaceable>path</replaceable><filename>&nbsp;...</filename>:
303 Lists the names of the packages that contain the given
304 paths.
305 For example, the following might return
306 <filename>make-doc: /usr/share/man/man1/make.1</filename>:
307 <literallayout class='monospaced'>
308 $ oe-pkgdata-util find-path /usr/share/man/man1/make.1
309 </literallayout>
310 </para></listitem>
311 <listitem><para>
312 <filename>oe-pkgdata-util lookup-recipe&nbsp;</filename><replaceable>package</replaceable><filename>&nbsp;...</filename>:
313 Lists the name of the recipe that produces the given
314 packages.
315 </para></listitem>
316 </itemizedlist>
317 </para>
318
319 <para>
320 For more information on the <filename>oe-pkgdata-util</filename>
321 command, use the help facility:
322 <literallayout class='monospaced'>
323 $ oe-pkgdata-util &dash;&dash;help
324 $ oe-pkgdata-util <replaceable>subcommand</replaceable> --help
325 </literallayout>
326 </para>
327 </section>
328
251 <section id='usingpoky-viewing-dependencies-between-recipes-and-tasks'> 329 <section id='usingpoky-viewing-dependencies-between-recipes-and-tasks'>
252 <title>Viewing Dependencies Between Recipes and Tasks</title> 330 <title>Viewing Dependencies Between Recipes and Tasks</title>
253 331