diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-03-18 19:42:11 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-03-25 12:29:42 +0000 |
commit | fd2846c5e115ce1d2a24b6776bc7808fe92bfad3 (patch) | |
tree | 9d868daff57e1b2b97ece0d29ae11545d12648e8 /documentation | |
parent | a4103b804dd4fa8c8bf3f2988dda30d01c6bd3a6 (diff) | |
download | poky-fd2846c5e115ce1d2a24b6776bc7808fe92bfad3.tar.gz |
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>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 47 |
1 files changed, 28 insertions, 19 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index abecc74547..834e0a4040 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -4104,18 +4104,23 @@ | |||
4104 | <para> | 4104 | <para> |
4105 | This section describes a few tasks that involve packages: | 4105 | This section describes a few tasks that involve packages: |
4106 | <itemizedlist> | 4106 | <itemizedlist> |
4107 | <listitem><para>Excluding packages from an image | 4107 | <listitem><para> |
4108 | <link linkend='excluding-packages-from-an-image'>Excluding packages from an image</link> | ||
4108 | </para></listitem> | 4109 | </para></listitem> |
4109 | <listitem><para>Incrementing a package revision number | 4110 | <listitem><para> |
4111 | <link linkend='incrementing-a-package-revision-number'>Incrementing a package revision number</link> | ||
4110 | </para></listitem> | 4112 | </para></listitem> |
4111 | <listitem><para>Handling a package name alias | 4113 | <listitem><para> |
4114 | <link linkend='usingpoky-configuring-DISTRO_PN_ALIAS'>Handling a package name alias</link> | ||
4112 | </para></listitem> | 4115 | </para></listitem> |
4113 | <listitem><para>Handling optional module packaging | 4116 | <listitem><para> |
4117 | <link linkend='handling-optional-module-packaging'>Handling optional module packaging</link> | ||
4114 | </para></listitem> | 4118 | </para></listitem> |
4115 | <listitem><para>Using Runtime Package Management | 4119 | <listitem><para> |
4120 | <link linkend='using-runtime-package-management'>Using Runtime Package Management</link> | ||
4116 | </para></listitem> | 4121 | </para></listitem> |
4117 | <listitem><para>Setting up and running package test | 4122 | <listitem><para> |
4118 | (ptest) | 4123 | <link linkend='testing-packages-with-ptest'>Setting up and running package test (ptest)</link> |
4119 | </para></listitem> | 4124 | </para></listitem> |
4120 | </itemizedlist> | 4125 | </itemizedlist> |
4121 | </para> | 4126 | </para> |
@@ -4203,7 +4208,7 @@ | |||
4203 | <para> | 4208 | <para> |
4204 | As mentioned, attempting to maintain revision numbers in the | 4209 | As mentioned, attempting to maintain revision numbers in the |
4205 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> | 4210 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> |
4206 | is error prone, inaccurate and causes problems for people | 4211 | is error prone, inaccurate, and causes problems for people |
4207 | submitting recipes. | 4212 | submitting recipes. |
4208 | Conversely, the PR Service automatically generates | 4213 | Conversely, the PR Service automatically generates |
4209 | increasing numbers, particularly the revision field, | 4214 | increasing numbers, particularly the revision field, |
@@ -4222,7 +4227,7 @@ | |||
4222 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>, | 4227 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>, |
4223 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, and | 4228 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, and |
4224 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink> | 4229 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink> |
4225 | for epoch, version and revision, respectively). | 4230 | for epoch, version, and revision, respectively). |
4226 | The values are highly dependent on the policies and | 4231 | The values are highly dependent on the policies and |
4227 | procedures of a given distribution and package feed. | 4232 | procedures of a given distribution and package feed. |
4228 | </para> | 4233 | </para> |
@@ -4257,7 +4262,7 @@ | |||
4257 | <filename>r0.2</filename> and so forth. | 4262 | <filename>r0.2</filename> and so forth. |
4258 | This scheme allows existing <filename>PR</filename> values | 4263 | This scheme allows existing <filename>PR</filename> values |
4259 | to be used for whatever reasons, which include manual | 4264 | to be used for whatever reasons, which include manual |
4260 | <filename>PR</filename> bumps should it be necessary. | 4265 | <filename>PR</filename> bumps, should it be necessary. |
4261 | </para> | 4266 | </para> |
4262 | 4267 | ||
4263 | <para> | 4268 | <para> |
@@ -4302,7 +4307,7 @@ | |||
4302 | </para> | 4307 | </para> |
4303 | 4308 | ||
4304 | <para> | 4309 | <para> |
4305 | It is also recommended you use Build History, which adds | 4310 | It is also recommended you use build history, which adds |
4306 | some sanity checks to package versions, in conjunction with | 4311 | some sanity checks to package versions, in conjunction with |
4307 | the server that is running the PR Service. | 4312 | the server that is running the PR Service. |
4308 | To enable build history, add the following to each building | 4313 | To enable build history, add the following to each building |
@@ -4312,7 +4317,7 @@ | |||
4312 | INHERIT += "buildhistory" | 4317 | INHERIT += "buildhistory" |
4313 | BUILDHISTORY_COMMIT = "1" | 4318 | BUILDHISTORY_COMMIT = "1" |
4314 | </literallayout> | 4319 | </literallayout> |
4315 | For information on Build History, see the | 4320 | For information on build history, see the |
4316 | "<ulink url='&YOCTO_DOCS_REF_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>" | 4321 | "<ulink url='&YOCTO_DOCS_REF_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>" |
4317 | section in the Yocto Project Reference Manual. | 4322 | section in the Yocto Project Reference Manual. |
4318 | </para> | 4323 | </para> |
@@ -4454,9 +4459,9 @@ | |||
4454 | To handle optional module packaging, you need to do two things: | 4459 | To handle optional module packaging, you need to do two things: |
4455 | <itemizedlist> | 4460 | <itemizedlist> |
4456 | <listitem><para>Ensure the module packaging is actually | 4461 | <listitem><para>Ensure the module packaging is actually |
4457 | done</para></listitem> | 4462 | done.</para></listitem> |
4458 | <listitem><para>Ensure that any dependencies on optional | 4463 | <listitem><para>Ensure that any dependencies on optional |
4459 | modules from other recipes are satisfied by your recipe | 4464 | modules from other recipes are satisfied by your recipe. |
4460 | </para></listitem> | 4465 | </para></listitem> |
4461 | </itemizedlist> | 4466 | </itemizedlist> |
4462 | </para> | 4467 | </para> |
@@ -4494,7 +4499,7 @@ | |||
4494 | <listitem><para>A directory within the files installed | 4499 | <listitem><para>A directory within the files installed |
4495 | by your recipe through <filename>do_install</filename> | 4500 | by your recipe through <filename>do_install</filename> |
4496 | in which to search.</para></listitem> | 4501 | in which to search.</para></listitem> |
4497 | <listitem><para>A regular expression to match module | 4502 | <listitem><para>A regular expression used to match module |
4498 | files in that directory. | 4503 | files in that directory. |
4499 | In the example, note the parentheses () that mark | 4504 | In the example, note the parentheses () that mark |
4500 | the part of the expression from which the module | 4505 | the part of the expression from which the module |
@@ -4759,7 +4764,7 @@ | |||
4759 | 4764 | ||
4760 | <para> | 4765 | <para> |
4761 | When BitBake generates packages it needs to know | 4766 | When BitBake generates packages it needs to know |
4762 | what format(s) to use. | 4767 | what format or formats to use. |
4763 | In your configuration, you use the | 4768 | In your configuration, you use the |
4764 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink> | 4769 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink> |
4765 | variable to specify the format. | 4770 | variable to specify the format. |
@@ -5092,7 +5097,9 @@ | |||
5092 | </para> | 5097 | </para> |
5093 | 5098 | ||
5094 | <note> | 5099 | <note> |
5095 | A recipe is "ptest-enabled" if it inherits ptest. | 5100 | A recipe is "ptest-enabled" if it inherits the |
5101 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-ptest'><filename>ptest</filename></ulink> | ||
5102 | class. | ||
5096 | </note> | 5103 | </note> |
5097 | 5104 | ||
5098 | <section id='adding-ptest-to-your-build'> | 5105 | <section id='adding-ptest-to-your-build'> |
@@ -5140,7 +5147,9 @@ | |||
5140 | Here is what you have to do for each recipe: | 5147 | Here is what you have to do for each recipe: |
5141 | <itemizedlist> | 5148 | <itemizedlist> |
5142 | <listitem><para><emphasis>Be sure the recipe | 5149 | <listitem><para><emphasis>Be sure the recipe |
5143 | inherits ptest:</emphasis> | 5150 | inherits the |
5151 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-ptest'><filename>ptest</filename></ulink> | ||
5152 | class:</emphasis> | ||
5144 | Include the following line in each recipe: | 5153 | Include the following line in each recipe: |
5145 | <literallayout class='monospaced'> | 5154 | <literallayout class='monospaced'> |
5146 | inherit ptest | 5155 | inherit ptest |
@@ -5216,7 +5225,7 @@ | |||
5216 | </para></listitem> | 5225 | </para></listitem> |
5217 | <listitem><para><emphasis>Install the test | 5226 | <listitem><para><emphasis>Install the test |
5218 | suite:</emphasis> | 5227 | suite:</emphasis> |
5219 | The <filename>ptest.bbclass</filename> class | 5228 | The <filename>ptest</filename> class |
5220 | automatically copies the file | 5229 | automatically copies the file |
5221 | <filename>run-ptest</filename> to the target and | 5230 | <filename>run-ptest</filename> to the target and |
5222 | then runs make <filename>install-ptest</filename> | 5231 | then runs make <filename>install-ptest</filename> |