sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

ref-manual: Re-ordered classes that start with "S". 

(From yocto-docs rev: bfe1c17bd023cd7865cf535803bb7b02741ba16c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2013-12-05 15:09:29 -06:00 committed by Richard Purdie
parent c7521f627b
commit 32b62a9c96
1 changed files with 42 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
documentation/ref-manual/ref-classes.xml
View File

@ -2325,6 +2325,19 @@
</para>
</section>
<section id='ref-classes-sanity'>
<title>Host System Sanity Checks - <filename>sanity.bbclass</filename></title>
<para>
This class checks to see if prerequisite software is present on the host system
so that users can be notified of potential problems that might affect their build.
The class also performs basic user configuration checks from
the <filename>local.conf</filename> configuration file to
prevent common mistakes that cause build failures.
Distribution policy usually determines whether to include this class.
</para>
</section>
<section id='ref-classes-scons'>
<title><filename>scons.bbclass</filename></title>
@ -2379,6 +2392,35 @@
</para>
</section>
<section id='ref-classes-siteinfo'>
<title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title>
<para>
Autotools can require tests that must execute on the target hardware.
Since this is not possible in general when cross compiling, site information is
used to provide cached test results so these tests can be skipped over but
still make the correct values available.
The <filename><link linkend='structure-meta-site'>meta/site directory</link></filename>
contains test results sorted into different categories such as architecture, endianness, and
the <filename>libc</filename> used.
Site information provides a list of files containing data relevant to
the current build in the
<filename><link linkend='var-CONFIG_SITE'>CONFIG_SITE</link></filename> variable
that Autotools automatically picks up.
</para>
<para>
The class also provides variables like
<filename><link linkend='var-SITEINFO_ENDIANNESS'>SITEINFO_ENDIANNESS</link></filename>
and <filename><link linkend='var-SITEINFO_BITS'>SITEINFO_BITS</link></filename>
that can be used elsewhere in the metadata.
</para>
<para>
Because this class is included from <filename>base.bbclass</filename>, it is always active.
</para>
</section>
<section id='ref-classes-spdx'>
<title><filename>spdx.bbclass</filename></title>
@ -2522,48 +2564,6 @@
</para>
</section>
<section id='ref-classes-sanity'>
<title>Host System Sanity Checks - <filename>sanity.bbclass</filename></title>
<para>
This class checks to see if prerequisite software is present on the host system
so that users can be notified of potential problems that might affect their build.
The class also performs basic user configuration checks from
the <filename>local.conf</filename> configuration file to
prevent common mistakes that cause build failures.
Distribution policy usually determines whether to include this class.
</para>
</section>
<section id='ref-classes-siteinfo'>
<title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title>
<para>
Autotools can require tests that must execute on the target hardware.
Since this is not possible in general when cross compiling, site information is
used to provide cached test results so these tests can be skipped over but
still make the correct values available.
The <filename><link linkend='structure-meta-site'>meta/site directory</link></filename>
contains test results sorted into different categories such as architecture, endianness, and
the <filename>libc</filename> used.
Site information provides a list of files containing data relevant to
the current build in the
<filename><link linkend='var-CONFIG_SITE'>CONFIG_SITE</link></filename> variable
that Autotools automatically picks up.
</para>
<para>
The class also provides variables like
<filename><link linkend='var-SITEINFO_ENDIANNESS'>SITEINFO_ENDIANNESS</link></filename>
and <filename><link linkend='var-SITEINFO_BITS'>SITEINFO_BITS</link></filename>
that can be used elsewhere in the metadata.
</para>
<para>
Because this class is included from <filename>base.bbclass</filename>, it is always active.
</para>
</section>
<section id='ref-classes-terminal'>
<title><filename>terminal.bbclass</filename></title>