summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-31 17:37:54 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-04-01 10:23:02 +0100
commitd5a0a6b67632c99ea08e2782e8b7e345962470df (patch)
treeb0f282341218f97c874fe2737fce3376318d5bd0 /documentation/ref-manual
parent9ba7a776ebd885feeb4e0d89aa07e9517843a19c (diff)
downloadpoky-d5a0a6b67632c99ea08e2782e8b7e345962470df.tar.gz
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>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/migration.xml142
-rw-r--r--documentation/ref-manual/ref-variables.xml37
2 files changed, 169 insertions, 10 deletions
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index 3db3ea6b84..28f21b595e 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -1112,16 +1112,150 @@
1112 <title>BitBake</title> 1112 <title>BitBake</title>
1113 1113
1114 <para> 1114 <para>
1115 Sample section. 1115 The following changes have been made to
1116 <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>.
1116 </para> 1117 </para>
1118
1119 <section id='migration-1.6-bitbake-deps'>
1120 <title>Python Definition substitutions</title>
1121
1122 <para>
1123 had some previously deprecated Python definitions within
1124 its <filename>bb</filename> module removed.
1125 You should use their sub-module counterparts instead:
1126 <itemizedlist>
1127 <listitem><para><filename>bb.MalformedUrl</filename>:
1128 Use <filename>bb.fetch.MalformedUrl</filename>.
1129 </para></listitem>
1130 <listitem><para><filename>bb.encodeurl</filename>:
1131 Use <filename>bb.fetch: encodeurl</filename>.
1132 </para></listitem>
1133 <listitem><para><filename>bb.decodeurl</filename>:
1134 Use <filename>bb.fetch.decodeurl</filename>
1135 </para></listitem>
1136 <listitem><para><filename>bb.mkdirhier</filename>:
1137 Use <filename>bb.utils.mkdirhier</filename>.
1138 </para></listitem>
1139 <listitem><para><filename>bb.movefile</filename>:
1140 Use <filename>bb.utils.movefile</filename>.
1141 </para></listitem>
1142 <listitem><para><filename>bb.copyfile</filename>:
1143 Use <filename>bb.utils.copyfile</filename>.
1144 </para></listitem>
1145 <listitem><para><filename>bb.which</filename>:
1146 Use <filename>bb.utils.which</filename>.
1147 </para></listitem>
1148 <listitem><para><filename>bb.vercmp_string</filename>:
1149 Use <filename>bb.utils.vercmp_string</filename>.
1150 </para></listitem>
1151 <listitem><para><filename>bb.vercmp</filename>:
1152 Use <filename>bb.utils.vercmp</filename>.
1153 </para></listitem>
1154 </itemizedlist>
1155 </para>
1156 </section>
1157
1158 <section id='migration-1.6-bitbake-fetcher'>
1159 <title>SVK Fetcher</title>
1160
1161 <para>
1162 The SVK fetcher has been removed from BitBake.
1163 </para>
1164 </section>
1117 </section> 1165 </section>
1118 1166
1119 <section id='migration-1.6-qa-warnings'> 1167 <section id='migration-1.6-variable-changes'>
1120 <title>QA Warnings</title> 1168 <title>Changes to Variables</title>
1121 1169
1122 <para> 1170 <para>
1123 Sample section. 1171 The following variables have changed.
1172 For information on the OpenEmbedded build system variables, see the
1173 "<link linkend='ref-variables-glos'>Variables Glossary</link>" Chapter.
1124 </para> 1174 </para>
1175
1176 <section id='migration-1.6-variable-changes-TMPDIR'>
1177 <title><filename>TMPDIR</filename></title>
1178
1179 <para>
1180 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
1181 can no longer be on an NFS mount.
1182 NFS does not offer full POSIX locking and inode consistency
1183 and can cause unexpected issues if used to store
1184 <filename>TMPDIR</filename>.
1185 </para>
1186
1187 <para>
1188 The check for this does not occur on startup.
1189 If <filename>TMPDIR</filename> is detected on an NFS mount,
1190 an error occurs.
1191 For more information on this restriction, see the
1192 <filename>TMPDIR</filename> description in the
1193 "<link linkend='ref-variables-glos'>Variables Glossary</link>".
1194 </para>
1195 </section>
1196
1197 <section id='migration-1.6-variable-changes-PRINC'>
1198 <title><filename>PRINC</filename></title>
1199
1200 <para>
1201 The
1202 <link linkend='var-PRINC'><filename>PRINC</filename></link>
1203 variable has been deprecated and triggers a warning if
1204 detected during a build.
1205 For
1206 <link linkend='var-PR'><filename>PR</filename></link>
1207 increments on changes, use the PR service instead.
1208 You can find out more about this service in the
1209 "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>Working With a PR Service</ulink>"
1210 section in the Yocto Project Development Manual.
1211 </para>
1212 </section>
1213
1214 <section id='migration-1.6-variable-changes-IMAGE_TYPES'>
1215 <title><filename>IMAGE_TYPES</filename></title>
1216
1217 <para>
1218 The "sum.jffs2" option for
1219 <link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link>
1220 has been replaced by the "jffs2.sum" option, which fits the
1221 processing order.
1222 </para>
1223 </section>
1224
1225 <section id='migration-1.6-variable-changes-COPY_LIC_MANIFEST'>
1226 <title><filename>COPY_LIC_MANIFEST</filename></title>
1227
1228 <para>
1229 The <filename>COPY_LIC_MANIFEST</filename> variable must
1230 now be set to "1" rather than any value in order to enable
1231 it.
1232 </para>
1233 </section>
1234
1235 <section id='migration-1.6-variable-changes-COPY_LIC_DIRS'>
1236 <title><filename>COPY_LIC_DIRS</filename></title>
1237
1238 <para>
1239 The <filename>COPY_LIC_DIRS</filename> variable must
1240 now be set to "1" rather than any value in order to enable
1241 it.
1242 </para>
1243 </section>
1244
1245 <section id='migration-1.6-variable-changes-PACKAGE_GROUP'>
1246 <title><filename>PACKAGE_GROUP</filename></title>
1247
1248 <para>
1249 The
1250 <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link>
1251 variable has been renamed to
1252 <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link>
1253 to more accurately reflect its purpose.
1254 You can still use <filename>PACKAGE_GROUP</filename> but
1255 the OpenEmbedded build system produces a warning message when
1256 it encounters the variable.
1257 </para>
1258 </section>
1125 </section> 1259 </section>
1126 1260
1127 <section id='migration-1.6-directory-layout-changes'> 1261 <section id='migration-1.6-directory-layout-changes'>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 966f7c2663..6d8e7aa0aa 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -5572,14 +5572,37 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5572 5572
5573 <glossentry id='var-PRINC'><glossterm>PRINC</glossterm> 5573 <glossentry id='var-PRINC'><glossterm>PRINC</glossterm>
5574 <glossdef> 5574 <glossdef>
5575 <para>Causes the <link linkend='var-PR'><filename>PR</filename></link> 5575
5576 <para>
5577 The <filename>PRINC</filename> variable has been deprecated
5578 and triggers a warning if detected during a build.
5579 For
5580 <link linkend='var-PR'><filename>PR</filename></link>
5581 increments on changes, use the PR service instead.
5582 You can find out more about this service in the
5583 "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>Working With a PR Service</ulink>"
5584 section in the Yocto Project Development Manual.
5585 </para>
5586<!--
5587
5588 <para>
5589 Causes the
5590 <link linkend='var-PR'><filename>PR</filename></link>
5576 variable of <filename>.bbappend</filename> files to 5591 variable of <filename>.bbappend</filename> files to
5577 dynamically increment. 5592 dynamically increment.
5578 This increment minimizes the impact of layer ordering.</para> 5593 This increment minimizes the impact of layer ordering.
5579 <para>In order to ensure multiple <filename>.bbappend</filename> files can co-exist, 5594 </para>
5595
5596 <para>
5597 In order to ensure multiple <filename>.bbappend</filename>
5598 files can co-exist,
5580 <filename>PRINC</filename> should be self-referencing. 5599 <filename>PRINC</filename> should be self-referencing.
5581 This variable defaults to 0.</para> 5600 This variable defaults to 0.
5582 <para>Following is an example that increments <filename>PR</filename> by two: 5601 </para>
5602
5603 <para>
5604 Following is an example that increments
5605 <filename>PR</filename> by two:
5583 <literallayout class='monospaced'> 5606 <literallayout class='monospaced'>
5584 PRINC := "${@int(PRINC) + 2}" 5607 PRINC := "${@int(PRINC) + 2}"
5585 </literallayout> 5608 </literallayout>
@@ -5587,7 +5610,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5587 this usage is very sensitive to layer ordering. 5610 this usage is very sensitive to layer ordering.
5588 You should avoid explicit assignments as they cannot 5611 You should avoid explicit assignments as they cannot
5589 adequately represent multiple 5612 adequately represent multiple
5590 <filename>.bbappend</filename> files.</para> 5613 <filename>.bbappend</filename> files.
5614 </para>
5615-->
5591 </glossdef> 5616 </glossdef>
5592 </glossentry> 5617 </glossentry>
5593 5618