diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 34 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 4 | ||||
-rw-r--r-- | documentation/ref-manual/technical-details.xml | 2 |
3 files changed, 21 insertions, 19 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index e12fa32516..e0726df77a 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -7854,8 +7854,6 @@ | |||
7854 | <title>Incrementing a Package Version</title> | 7854 | <title>Incrementing a Package Version</title> |
7855 | 7855 | ||
7856 | <para> | 7856 | <para> |
7857 | The scheme the OpenEmbedded build system uses for binary | ||
7858 | package versioning is a bit involved. | ||
7859 | This section provides some background on how binary package | 7857 | This section provides some background on how binary package |
7860 | versioning is accomplished and presents some of the services, | 7858 | versioning is accomplished and presents some of the services, |
7861 | variables, and terminology involved. | 7859 | variables, and terminology involved. |
@@ -7874,7 +7872,7 @@ | |||
7874 | is composed of two components - a version and a | 7872 | is composed of two components - a version and a |
7875 | revision. | 7873 | revision. |
7876 | <note> | 7874 | <note> |
7877 | Technically, the "epoch" (i.e. | 7875 | Technically, a third component, the "epoch" (i.e. |
7878 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>) | 7876 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>) |
7879 | is involved but this discussion for the most part | 7877 | is involved but this discussion for the most part |
7880 | ignores <filename>PE</filename>. | 7878 | ignores <filename>PE</filename>. |
@@ -7886,17 +7884,21 @@ | |||
7886 | variables, respectively. | 7884 | variables, respectively. |
7887 | </para></listitem> | 7885 | </para></listitem> |
7888 | <listitem><para> | 7886 | <listitem><para> |
7889 | <filename>PV</filename>: The recipe version, which is | 7887 | <filename>PV</filename>: The recipe version. |
7890 | not to be confused with the binary package version. | 7888 | <filename>PV</filename> represents the version of the |
7889 | software being packaged. | ||
7890 | Do not confuse <filename>PV</filename> with the | ||
7891 | binary package version. | ||
7891 | </para></listitem> | 7892 | </para></listitem> |
7892 | <listitem><para> | 7893 | <listitem><para> |
7893 | <filename>PR</filename>: The recipe revision. | 7894 | <filename>PR</filename>: The recipe revision. |
7894 | </para></listitem> | 7895 | </para></listitem> |
7895 | <listitem><para> | 7896 | <listitem><para> |
7896 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCPV'><filename>SRCPV</filename></ulink>: | 7897 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCPV'><filename>SRCPV</filename></ulink>: |
7897 | The Version string of the binary package. | ||
7898 | The OpenEmbedded build system uses this string | 7898 | The OpenEmbedded build system uses this string |
7899 | to help define the value of <filename>PV</filename>. | 7899 | to help define the value of <filename>PV</filename> |
7900 | when the source code revision needs to be included | ||
7901 | in it. | ||
7900 | </para></listitem> | 7902 | </para></listitem> |
7901 | <listitem><para> | 7903 | <listitem><para> |
7902 | <ulink url='https://wiki.yoctoproject.org/wiki/PR_Service'>PR Service</ulink>: | 7904 | <ulink url='https://wiki.yoctoproject.org/wiki/PR_Service'>PR Service</ulink>: |
@@ -7908,7 +7910,7 @@ | |||
7908 | </para> | 7910 | </para> |
7909 | 7911 | ||
7910 | <para> | 7912 | <para> |
7911 | Whenever the binary package output changes, the binary package | 7913 | Whenever the binary package content changes, the binary package |
7912 | version must change. | 7914 | version must change. |
7913 | Changing the binary package version is accomplished by changing | 7915 | Changing the binary package version is accomplished by changing |
7914 | or "bumping" the <filename>PR</filename> and/or | 7916 | or "bumping" the <filename>PR</filename> and/or |
@@ -7937,7 +7939,7 @@ | |||
7937 | progression. | 7939 | progression. |
7938 | For information on how to ensure package revisioning remains | 7940 | For information on how to ensure package revisioning remains |
7939 | linear, see the | 7941 | linear, see the |
7940 | "<link linkend='incrementing-a-binary-package-revision-number'>Incrementing a Binary Package Revision Number</link>" | 7942 | "<link linkend='automatically-incrementing-a-binary-package-revision-number'>Automatically Incrementing a Binary Package Revision Number</link>" |
7941 | section. | 7943 | section. |
7942 | </para> | 7944 | </para> |
7943 | 7945 | ||
@@ -8154,18 +8156,18 @@ | |||
8154 | </para> | 8156 | </para> |
8155 | </section> | 8157 | </section> |
8156 | 8158 | ||
8157 | <section id='incrementing-a-binary-package-revision-number'> | 8159 | <section id='automatically-incrementing-a-binary-package-revision-number'> |
8158 | <title>Incrementing a Binary Package Revision Number</title> | 8160 | <title>Automatically Incrementing a Package Version Number</title> |
8159 | 8161 | ||
8160 | <para> | 8162 | <para> |
8161 | When fetching a repository, BitBake uses the | 8163 | When fetching a repository, BitBake uses the |
8162 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink> | 8164 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink> |
8163 | variable to determine the specific revision from which to | 8165 | variable to determine the specific source code revision |
8164 | build. | 8166 | from which to build. |
8165 | You set the <filename>SRCREV</filename> variable to | 8167 | You set the <filename>SRCREV</filename> variable to |
8166 | <ulink url='&YOCTO_DOCS_REF_URL;#var-AUTOREV'><filename>AUTOREV</filename></ulink> | 8168 | <ulink url='&YOCTO_DOCS_REF_URL;#var-AUTOREV'><filename>AUTOREV</filename></ulink> |
8167 | to cause the OpenEmbedded build system to automatically use the | 8169 | to cause the OpenEmbedded build system to automatically use the |
8168 | latest revision of the package: | 8170 | latest revision of the software: |
8169 | <literallayout class='monospaced'> | 8171 | <literallayout class='monospaced'> |
8170 | SRCREV = "${AUTOREV}" | 8172 | SRCREV = "${AUTOREV}" |
8171 | </literallayout> | 8173 | </literallayout> |
@@ -8174,8 +8176,8 @@ | |||
8174 | <para> | 8176 | <para> |
8175 | Furthermore, you need to reference <filename>SRCPV</filename> | 8177 | Furthermore, you need to reference <filename>SRCPV</filename> |
8176 | in <filename>PV</filename> in order to automatically update | 8178 | in <filename>PV</filename> in order to automatically update |
8177 | the binary package version whenever the revision of the | 8179 | the version whenever the revision of the source code |
8178 | source code changes. | 8180 | changes. |
8179 | Here is an example: | 8181 | Here is an example: |
8180 | <literallayout class='monospaced'> | 8182 | <literallayout class='monospaced'> |
8181 | PV = "1.0+git${SRCPV}" | 8183 | PV = "1.0+git${SRCPV}" |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 3699ae75bc..6307870a4e 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -487,7 +487,7 @@ | |||
487 | 487 | ||
488 | <para> | 488 | <para> |
489 | For more information see the | 489 | For more information see the |
490 | "<ulink url='&YOCTO_DOCS_DEV_URL;#incrementing-a-binary-package-revision-number'>Incrementing a Binary Package Revision Number</ulink>" | 490 | "<ulink url='&YOCTO_DOCS_DEV_URL;#automatically-incrementing-a-binary-package-revision-number'>Automatically Incrementing a Binary Package Revision Number</ulink>" |
491 | section in the Yocto Project Development Manual. | 491 | section in the Yocto Project Development Manual. |
492 | </para> | 492 | </para> |
493 | </glossdef> | 493 | </glossdef> |
@@ -12691,7 +12691,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
12691 | <filename>SRCREV</filename>, see the | 12691 | <filename>SRCREV</filename>, see the |
12692 | <link linkend='var-AUTOREV'><filename>AUTOREV</filename></link> | 12692 | <link linkend='var-AUTOREV'><filename>AUTOREV</filename></link> |
12693 | variable description and the | 12693 | variable description and the |
12694 | "<ulink url='&YOCTO_DOCS_DEV_URL;#incrementing-a-binary-package-revision-number'>Incrementing a Binary Package Revision Number</ulink>" | 12694 | "<ulink url='&YOCTO_DOCS_DEV_URL;#automatically-incrementing-a-binary-package-revision-number'>Automatically Incrementing a Binary Package Revision Number</ulink>" |
12695 | section, which is in the Yocto Project Development Manual. | 12695 | section, which is in the Yocto Project Development Manual. |
12696 | </note> | 12696 | </note> |
12697 | </para> | 12697 | </para> |
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index e3b7fec353..1964a9a105 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml | |||
@@ -432,7 +432,7 @@ | |||
432 | For information on how the OpenEmbedded build system | 432 | For information on how the OpenEmbedded build system |
433 | works with packages and can | 433 | works with packages and can |
434 | track incrementing <filename>PR</filename> information, see the | 434 | track incrementing <filename>PR</filename> information, see the |
435 | "<ulink url='&YOCTO_DOCS_DEV_URL;#incrementing-a-binary-package-revision-number'>Incrementing a Binary Package Revision Number</ulink>" | 435 | "<ulink url='&YOCTO_DOCS_DEV_URL;#automatically-incrementing-a-binary-package-revision-number'>Automatically Incrementing a Binary Package Revision Number</ulink>" |
436 | section. | 436 | section. |
437 | </note> | 437 | </note> |
438 | 438 | ||