documentation: Updates to get rid of PRINC variable.

I did not eliminate this variable but rather changed the description
to indicate that it has been deprecated and that the user should now
use a PR Service to do this stuff.  There were several areas in the
YP manual set that used the variable in code.  I just deleted those
lines from the code.

(From yocto-docs rev: 88a075e6306349e5f8c0d53b5288ef1e64956cd3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-03-31 17:37:54 -06:00 committed by Richard Purdie
parent 9ba7a776eb
commit d5a0a6b676
5 changed files with 169 additions and 14 deletions

View File

@ -881,7 +881,6 @@
contains the following:
<literallayout class='monospaced'>
FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
PRINC := "${@int(PRINC) + 2}"
</literallayout>
The append file needs to be in the
<filename>meta-xyz/recipes-core/init-ifupdown</filename> directory.

View File

@ -3409,8 +3409,6 @@
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
SRC_URI += "file://0001-calibrate-Add-printk-example.patch"
PRINC := "${@int(PRINC) + 1}"
</literallayout>
The <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
and <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>

View File

@ -701,7 +701,6 @@
recipes were referred to as packages - thus, the existence of several BitBake
variables that are seemingly mis-named,
(e.g. <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>,
<ulink url='&YOCTO_DOCS_REF_URL;#var-PRINC'><filename>PRINC</filename></ulink>,
<ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, and
<ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>).
</para></listitem>

View File

@ -1112,16 +1112,150 @@
<title>BitBake</title>
<para>
Sample section.
The following changes have been made to
<ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>.
</para>
<section id='migration-1.6-bitbake-deps'>
<title>Python Definition substitutions</title>
<para>
had some previously deprecated Python definitions within
its <filename>bb</filename> module removed.
You should use their sub-module counterparts instead:
<itemizedlist>
<listitem><para><filename>bb.MalformedUrl</filename>:
Use <filename>bb.fetch.MalformedUrl</filename>.
</para></listitem>
<listitem><para><filename>bb.encodeurl</filename>:
Use <filename>bb.fetch: encodeurl</filename>.
</para></listitem>
<listitem><para><filename>bb.decodeurl</filename>:
Use <filename>bb.fetch.decodeurl</filename>
</para></listitem>
<listitem><para><filename>bb.mkdirhier</filename>:
Use <filename>bb.utils.mkdirhier</filename>.
</para></listitem>
<listitem><para><filename>bb.movefile</filename>:
Use <filename>bb.utils.movefile</filename>.
</para></listitem>
<listitem><para><filename>bb.copyfile</filename>:
Use <filename>bb.utils.copyfile</filename>.
</para></listitem>
<listitem><para><filename>bb.which</filename>:
Use <filename>bb.utils.which</filename>.
</para></listitem>
<listitem><para><filename>bb.vercmp_string</filename>:
Use <filename>bb.utils.vercmp_string</filename>.
</para></listitem>
<listitem><para><filename>bb.vercmp</filename>:
Use <filename>bb.utils.vercmp</filename>.
</para></listitem>
</itemizedlist>
</para>
</section>
<section id='migration-1.6-bitbake-fetcher'>
<title>SVK Fetcher</title>
<para>
The SVK fetcher has been removed from BitBake.
</para>
</section>
</section>
<section id='migration-1.6-qa-warnings'>
<title>QA Warnings</title>
<section id='migration-1.6-variable-changes'>
<title>Changes to Variables</title>
<para>
Sample section.
The following variables have changed.
For information on the OpenEmbedded build system variables, see the
"<link linkend='ref-variables-glos'>Variables Glossary</link>" Chapter.
</para>
<section id='migration-1.6-variable-changes-TMPDIR'>
<title><filename>TMPDIR</filename></title>
<para>
<link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
can no longer be on an NFS mount.
NFS does not offer full POSIX locking and inode consistency
and can cause unexpected issues if used to store
<filename>TMPDIR</filename>.
</para>
<para>
The check for this does not occur on startup.
If <filename>TMPDIR</filename> is detected on an NFS mount,
an error occurs.
For more information on this restriction, see the
<filename>TMPDIR</filename> description in the
"<link linkend='ref-variables-glos'>Variables Glossary</link>".
</para>
</section>
<section id='migration-1.6-variable-changes-PRINC'>
<title><filename>PRINC</filename></title>
<para>
The
<link linkend='var-PRINC'><filename>PRINC</filename></link>
variable has been deprecated and triggers a warning if
detected during a build.
For
<link linkend='var-PR'><filename>PR</filename></link>
increments on changes, use the PR service instead.
You can find out more about this service in the
"<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>Working With a PR Service</ulink>"
section in the Yocto Project Development Manual.
</para>
</section>
<section id='migration-1.6-variable-changes-IMAGE_TYPES'>
<title><filename>IMAGE_TYPES</filename></title>
<para>
The "sum.jffs2" option for
<link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link>
has been replaced by the "jffs2.sum" option, which fits the
processing order.
</para>
</section>
<section id='migration-1.6-variable-changes-COPY_LIC_MANIFEST'>
<title><filename>COPY_LIC_MANIFEST</filename></title>
<para>
The <filename>COPY_LIC_MANIFEST</filename> variable must
now be set to "1" rather than any value in order to enable
it.
</para>
</section>
<section id='migration-1.6-variable-changes-COPY_LIC_DIRS'>
<title><filename>COPY_LIC_DIRS</filename></title>
<para>
The <filename>COPY_LIC_DIRS</filename> variable must
now be set to "1" rather than any value in order to enable
it.
</para>
</section>
<section id='migration-1.6-variable-changes-PACKAGE_GROUP'>
<title><filename>PACKAGE_GROUP</filename></title>
<para>
The
<link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link>
variable has been renamed to
<link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link>
to more accurately reflect its purpose.
You can still use <filename>PACKAGE_GROUP</filename> but
the OpenEmbedded build system produces a warning message when
it encounters the variable.
</para>
</section>
</section>
<section id='migration-1.6-directory-layout-changes'>

View File

@ -5572,14 +5572,37 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-PRINC'><glossterm>PRINC</glossterm>
<glossdef>
<para>Causes the <link linkend='var-PR'><filename>PR</filename></link>
<para>
The <filename>PRINC</filename> variable has been deprecated
and triggers a warning if detected during a build.
For
<link linkend='var-PR'><filename>PR</filename></link>
increments on changes, use the PR service instead.
You can find out more about this service in the
"<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>Working With a PR Service</ulink>"
section in the Yocto Project Development Manual.
</para>
<!--
<para>
Causes the
<link linkend='var-PR'><filename>PR</filename></link>
variable of <filename>.bbappend</filename> files to
dynamically increment.
This increment minimizes the impact of layer ordering.</para>
<para>In order to ensure multiple <filename>.bbappend</filename> files can co-exist,
This increment minimizes the impact of layer ordering.
</para>
<para>
In order to ensure multiple <filename>.bbappend</filename>
files can co-exist,
<filename>PRINC</filename> should be self-referencing.
This variable defaults to 0.</para>
<para>Following is an example that increments <filename>PR</filename> by two:
This variable defaults to 0.
</para>
<para>
Following is an example that increments
<filename>PR</filename> by two:
<literallayout class='monospaced'>
PRINC := "${@int(PRINC) + 2}"
</literallayout>
@ -5587,7 +5610,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
this usage is very sensitive to layer ordering.
You should avoid explicit assignments as they cannot
adequately represent multiple
<filename>.bbappend</filename> files.</para>
<filename>.bbappend</filename> files.
</para>
-->
</glossdef>
</glossentry>