summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2015-10-15 10:32:40 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-10-21 23:06:35 +0100
commitcd48ccccaf0c5b62195cfed56574e6f7eb5d8ee7 (patch)
treeb5c2fdb4a65a068ab597b8efbe3aa599a273cc1c
parentdc9e4cbfe6fc2bec4503de0b23fb4f02475c10ac (diff)
downloadpoky-cd48ccccaf0c5b62195cfed56574e6f7eb5d8ee7.tar.gz
dev-manual: Added notes to clarify use of pkg-config
Fixed [YOCTO #8168] I placed a couple notes in the "Configuration" and "Compilation" sections within the "Writing a New Recipe" section. These notes point out that the build system (as of release 1.7) now disables several *-config scripts. The user should be using "pkg-config" to ensure proper pathname construction and location of these types of scripts. (From yocto-docs rev: a46fd0f7b4d5da7bf3b218441ec5b9a6ef552266) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml24
1 files changed, 23 insertions, 1 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 44b046d965..5694776b88 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -2249,6 +2249,19 @@
2249 Typically, setting these options is accomplished by running a 2249 Typically, setting these options is accomplished by running a
2250 configure script with some options, or by modifying a build 2250 configure script with some options, or by modifying a build
2251 configuration file. 2251 configuration file.
2252 <note>
2253 As of Yocto Project Release 7.1, some of the core recipes
2254 that package binary configuration scripts now disable the
2255 scripts due to the scripts previously requiring error-prone
2256 path substitution.
2257 The OpenEmbedded build system uses
2258 <filename>pkg-config</filename> now, which is much more
2259 robust.
2260 You can find a list of the <filename>*-config</filename>
2261 scripts that are disabled list in the
2262 "<ulink url='&YOCTO_DOCS_REF_URL;#migration-1.7-binary-configuration-scripts-disabled'>Binary Configuration Scripts Disabled</ulink>"
2263 section in the Yocto Project Reference Manual.
2264 </note>
2252 </para> 2265 </para>
2253 2266
2254 <para> 2267 <para>
@@ -2364,7 +2377,16 @@
2364 <para> 2377 <para>
2365 However, if the compile step fails, you need to diagnose the 2378 However, if the compile step fails, you need to diagnose the
2366 failure. 2379 failure.
2367 Here are some common issues that cause failures: 2380 Here are some common issues that cause failures.
2381 <note>
2382 For cases where improper paths are detected for
2383 configuration files or for when libraries/headers cannot
2384 be found, be sure you are using the more robust
2385 <filename>pkg-config</filename>.
2386 See the note in section
2387 "<link linkend='new-recipe-configuring-the-recipe'>Configuring the Recipe</link>"
2388 for additional information.
2389 </note>
2368 <itemizedlist> 2390 <itemizedlist>
2369 <listitem><para><emphasis>Parallel build failures:</emphasis> 2391 <listitem><para><emphasis>Parallel build failures:</emphasis>
2370 These failures manifest themselves as intermittent 2392 These failures manifest themselves as intermittent