Documentation/contributor/regressions.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2 @node Regression tests
   3 @chapter Regression tests
   4
   5 @menu
   6 * Introduction to regression tests::
   7 * Current regtest output::
   8 * Comparison regtest output::
   9 * MusicXML tests::
  10 @end menu
  11
  12
  13 @node Introduction to regression tests
  14 @section Introduction to regression tests
  15
  16 LilyPond has a complete suite of regression tests that are used
  17 to ensure that changes to the code do not break existing behavior.
  18 These regression tests comprise small LilyPond snippets that test
  19 the functionality of each part of LilyPond.
  20
  21 Regression tests are added when new functionality is added to
  22 LilyPond.  They are also added when bugs are identified.  The
  23 snippet that causes the bug becomes a regression test to verify
  24 that the bug has been fixed.
  25
  26 The regression tests are automatically compiled using special @code{make}
  27 targets.  The output of the regression tests is also automatically
  28 checked to identify changes in LilyPond output.
  29
  30 The output of the regression tests is available on the website
  31 for every stable version of LilyPond.  This allows the comparison
  32 of different versions to see when bugs appeared.
  33
  34
  35 @node Current regtest output
  36 @section Current regtest output
  37
  38
  39 @node Comparison regtest output
  40 @section Comparison regtest output
  41
  42
  43 @node MusicXML tests
  44 @section MusicXML tests
  45
  46