abouttestsuites.xml 2.5 KB

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