sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

dev-manual: Read-thru edits to "Working With Packages" 

Mostly minor edits.

(From yocto-docs rev: 4076cf666a3161c5b816bdc56ff0a4edca5ada32)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-03-18 19:42:11 -06:00 committed by Richard Purdie
parent a4103b804d
commit fd2846c5e1
1 changed files with 28 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -4104,18 +4104,23 @@
<para> <para>
This section describes a few tasks that involve packages: This section describes a few tasks that involve packages:
<itemizedlist> <itemizedlist>
<listitem><para>Excluding packages from an image <listitem><para>
<link linkend='excluding-packages-from-an-image'>Excluding packages from an image</link>
</para></listitem> </para></listitem>
<listitem><para>Incrementing a package revision number <listitem><para>
<link linkend='incrementing-a-package-revision-number'>Incrementing a package revision number</link>
</para></listitem> </para></listitem>
<listitem><para>Handling a package name alias <listitem><para>
<link linkend='usingpoky-configuring-DISTRO_PN_ALIAS'>Handling a package name alias</link>
</para></listitem> </para></listitem>
<listitem><para>Handling optional module packaging <listitem><para>
<link linkend='handling-optional-module-packaging'>Handling optional module packaging</link>
</para></listitem> </para></listitem>
<listitem><para>Using Runtime Package Management <listitem><para>
<link linkend='using-runtime-package-management'>Using Runtime Package Management</link>
</para></listitem> </para></listitem>
<listitem><para>Setting up and running package test <listitem><para>
(ptest) <link linkend='testing-packages-with-ptest'>Setting up and running package test (ptest)</link>
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
@ -4203,7 +4208,7 @@
<para> <para>
As mentioned, attempting to maintain revision numbers in the As mentioned, attempting to maintain revision numbers in the
<ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
is error prone, inaccurate and causes problems for people is error prone, inaccurate, and causes problems for people
submitting recipes. submitting recipes.
Conversely, the PR Service automatically generates Conversely, the PR Service automatically generates
increasing numbers, particularly the revision field, increasing numbers, particularly the revision field,
@ -4222,7 +4227,7 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>, <ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>,
<ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, and <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, and
<ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>
for epoch, version and revision, respectively). for epoch, version, and revision, respectively).
The values are highly dependent on the policies and The values are highly dependent on the policies and
procedures of a given distribution and package feed. procedures of a given distribution and package feed.
</para> </para>
@ -4257,7 +4262,7 @@
<filename>r0.2</filename> and so forth. <filename>r0.2</filename> and so forth.
This scheme allows existing <filename>PR</filename> values This scheme allows existing <filename>PR</filename> values
to be used for whatever reasons, which include manual to be used for whatever reasons, which include manual
<filename>PR</filename> bumps should it be necessary. <filename>PR</filename> bumps, should it be necessary.
</para> </para>
<para> <para>
@ -4302,7 +4307,7 @@
</para> </para>
<para> <para>
It is also recommended you use Build History, which adds It is also recommended you use build history, which adds
some sanity checks to package versions, in conjunction with some sanity checks to package versions, in conjunction with
the server that is running the PR Service. the server that is running the PR Service.
To enable build history, add the following to each building To enable build history, add the following to each building
@ -4312,7 +4317,7 @@
INHERIT += "buildhistory" INHERIT += "buildhistory"
BUILDHISTORY_COMMIT = "1" BUILDHISTORY_COMMIT = "1"
</literallayout> </literallayout>
For information on Build History, see the For information on build history, see the
"<ulink url='&YOCTO_DOCS_REF_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>" "<ulink url='&YOCTO_DOCS_REF_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>"
section in the Yocto Project Reference Manual. section in the Yocto Project Reference Manual.
</para> </para>
@ -4454,9 +4459,9 @@
To handle optional module packaging, you need to do two things: To handle optional module packaging, you need to do two things:
<itemizedlist> <itemizedlist>
<listitem><para>Ensure the module packaging is actually <listitem><para>Ensure the module packaging is actually
done</para></listitem> done.</para></listitem>
<listitem><para>Ensure that any dependencies on optional <listitem><para>Ensure that any dependencies on optional
modules from other recipes are satisfied by your recipe modules from other recipes are satisfied by your recipe.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
@ -4494,7 +4499,7 @@
<listitem><para>A directory within the files installed <listitem><para>A directory within the files installed
by your recipe through <filename>do_install</filename> by your recipe through <filename>do_install</filename>
in which to search.</para></listitem> in which to search.</para></listitem>
<listitem><para>A regular expression to match module <listitem><para>A regular expression used to match module
files in that directory. files in that directory.
In the example, note the parentheses () that mark In the example, note the parentheses () that mark
the part of the expression from which the module the part of the expression from which the module
@ -4759,7 +4764,7 @@
<para> <para>
When BitBake generates packages it needs to know When BitBake generates packages it needs to know
what format(s) to use. what format or formats to use.
In your configuration, you use the In your configuration, you use the
<ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>
variable to specify the format. variable to specify the format.
@ -5092,7 +5097,9 @@
</para> </para>
<note> <note>
A recipe is "ptest-enabled" if it inherits ptest. A recipe is "ptest-enabled" if it inherits the
<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-ptest'><filename>ptest</filename></ulink>
class.
</note> </note>
<section id='adding-ptest-to-your-build'> <section id='adding-ptest-to-your-build'>
@ -5140,7 +5147,9 @@
Here is what you have to do for each recipe: Here is what you have to do for each recipe:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>Be sure the recipe <listitem><para><emphasis>Be sure the recipe
inherits ptest:</emphasis> inherits the
<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-ptest'><filename>ptest</filename></ulink>
class:</emphasis>
Include the following line in each recipe: Include the following line in each recipe:
<literallayout class='monospaced'> <literallayout class='monospaced'>
inherit ptest inherit ptest
@ -5216,7 +5225,7 @@
</para></listitem> </para></listitem>
<listitem><para><emphasis>Install the test <listitem><para><emphasis>Install the test
suite:</emphasis> suite:</emphasis>
The <filename>ptest.bbclass</filename> class The <filename>ptest</filename> class
automatically copies the file automatically copies the file
<filename>run-ptest</filename> to the target and <filename>run-ptest</filename> to the target and
then runs make <filename>install-ptest</filename> then runs make <filename>install-ptest</filename>