sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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 <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2017-04-18 13:18:27 -07:00 committed by Richard Purdie
parent e14f9743f9
commit c0dc8d492e
3 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -7854,8 +7854,6 @@
<title>Incrementing a Package Version</title> <title>Incrementing a Package Version</title>
<para> <para>
The scheme the OpenEmbedded build system uses for binary
package versioning is a bit involved.
This section provides some background on how binary package This section provides some background on how binary package
versioning is accomplished and presents some of the services, versioning is accomplished and presents some of the services,
variables, and terminology involved. variables, and terminology involved.
@ -7874,7 +7872,7 @@
is composed of two components - a version and a is composed of two components - a version and a
revision. revision.
<note> <note>
Technically, the "epoch" (i.e. Technically, a third component, the "epoch" (i.e.
<ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>) <ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>)
is involved but this discussion for the most part is involved but this discussion for the most part
ignores <filename>PE</filename>. ignores <filename>PE</filename>.
@ -7886,17 +7884,21 @@
variables, respectively. variables, respectively.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<filename>PV</filename>: The recipe version, which is <filename>PV</filename>: The recipe version.
not to be confused with the binary package version. <filename>PV</filename> represents the version of the
software being packaged.
Do not confuse <filename>PV</filename> with the
binary package version.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<filename>PR</filename>: The recipe revision. <filename>PR</filename>: The recipe revision.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<ulink url='&YOCTO_DOCS_REF_URL;#var-SRCPV'><filename>SRCPV</filename></ulink>: <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCPV'><filename>SRCPV</filename></ulink>:
The Version string of the binary package.
The OpenEmbedded build system uses this string The OpenEmbedded build system uses this string
to help define the value of <filename>PV</filename>. to help define the value of <filename>PV</filename>
when the source code revision needs to be included
in it.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<ulink url='https://wiki.yoctoproject.org/wiki/PR_Service'>PR Service</ulink>: <ulink url='https://wiki.yoctoproject.org/wiki/PR_Service'>PR Service</ulink>:
@ -7908,7 +7910,7 @@
</para> </para>
<para> <para>
Whenever the binary package output changes, the binary package Whenever the binary package content changes, the binary package
version must change. version must change.
Changing the binary package version is accomplished by changing Changing the binary package version is accomplished by changing
or "bumping" the <filename>PR</filename> and/or or "bumping" the <filename>PR</filename> and/or
@ -7937,7 +7939,7 @@
progression. progression.
For information on how to ensure package revisioning remains For information on how to ensure package revisioning remains
linear, see the linear, see the
"<link linkend='incrementing-a-binary-package-revision-number'>Incrementing a Binary Package Revision Number</link>" "<link linkend='automatically-incrementing-a-binary-package-revision-number'>Automatically Incrementing a Binary Package Revision Number</link>"
section. section.
</para> </para>
@ -8154,18 +8156,18 @@
</para> </para>
</section> </section>
<section id='incrementing-a-binary-package-revision-number'> <section id='automatically-incrementing-a-binary-package-revision-number'>
<title>Incrementing a Binary Package Revision Number</title> <title>Automatically Incrementing a Package Version Number</title>
<para> <para>
When fetching a repository, BitBake uses the When fetching a repository, BitBake uses the
<ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink>
variable to determine the specific revision from which to variable to determine the specific source code revision
build. from which to build.
You set the <filename>SRCREV</filename> variable to You set the <filename>SRCREV</filename> variable to
<ulink url='&YOCTO_DOCS_REF_URL;#var-AUTOREV'><filename>AUTOREV</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-AUTOREV'><filename>AUTOREV</filename></ulink>
to cause the OpenEmbedded build system to automatically use the to cause the OpenEmbedded build system to automatically use the
latest revision of the package: latest revision of the software:
<literallayout class='monospaced'> <literallayout class='monospaced'>
SRCREV = "${AUTOREV}" SRCREV = "${AUTOREV}"
</literallayout> </literallayout>
@ -8174,8 +8176,8 @@
<para> <para>
Furthermore, you need to reference <filename>SRCPV</filename> Furthermore, you need to reference <filename>SRCPV</filename>
in <filename>PV</filename> in order to automatically update in <filename>PV</filename> in order to automatically update
the binary package version whenever the revision of the the version whenever the revision of the source code
source code changes. changes.
Here is an example: Here is an example:
<literallayout class='monospaced'> <literallayout class='monospaced'>
PV = "1.0+git${SRCPV}" PV = "1.0+git${SRCPV}"

4
documentation/ref-manual/ref-variables.xml
View File

@ -487,7 +487,7 @@
<para> <para>
For more information see the For more information see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#incrementing-a-binary-package-revision-number'>Incrementing a Binary Package Revision Number</ulink>" "<ulink url='&YOCTO_DOCS_DEV_URL;#automatically-incrementing-a-binary-package-revision-number'>Automatically Incrementing a Binary Package Revision Number</ulink>"
section in the Yocto Project Development Manual. section in the Yocto Project Development Manual.
</para> </para>
</glossdef> </glossdef>
@ -12691,7 +12691,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<filename>SRCREV</filename>, see the <filename>SRCREV</filename>, see the
<link linkend='var-AUTOREV'><filename>AUTOREV</filename></link> <link linkend='var-AUTOREV'><filename>AUTOREV</filename></link>
variable description and the variable description and the
"<ulink url='&YOCTO_DOCS_DEV_URL;#incrementing-a-binary-package-revision-number'>Incrementing a Binary Package Revision Number</ulink>" "<ulink url='&YOCTO_DOCS_DEV_URL;#automatically-incrementing-a-binary-package-revision-number'>Automatically Incrementing a Binary Package Revision Number</ulink>"
section, which is in the Yocto Project Development Manual. section, which is in the Yocto Project Development Manual.
</note> </note>
</para> </para>

2
documentation/ref-manual/technical-details.xml
View File

@ -432,7 +432,7 @@
For information on how the OpenEmbedded build system For information on how the OpenEmbedded build system
works with packages and can works with packages and can
track incrementing <filename>PR</filename> information, see the track incrementing <filename>PR</filename> information, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#incrementing-a-binary-package-revision-number'>Incrementing a Binary Package Revision Number</ulink>" "<ulink url='&YOCTO_DOCS_DEV_URL;#automatically-incrementing-a-binary-package-revision-number'>Automatically Incrementing a Binary Package Revision Number</ulink>"
section. section.
</note> </note>