From c0dc8d492e372a9c7eb8eafa50f2fc49b5bad8b6 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 18 Apr 2017 13:18:27 -0700 Subject: [PATCH] dev-manual, ref-manual: Updated various wordings and links Fixes [YOCTO #10995] I implemented various wording changes based on feedback from the review. One section title changes so some links in the ref-manual and the dev-manual needed updating as well. (From yocto-docs rev: 43a35a311a006d47db50602822e44ab431ca3e43) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 34 ++++++++++--------- documentation/ref-manual/ref-variables.xml | 4 +-- .../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 @@ Incrementing a Package Version - The scheme the OpenEmbedded build system uses for binary - package versioning is a bit involved. This section provides some background on how binary package versioning is accomplished and presents some of the services, variables, and terminology involved. @@ -7874,7 +7872,7 @@ is composed of two components - a version and a revision. - Technically, the "epoch" (i.e. + Technically, a third component, the "epoch" (i.e. PE) is involved but this discussion for the most part ignores PE. @@ -7886,17 +7884,21 @@ variables, respectively. - PV: The recipe version, which is - not to be confused with the binary package version. + PV: The recipe version. + PV represents the version of the + software being packaged. + Do not confuse PV with the + binary package version. PR: The recipe revision. SRCPV: - The Version string of the binary package. The OpenEmbedded build system uses this string - to help define the value of PV. + to help define the value of PV + when the source code revision needs to be included + in it. PR Service: @@ -7908,7 +7910,7 @@ - Whenever the binary package output changes, the binary package + Whenever the binary package content changes, the binary package version must change. Changing the binary package version is accomplished by changing or "bumping" the PR and/or @@ -7937,7 +7939,7 @@ progression. For information on how to ensure package revisioning remains linear, see the - "Incrementing a Binary Package Revision Number" + "Automatically Incrementing a Binary Package Revision Number" section. @@ -8154,18 +8156,18 @@ -
- Incrementing a Binary Package Revision Number +
+ Automatically Incrementing a Package Version Number When fetching a repository, BitBake uses the SRCREV - variable to determine the specific revision from which to - build. + variable to determine the specific source code revision + from which to build. You set the SRCREV variable to AUTOREV to cause the OpenEmbedded build system to automatically use the - latest revision of the package: + latest revision of the software: SRCREV = "${AUTOREV}" @@ -8174,8 +8176,8 @@ Furthermore, you need to reference SRCPV in PV in order to automatically update - the binary package version whenever the revision of the - source code changes. + the version whenever the revision of the source code + changes. Here is an example: 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 @@ For more information see the - "Incrementing a Binary Package Revision Number" + "Automatically Incrementing a Binary Package Revision Number" section in the Yocto Project Development Manual. @@ -12691,7 +12691,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SRCREV, see the AUTOREV variable description and the - "Incrementing a Binary Package Revision Number" + "Automatically Incrementing a Binary Package Revision Number" section, which is in the Yocto Project Development Manual. 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 @@ For information on how the OpenEmbedded build system works with packages and can track incrementing PR information, see the - "Incrementing a Binary Package Revision Number" + "Automatically Incrementing a Binary Package Revision Number" section.