aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJamie Lenehan <lenehan@twibble.org>2007-03-14 23:29:45 +0000
committerJamie Lenehan <lenehan@twibble.org>2007-03-14 23:29:45 +0000
commit845b0062935f20e90551cace2520e70f1ca4e5f6 (patch)
tree5ed2b3c17ff9730f6c0735b0d02931d9af3bcd36
parent750dc0a90438b48cabf552531e4e132e3a914782 (diff)
downloadopenembedded-845b0062935f20e90551cace2520e70f1ca4e5f6.tar.gz
openembedded-845b0062935f20e90551cace2520e70f1ca4e5f6.tar.bz2
openembedded-845b0062935f20e90551cace2520e70f1ca4e5f6.zip
usermanual: Add a siteinfo class section to the reference manual. Move the
siteinfo class related stuff from the autotools class section into the siteuinfo class section and add details on the SITEINFO_ENDIANESS and SITEINFO_BITS variables.
-rw-r--r--usermanual/reference/class_autotools.xml102
-rw-r--r--usermanual/reference/class_siteinfo.xml180
-rw-r--r--usermanual/usermanual.xml3
3 files changed, 188 insertions, 97 deletions
diff --git a/usermanual/reference/class_autotools.xml b/usermanual/reference/class_autotools.xml
index 25c32d8e50..a9e1a5721a 100644
--- a/usermanual/reference/class_autotools.xml
+++ b/usermanual/reference/class_autotools.xml
@@ -80,103 +80,11 @@ do_install_append () {
via the site file(s) for the architecture you are using and may be
specific to the package you are building.</para>
- <para>Which site files are used is determined via the
- <command>classes/siteinfo.bbclass</command> class file and you should
- check that file to determine the names that apply to your target.
- Typically the following site files will be checked for, and used if
- found:</para>
-
- <variablelist>
- <varlistentry>
- <term>endian-(big|little)</term>
-
- <listitem>
- <para>Either <command>endian-big</command> or
- <command>endian-little</command> depending on the endianess of the
- target. This site file would contain defines that only change based
- on if the target is little endian or big endian.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>bit-(32|64)</term>
-
- <listitem>
- <para>Either <command>bit-32</command> or <command>bit-64</command>
- depending on the bitsize of the target. This site file would contain
- defines that only change based on if the target is a 32-bit or
- 64-bit cpu.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>common-(libc|uclibc)</term>
-
- <listitem>
- <para>Either <command>common-libc</command> or
- <command>common-uclibc</command> based on the C library being used
- for the target. This site file would contain defines the are
- specific to the C library being used.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>&lt;arch&gt;-common</term>
-
- <listitem>
- <para>A common site file for the target architecture. For i386,
- i485, i586 and i686 this would be <command>x86-common</command>, for
- sh3 and sh4 this would be <command>sh-common</command> and for
- various arm targets this would be
- <command>arm-common</command>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>common</term>
-
- <listitem>
- <para>This is a site file which is common for all targets and
- contains definitions which remain the same no matter what target is
- being built.</para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>Each of the supported site file for a target is checked for in
- several locations, and each one found will be used in order. The following
- locations are checked:</para>
-
- <variablelist>
- <varlistentry>
- <term>org.openembedded.dev/packages/&lt;packagename&gt;/site-&lt;version&gt;/</term>
-
- <listitem>
- <para>This directory is for site files which are specific to a
- particular version (where version is the PV of the package) of a
- package.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>org.openembedded.dev/packages/&lt;packagename&gt;/site/</term>
-
- <listitem>
- <para>This directory is for site files which are specific to a
- particular package, but apply to all versions of the package.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>org.openembedded.dev/site/</term>
-
- <listitem>
- <para>This directory is for site files that are common to all
- packages. Originally this was the only site file directory that was
- supported.</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <para>Autoconf uses site files as definied in the
+ <command>CONFIG_SITE</command> variable, which is a space seperate list of
+ files to load in the specified order. Details on how this variable is set
+ is provided in the <xref linkend="siteinfo_class" /> (the class
+ responsbile for setting the variable) section.</para>
<para>There are some things that you should keep in mind about the caching
of configure tests:</para>
diff --git a/usermanual/reference/class_siteinfo.xml b/usermanual/reference/class_siteinfo.xml
new file mode 100644
index 0000000000..4d66e85e7c
--- /dev/null
+++ b/usermanual/reference/class_siteinfo.xml
@@ -0,0 +1,180 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section id="siteinfo_class" xreflabel="siteinfo class">
+ <title>siteinfo class</title>
+
+ <para>The siteinfo class provides information for a target with a particular
+ emphasis on determining the names of the site files to be passed to
+ autoconf, as described in the <xref linkend="autotools_class" />. Full site
+ information for your target can be determined by looking at the table in the
+ class implementation found in the
+ <command>classes/siteinfo.bbclass</command> file. A typical entry contains
+ the name of the target and a list of site information for the
+ target:<screen> "sh4-linux": "endian-little bit-32 common-glibc sh-common",</screen>In
+ the above example for sh4-linux target (that's a build for an sh4 processor
+ using glibc) we see that the endianess and bit-size of target are defined
+ and an additional set of site files that should be used are listed. These
+ include a common site file for glibc and a common site file for sh
+ processors (so sh3 and sh4 can share defines). A <command>"common"</command>
+ entry is automatically added to the end of each of the definitions during
+ processing.</para>
+
+ <para>The class makes available three variables based on the information
+ provided for a target:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term>SITEINFO_ENDIANESS</term>
+
+ <listitem>
+ <para>Defines the endianess of the target as either
+ <command>"le"</command> (little endian) or <command>"be"</command>
+ (big endian). The target must list either
+ <command>endian-little</command> or <command>endian-big</command> in
+ it's site information.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>SITEINFO_BITS</term>
+
+ <listitem>
+ <para>Defines the bitsize of the target as either
+ <command>"32"</command> or <command>"64"</command>. The target must
+ list either <command>bit-32</command> or <command>bit-64</command> in
+ it's site information.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>CONFIG_SITE</term>
+
+ <listitem>
+ <para>Defines the site files to be used by autoconf. This is a space
+ separated list of one or more site files for the target.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>A typical use for the <command>SITEINFO_ENDIANESS</command> and
+ <command>SITEINFO_BITS</command> variables is to provide configuration
+ within a recipe based on their values. The following example from the
+ <emphasis>openssl</emphasis> recipe showw the correct define for the
+ endiness of the target being passed to openssl via the compiler flags. The
+ define to add to the flags is set based on the value of the
+ <command>SITEINFO_ENDIANESS</command> variable. Note that use of the
+ <emphasis>base_conditional</emphasis> method (see the <xref
+ linkend="recipes_advanced_python" /> section) to select a value conditional
+ on the endianess setting:</para>
+
+ <para><screen> # Additional flag based on target endiness (see siteinfo.bbclass)
+ CFLAG="${CFLAG} ${@base_conditional('SITEINFO_ENDIANESS', 'le', '-DL_ENDIAN', '-DB_ENDIAN', d)}"</screen></para>
+
+ <section>
+ <title>CONFIG_SITE: The autoconf site files</title>
+
+ <para>The autotools configuration method has support for caching the
+ results of tests. In the cross-compilation case it is sometimes necessary
+ to prime the cache with per-calculated results (since tests designed to
+ run on the target cannot be run when cross-compiling). These are defined
+ via the site file(s) for the architecture you are using and may be
+ specific to the package you are building.</para>
+
+ <para>Which site files are used is determined via the
+ <command>CONFIG_SITE</command> definition which is calculated via the
+ siteinfo class. Typically the following site files will be checked for,
+ and used in the order found:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term>endian-(big|little)</term>
+
+ <listitem>
+ <para>Either <command>endian-big</command> or
+ <command>endian-little</command> depending on the endianess of the
+ target. This site file would contain defines that only change based
+ on if the target is little endian or big endian.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>bit-(32|64)</term>
+
+ <listitem>
+ <para>Either <command>bit-32</command> or <command>bit-64</command>
+ depending on the bitsize of the target. This site file would contain
+ defines that only change based on if the target is a 32-bit or
+ 64-bit cpu.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>common-(libc|uclibc)</term>
+
+ <listitem>
+ <para>Either <command>common-libc</command> or
+ <command>common-uclibc</command> based on the C library being used
+ for the target. This site file would contain defines the are
+ specific to the C library being used.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>&lt;arch&gt;-common</term>
+
+ <listitem>
+ <para>A common site file for the target architecture. For i386,
+ i485, i586 and i686 this would be <command>x86-common</command>, for
+ sh3 and sh4 this would be <command>sh-common</command> and for
+ various arm targets this would be
+ <command>arm-common</command>.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>common</term>
+
+ <listitem>
+ <para>This is a site file which is common for all targets and
+ contains definitions which remain the same no matter what target is
+ being built.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>Each of the supported site files for a target is will be checked for
+ in several different directories. Each time a file is found it as added to
+ the list of files in the <command>CONFIG_SITE</command> variable. The
+ following directories are checked:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term>org.openembedded.dev/packages/&lt;packagename&gt;/site-&lt;version&gt;/</term>
+
+ <listitem>
+ <para>This directory is for site files which are specific to a
+ particular version (where version is the PV of the package) of a
+ package.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>org.openembedded.dev/packages/&lt;packagename&gt;/site/</term>
+
+ <listitem>
+ <para>This directory is for site files which are specific to a
+ particular package, but apply to all versions of the package.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>org.openembedded.dev/site/</term>
+
+ <listitem>
+ <para>This directory is for site files that are common to all
+ packages. Originally this was the only site file directory that was
+ supported.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+</section> \ No newline at end of file
diff --git a/usermanual/usermanual.xml b/usermanual/usermanual.xml
index 8f9cdd53fd..e978dd50cc 100644
--- a/usermanual/usermanual.xml
+++ b/usermanual/usermanual.xml
@@ -17,6 +17,7 @@
<!ENTITY class-pkgconfig SYSTEM "reference/class_pkgconfig.xml">
<!ENTITY class-rootfs_ipkg SYSTEM "reference/class_rootfs_ipkg.xml">
<!ENTITY var-section SYSTEM "reference/var_section.xml">
+<!ENTITY class-siteinfo SYSTEM "reference/class_siteinfo.xml">
<!ENTITY var-src-uri SYSTEM "reference/var_src_uri.xml">
<!ENTITY class-update-alternatives SYSTEM "reference/class_update-alternatives.xml">
<!ENTITY class-update-rcd SYSTEM "reference/class_update-rc.d.xml">
@@ -865,6 +866,8 @@ NOTE: Couldn't find shared library provider for libm.so.6
&var-section;
+ &class-siteinfo;
+
&var-src-uri;
&class-update-alternatives;