[oe-commits] org.oe.documentation recipes: Update the note about the PR variable making it clear that it never

[lenehan commit]

recipes: Update the note about the PR variable making it clear that it never
goes backwards and that you should always increase it if you are unsure
about what effect it has on the generated packages.

Author: lenehan at openembedded.org
Branch: org.openembedded.documentation
Revision: 3ed18fe46dc80add9e525d70a8f88431bf941b23
ViewMTN: http://monotone.openembedded.org/revision.psp?id=3ed18fe46dc80add9e525d70a8f88431bf941b23
Files:
1
usermanual/chapters/recipes.xml
Diffs:

#
# mt diff -rb4a59a6f1011fd6c4e1bbebb7c47458018dc8c05 -r3ed18fe46dc80add9e525d70a8f88431bf941b23
#
# 
# 
# patch "usermanual/chapters/recipes.xml"
#  from [1e2d6b8fea9fef5b5faa37cac3fa5d0c425792fe]
#    to [5ac4539e5ace00872d8247b467ba5424b3a2b954]
# 
============================================================
--- usermanual/chapters/recipes.xml	1e2d6b8fea9fef5b5faa37cac3fa5d0c425792fe
+++ usermanual/chapters/recipes.xml	5ac4539e5ace00872d8247b467ba5424b3a2b954
@@ -335,6 +335,17 @@ mv fixed.recipe.bb myrecipe.bb</screen><
         <para>It is good practice to always define PR in your recipes, even
         for the <emphasis>"r0"</emphasis> release, so that when editing the
         recipe it is clear that the PR number needs to be updated.</para>
+
+        <para>You should always increment PR when modifying a recipe.
+        Sometimes this can be avoided if the change will have no effect on the
+        actual packages generated by the recipe, such as updating the SRC_URI
+        to point to a new host. If in any doubt then you should increase the
+        PR regardless of what has been changed.</para>
+
+        <para>The PR value should never be decremented. If you accidentally
+        submit a large PR value for example then it should be left at the
+        value and just increased for new releases, not reset back to a lower
+        version. </para>
       </note></para>
 
     <para>When a recipe is being processed some variables are automatically