From 25b51d32c982a6767f3d4a88dec12f70c8c8f875 Mon Sep 17 00:00:00 2001
From: Michael 'Mickey' Lauer <mickey@vanille-media.de>
Date: Wed, 25 Feb 2009 01:47:30 +0100
Subject: docs: import usermanual from org.openembedded.documentation.
 org.openembedded.documentation is deprecated now; please do all updates here!

---
 docs/usermanual/reference/class_pkgconfig.xml | 39 +++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 docs/usermanual/reference/class_pkgconfig.xml

(limited to 'docs/usermanual/reference/class_pkgconfig.xml')

diff --git a/docs/usermanual/reference/class_pkgconfig.xml b/docs/usermanual/reference/class_pkgconfig.xml
new file mode 100644
index 0000000000..3cb5002df5
--- /dev/null
+++ b/docs/usermanual/reference/class_pkgconfig.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section id="pkgconfig_class" xreflabel="pkgconfig class">
+  <title>pkgconfig class</title>
+
+  <para>The pkgconfig class is for packages that install
+  <command>&lt;pkg&gt;.pc</command> files. These files provide information
+  about the build settings for the package vwhich are then made available by
+  the <command>pkg-config</command> command.</para>
+
+  <para>Since the contents of the <command>.pc</command> files are used at
+  build time they need to be installed into the staging area. All the actions
+  performed by this class are appended to the <emphasis>stage</emphasis>
+  task.</para>
+
+  <para>The actions performed by the pkgconfig class are:</para>
+
+  <orderedlist>
+    <listitem>
+      <para>Copies the <command>&lt;x&gt;.pc</command> files into the
+      <command>${PKG_CONFIG_PATH}</command> directory;</para>
+    </listitem>
+
+    <listitem>
+      <para>If the package is not native then it modifies the contents of the
+      <command>&lt;x&gt;.pc</command> file in the
+      <command>${PKG_CONFIG_PATH}</command> area to ensure that all the paths
+      in the script refer to the staging area;</para>
+    </listitem>
+  </orderedlist>
+
+  <para>A package is considered to be native if it also inherits the native
+  class.</para>
+
+  <para>The class will search the source directory, <command>${S}</command>,
+  and all it's subdirectories, for files that end in <command>.pc</command>
+  (it will ignore those that end in <command>-uninstalled.pc)</command> and
+  process them as described above. All that is required to use the class is
+  the addition of pkgconfig in an inherit statement:<screen>inherit autotools pkgconfig</screen></para>
+</section>
\ No newline at end of file
-- 
cgit v1.2.3