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>
This commit is contained in:
Scott Rifenbark 2015-10-15 10:32:40 -07:00 committed by Richard Purdie
parent dc9e4cbfe6
commit cd48ccccaf
1 changed files with 23 additions and 1 deletions

View File

@ -2249,6 +2249,19 @@
Typically, setting these options is accomplished by running a
configure script with some options, or by modifying a build
configuration file.
<note>
As of Yocto Project Release 7.1, some of the core recipes
that package binary configuration scripts now disable the
scripts due to the scripts previously requiring error-prone
path substitution.
The OpenEmbedded build system uses
<filename>pkg-config</filename> now, which is much more
robust.
You can find a list of the <filename>*-config</filename>
scripts that are disabled list in the
"<ulink url='&YOCTO_DOCS_REF_URL;#migration-1.7-binary-configuration-scripts-disabled'>Binary Configuration Scripts Disabled</ulink>"
section in the Yocto Project Reference Manual.
</note>
</para>
<para>
@ -2364,7 +2377,16 @@
<para>
However, if the compile step fails, you need to diagnose the
failure.
Here are some common issues that cause failures:
Here are some common issues that cause failures.
<note>
For cases where improper paths are detected for
configuration files or for when libraries/headers cannot
be found, be sure you are using the more robust
<filename>pkg-config</filename>.
See the note in section
"<link linkend='new-recipe-configuring-the-recipe'>Configuring the Recipe</link>"
for additional information.
</note>
<itemizedlist>
<listitem><para><emphasis>Parallel build failures:</emphasis>
These failures manifest themselves as intermittent