documentation/poky-ref-manual/ref-variables.xml: new PRINC glossary term

Added a first draft of the glossary term PRINC.

(From yocto-docs rev: 418862011e79940ee378f64c6171618d29568014)

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

diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 6959b94d73fcd69b09b7acd20f8cffd1f8a7c763..cbedfd010b80e97ad2ad370fa528234eb98fba65 100644 (file)
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -1587,6 +1587,25 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PRINC'><glossterm>PRINC</glossterm>
+            <glossdef>
+                <para>Causes the <filename>PR</filename> variable to dynamically increment.
+                    This incrementation increases the value of a recipe's revision 
+                    (<filename>PR</filename>) while minimizing the impact of layer ordering.</para>
+                <para>In order to ensure multiple <filename>.bbappend</filename> files can co-exist, 
+                    <filename>PRINC</filename> should be self referencing.
+                    The variable defaults to 0.</para>
+                <para>Following is an example that increments <filename>PR</filename> by two:
+                    <literallayout class='monospaced'>
+     PRINC := "${@int(PRINC) + 2}"
+                    </literallayout>
+                    It is adviseable not to use strings such as ".= '.1'" with the variable because
+                    this usage is very sensitive to layer ordering. 
+                    Explicit assignments should be avoided as they cannot adequately represent multiple 
+                    <filename>.bbappend</filename> files.</para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PV'><glossterm>PV</glossterm>
             <glossdef>
                 <para>The version of the recipe.