diff options
author | Jamie Lenehan <lenehan@twibble.org> | 2006-08-10 02:22:33 +0000 |
---|---|---|
committer | Jamie Lenehan <lenehan@twibble.org> | 2006-08-10 02:22:33 +0000 |
commit | 554d0e3ce4d97196c37fb8c2f9b55d01902fe46f (patch) | |
tree | 02457b8eac5987ab61228e274e23d63913eddfe3 /usermanual/reference | |
parent | 3dc9d384a8812b506c0132fd76318d228430d211 (diff) | |
download | openembedded-554d0e3ce4d97196c37fb8c2f9b55d01902fe46f.tar.gz |
usermanual: Document binconfig and pkgconfig in the reference section.
Diffstat (limited to 'usermanual/reference')
-rw-r--r-- | usermanual/reference/class_binconfig.xml | 45 | ||||
-rw-r--r-- | usermanual/reference/class_pkgconfig.xml | 38 |
2 files changed, 83 insertions, 0 deletions
diff --git a/usermanual/reference/class_binconfig.xml b/usermanual/reference/class_binconfig.xml new file mode 100644 index 0000000000..8ab82a569f --- /dev/null +++ b/usermanual/reference/class_binconfig.xml @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <title>binconfig</title> + + <para>The binconfig class is for packages that install + <command><pkg>-config</command> scripts that provide information about + the build settings for the package. It's usually provided by libraries which + and is used by other packages to determine various compiler options.</para> + + <para>Since the script is used at build time it is required to be copied + into the staging area. All the actions performed by the class are appended + to the <emphasis>do_stage</emphasis> task.</para> + + <para>The actions performed by the binconfig class are:</para> + + <orderedlist> + <listitem> + <para>Copies the <command><x>-config</command> script from the + package into <command>${STAGING_BINDIR} </command>directory;</para> + </listitem> + + <listitem> + <para>If the package is not native then it modifies the contents of the + <command><x>-config</command> script in the staging area to ensure + that all the paths in the script refer to the staging area;</para> + </listitem> + + <listitem> + <para>If the package is native then + the<command><x>-config</command> script is renamed to + <command><x>-config-native</command> to ensure that the native and + non-native versions do not interfere with each other.</para> + </listitem> + </orderedlist> + + <para>A package is considered to be native it also inherits the native + class.</para> + + <para>The class will search in <command>${S}</command>, and all it's + subdirectories, for files that end in <command>-config</command> and process + them as described above. All that is required to use the class is the + addition of binconfig in an inherit statement:</para> + + <para><screen>inherit autotools binconfig</screen></para> +</section>
\ No newline at end of file diff --git a/usermanual/reference/class_pkgconfig.xml b/usermanual/reference/class_pkgconfig.xml new file mode 100644 index 0000000000..529bf6945d --- /dev/null +++ b/usermanual/reference/class_pkgconfig.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <title>pkgconfig</title> + + <para>The pkgconfig class is for packages that install + <command><pkg>.pc</command> files that provide information about the + build settings for the package via the use of the + <command>pkg-config</command> command.</para> + + <para>Since the contents of the file is used at build time it is required to + be copied into the staging area. All the actions performed by the class are + appended to the <emphasis>do_stage</emphasis> task.</para> + + <para>The actions performed by the pkgconfig class are:</para> + + <orderedlist> + <listitem> + <para>Copies the <command><x>.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><x>.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 it also inherits the native + class.</para> + + <para>The class will search in <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 |