From: Carl Sorensen <c_sorensen@byu.edu>
Date: Sun, 20 Jun 2010 10:33:21 +0000 (-0600)
Subject: Doc: Contributor's: Add explanation of regression make tartgets
X-Git-Tag: release/2.13.25-1~7
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=ca063b992540ba77ae0ecfe57f916294532dacc5;p=lilypond.git

Doc: Contributor's: Add explanation of regression make tartgets
---

diff --git a/Documentation/contributor/regressions.itexi b/Documentation/contributor/regressions.itexi
index 181b3a31a2..77ebdaa782 100644
--- a/Documentation/contributor/regressions.itexi
+++ b/Documentation/contributor/regressions.itexi
@@ -183,6 +183,31 @@ The special regression test @file{test-output-distance.ly} will always
 show up as a regression.  This test changes each time it is run, and
 serves to verify that the regression tests have, in fact, run.}
 
+Once @samp{make@tie{}test-baseline} and @samp{make@tie{}check} have been
+run, the files that differ between @samp{test-baseline} and @samp{check}
+can be repeatedly examined by doing:
+
+@example
+make test-redo
+@end example
+
+This updates the regression list at @file{out/test-results/index.html}.
+It does @emph{not} redo @file{test-output-distance.ly}.
+
+When all regressions have been resolved, the output list will be empty.
+
+Once all regressions have been resolved, a final check should be completed
+by running:
+
+@example
+make test-clean
+make check
+@end example
+
+This cleans the results of the previous @samp{make@tie{}check}, then does the
+automatic regression comparison again.  
+
+
 @node Memory and coverage tests
 @section Memory and coverage tests