chapter04/abouttestsuites.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-preps-abouttestsuites">
   9   <?dbhtml filename="abouttestsuites.html"?>
  10
  11   <title>About the Test Suites</title>
  12
  13   <para>Most packages provide a test suite. Running the test suite for a
  14   newly built package is a good idea because it can provide a <quote>sanity
  15   check</quote> indicating that everything compiled correctly. A test suite
  16   that passes its set of checks usually proves that the package is
  17   functioning as the developer intended. It does not, however, guarantee
  18   that the package is totally bug free.</para>
  19
  20   <para>Some test suites are more important than others. For example,
  21   the test suites for the core toolchain packages&mdash;GCC, Binutils, and
  22   Glibc&mdash;are of the utmost importance due to their central role in a
  23   properly functioning system. The test suites for GCC and Glibc can
  24   take a very long time to complete, especially on slower hardware, but
  25   are strongly recommended.</para>
  26
  27   <note>
  28     <para>Experience has shown that there is little to be gained from running
  29     the test suites in <xref linkend="chapter-temporary-tools"/>. There can be
  30     no escaping the fact that the host system always exerts some influence on
  31     the tests in that chapter, often causing inexplicable failures. Because
  32     the tools built in <xref linkend="chapter-temporary-tools"/> are temporary
  33     and eventually discarded, we do not recommend running the test suites in
  34     <xref linkend="chapter-temporary-tools"/> for the average reader. The
  35     instructions for running those test suites are provided for the benefit of
  36     testers and developers, but they are strictly optional.</para>
  37   </note>
  38
  39   <para>A common issue with running the test suites for Binutils and GCC
  40   is running out of pseudo terminals (PTYs). This can result in a high
  41   number of failing tests. This may happen for several reasons, but the
  42   most likely cause is that the host system does not have the
  43   <systemitem class="filesystem">devpts</systemitem> file system set up
  44   correctly. This issue is discussed in greater detail at
  45   <ulink url="&lfs-root;lfs/faq.html#no-ptys"/>.</para>
  46
  47   <para>Sometimes package test suites will fail, but for reasons which the
  48   developers are aware of and have deemed non-critical. Consult the logs located
  49   at <ulink url="&test-results;"/> to verify whether or not these failures are
  50   expected. This site is valid for all tests throughout this book.</para>
  51
  52 </sect1>