summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-04-29 11:22:24 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-05-13 07:50:57 +0100
commitd1594eacf709cb2964df3bbd9eaa091024ea8102 (patch)
treee34e8742699487457ce03d7fc4392274199bfec0 /documentation
parent95c6c26fba6aa6c4d70b3008bd2ce286f945b84a (diff)
downloadpoky-d1594eacf709cb2964df3bbd9eaa091024ea8102.tar.gz
dev-manual: Added "Properly Versioning Pre-Release Recipes" section.
Fixes [YOCTO #6243] This section addresses situations when working with recipe file names of recipes that have not been released (e.g. recipe-name_1.0.3.rc1). When the recipe is released the system has difficulty recognizing the new recipe name as a later version. So the work-around is to use PV to set the recipe version in the recipe. The section describes this. (From yocto-docs rev: 612379f44e772cfc381e31171ae18af24a9e44fe) 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.xml39
1 files changed, 38 insertions, 1 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 445ca1750b..bead56c978 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1278,7 +1278,7 @@
1278 <literallayout class='monospaced'> 1278 <literallayout class='monospaced'>
1279 cups_1.7.0.bb 1279 cups_1.7.0.bb
1280 gawk_4.0.2.bb 1280 gawk_4.0.2.bb
1281 xdg-utils_1.1.0-rc1.bb 1281 irssi_0.8.16-rc1.bb
1282 </literallayout></para></listitem> 1282 </literallayout></para></listitem>
1283 </itemizedlist> 1283 </itemizedlist>
1284 </section> 1284 </section>
@@ -2147,6 +2147,43 @@
2147 </para> 2147 </para>
2148 </section> 2148 </section>
2149 2149
2150 <section id='properly-versioning-pre-release-recipes'>
2151 <title>Properly Versioning Pre-Release Recipes</title>
2152
2153 <para>
2154 Sometimes the name of a recipe can lead to versioning
2155 problems when the recipe is upgraded to a final release.
2156 For example, consider the
2157 <filename>irssi_0.8.16-rc1.bb</filename> recipe file in
2158 the list of example recipes in the
2159 "<link linkend='new-recipe-storing-and-naming-the-recipe'>Storing and Naming the Recipe</link>"
2160 section.
2161 This recipe is at a release candidate stage (i.e.
2162 "rc1").
2163 When the recipe is released, the recipe filename becomes
2164 <filename>irssi_0.8.16.bb</filename>.
2165 The version change from <filename>0.8.16-rc1</filename>
2166 to <filename>0.8.16</filename> is seen as a decrease by the
2167 build system and package managers, so the resulting packages
2168 will not correctly trigger an upgrade.
2169 </para>
2170
2171 <para>
2172 In order to ensure the versions compare properly, the
2173 recommended convention is to set
2174 <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>
2175 within the recipe to
2176 "&lt;previous version&gt;+&lt;current version&gt;".
2177 You can use an additional variable so that you can use the
2178 current version elsewhere.
2179 Here is an example:
2180 <literallayout class='monospaced'>
2181 REALPV = "0.8.16-rc1"
2182 PV = "0.8.15+${REALPV}"
2183 </literallayout>
2184 </para>
2185 </section>
2186
2150 <section id='new-recipe-post-installation-scripts'> 2187 <section id='new-recipe-post-installation-scripts'>
2151 <title>Post-Installation Scripts</title> 2188 <title>Post-Installation Scripts</title>
2152 2189