X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fcontributor%2Fregressions.itexi;h=0c9093b4b89893bcff84de8ed303b08cfab761c2;hb=737bdcc2e6e75483d8ce6e824f211a36c969a1ea;hp=70fbcf18a2f4e7e2e9c97126be8f33f6933d028a;hpb=3b0017aaf24f58b075f9c4878d5969e388dcbd9a;p=lilypond.git diff --git a/Documentation/contributor/regressions.itexi b/Documentation/contributor/regressions.itexi index 70fbcf18a2..0c9093b4b8 100644 --- a/Documentation/contributor/regressions.itexi +++ b/Documentation/contributor/regressions.itexi @@ -85,6 +85,12 @@ You are invited to report anything that looks broken, or any case where the output quality is not on par with the previous release, as described in @rweb{Bug reports}. +@warning{ 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.} + + @subheading What to look for The test comparison shows all of the changes that occurred between @@ -152,8 +158,8 @@ make -j5 CPU_COUNT=5 test @end example The regtest output will then be available in -@file{input/@/regression/@/out@/-test}. -@file{input/@/regression/@/out@/-test/@/collated@/-examples@/.html} +@file{input/regression/out-test}. +@file{input/regression/out-test/collated-examples.html} contains a listing of all the regression tests that were run, but none of the images are included. Individual images are also available in this directory. @@ -189,7 +195,7 @@ make check @end example After @samp{make@tie{}check} is complete, a regression test comparison -will be available at @file{out/@/test@/-results/@/index@/.html}. +will be available at @file{out/test-results/index.html}. For each regression test that differs between the baseline and the changed code, a regression test entry will displayed. Ideally, the only changes would be the changes that you were working on. If @@ -197,7 +203,7 @@ regressions are introduced, they must be fixed before committing the code. @warning{ -The special regression test @file{test@/-output@/-distance@/.ly} will always +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.} @@ -209,8 +215,8 @@ can be repeatedly examined by doing: 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}. +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. @@ -262,7 +268,7 @@ developed to test @samp{musicxml2ly}, these regression tests can be used to test any MusicXML implementation. The MusicXML regression tests are found at -@file{input/@/regression/@/musicxml/}. +@file{input/regression/musicxml/}. The output resulting from running these tests through @samp{muscxml2ly} followed by @samp{lilypond} is