summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Eggleton <bluelightning@bluelightning.org>2023-04-22 15:19:40 +1200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-04-22 10:59:12 +0100
commit20c58a6cb217249c607fb4d7c15e94c3358a9c76 (patch)
treeaa37eb637d133e583b8ca554b3217635097a40b7
parentc3c439d62ab3208bc3f786a0dd82d1290486c289 (diff)
downloadpoky-20c58a6cb217249c607fb4d7c15e94c3358a9c76.tar.gz
dev/ref-manual: Remove references to INC_PR
This technique is no longer used (nor necessary), let's just remove it to avoid any confusion. (From yocto-docs rev: 8f50d0bf22fea8064c112f52df06dbd6a85a7a83) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/packages.rst12
-rw-r--r--documentation/ref-manual/variables.rst37
2 files changed, 0 insertions, 49 deletions
diff --git a/documentation/dev-manual/packages.rst b/documentation/dev-manual/packages.rst
index 90c52beb29..79f21d9f34 100644
--- a/documentation/dev-manual/packages.rst
+++ b/documentation/dev-manual/packages.rst
@@ -227,18 +227,6 @@ default value is "r0", the practice of adding it to a new recipe makes
227it harder to forget to bump the variable when you make changes to the 227it harder to forget to bump the variable when you make changes to the
228recipe in future. 228recipe in future.
229 229
230If you are sharing a common ``.inc`` file with multiple recipes, you can
231also use the :term:`INC_PR` variable to ensure that the recipes sharing the
232``.inc`` file are rebuilt when the ``.inc`` file itself is changed. The
233``.inc`` file must set :term:`INC_PR` (initially to "r0"), and all recipes
234referring to it should set :term:`PR` to "${INC_PR}.0" initially,
235incrementing the last number when the recipe is changed. If the ``.inc``
236file is changed then its :term:`INC_PR` should be incremented.
237
238When upgrading the version of a binary package, assuming the :term:`PV`
239changes, the :term:`PR` variable should be reset to "r0" (or "${INC_PR}.0"
240if you are using :term:`INC_PR`).
241
242Usually, version increases occur only to binary packages. However, if 230Usually, version increases occur only to binary packages. However, if
243for some reason :term:`PV` changes but does not increase, you can increase 231for some reason :term:`PV` changes but does not increase, you can increase
244the :term:`PE` variable (Package Epoch). The :term:`PE` variable defaults to 232the :term:`PE` variable (Package Epoch). The :term:`PE` variable defaults to
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 15f33dcf9f..2658fad61b 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3859,43 +3859,6 @@ system and gives an overview of their function and contents.
3859 files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take 3859 files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take
3860 care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. 3860 care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards.
3861 3861
3862 :term:`INC_PR`
3863 Helps define the recipe revision for recipes that share a common
3864 ``include`` file. You can think of this variable as part of the
3865 recipe revision as set from within an include file.
3866
3867 Suppose, for example, you have a set of recipes that are used across
3868 several projects. And, within each of those recipes the revision (its
3869 :term:`PR` value) is set accordingly. In this case, when
3870 the revision of those recipes changes, the burden is on you to find
3871 all those recipes and be sure that they get changed to reflect the
3872 updated version of the recipe. In this scenario, it can get
3873 complicated when recipes that are used in many places and provide
3874 common functionality are upgraded to a new revision.
3875
3876 A more efficient way of dealing with this situation is to set the
3877 :term:`INC_PR` variable inside the ``include`` files that the recipes
3878 share and then expand the :term:`INC_PR` variable within the recipes to
3879 help define the recipe revision.
3880
3881 The following provides an example that shows how to use the
3882 :term:`INC_PR` variable given a common ``include`` file that defines the
3883 variable. Once the variable is defined in the ``include`` file, you
3884 can use the variable to set the :term:`PR` values in each recipe. You
3885 will notice that when you set a recipe's :term:`PR` you can provide more
3886 granular revisioning by appending values to the :term:`INC_PR` variable::
3887
3888 recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
3889 recipes-graphics/xorg-font/encodings_1.0.4.bb:PR = "${INC_PR}.1"
3890 recipes-graphics/xorg-font/font-util_1.3.0.bb:PR = "${INC_PR}.0"
3891 recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3892
3893 The
3894 first line of the example establishes the baseline revision to be
3895 used for all recipes that use the ``include`` file. The remaining
3896 lines in the example are from individual recipes and show how the
3897 :term:`PR` value is set.
3898
3899 :term:`INCOMPATIBLE_LICENSE` 3862 :term:`INCOMPATIBLE_LICENSE`
3900 Specifies a space-separated list of license names (as they would 3863 Specifies a space-separated list of license names (as they would
3901 appear in :term:`LICENSE`) that should be excluded 3864 appear in :term:`LICENSE`) that should be excluded