From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Thu, 26 Sep 2013 21:39:02 +0000 (-0700)
Subject: ref-manual: Added the version-going-backwards test to insane
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=28144187dac0bb38d6a34e9b2640fb9f4dce6e10;p=thirdparty%2Fopenembedded%2Fopenembedded-core-contrib.git

ref-manual: Added the version-going-backwards test to insane

Added this new test to the insane.bbclass section.  Also put
in a reference in the migration section back to the new
entry.

(From yocto-docs rev: 32e25547b439030b93d9bc72bdce916eded518b4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---

diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index af7eed38924..83e5db3cd36 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -683,6 +683,9 @@
                     this check performed, you should add
                     "version-going-backwards" to your value for one or the
                     other variables depending on how you wish it to be handled.
+                    See the documented QA checks in the
+                    "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
+                    section. 
                     </para></listitem>
             </itemizedlist>
         </para>
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 83d4c1bf85c..2743059c0ce 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -797,6 +797,21 @@
             <listitem><para><emphasis><filename>perms:</filename></emphasis>
                 Currently, this check is unused but reserved.
                 </para></listitem>
+            <listitem><para><emphasis><filename>version-going-backwards:</filename></emphasis>
+                If Build History is enabled, reports when a package
+                being written out has a lower version than the previously 
+                written package under the same name.
+                If you are placing output packages into a feed and
+                upgrading packages on a target system using that feed, the 
+                version of a package going backwards can result in the target 
+                system not correctly upgrading to the "new" version of the 
+                package. 
+                <note>
+                    If you are not using runtime package management on your 
+                    target system, then you do not need to worry about
+                    this situation.
+                </note>
+                </para></listitem>
         </itemizedlist>
     </para>
 </section>