From 34dddc4f2fb84ba8495a0ec4acf33f667cd07a52 Mon Sep 17 00:00:00 2001 From: Janek Warchol Date: Wed, 15 Jun 2011 10:08:04 +0200 Subject: [PATCH 2/2] doc: more about running regtests, + fixup --- Documentation/contributor/regressions.itexi | 21 ++++++++++++++------- 1 files changed, 14 insertions(+), 7 deletions(-) diff --git a/Documentation/contributor/regressions.itexi b/Documentation/contributor/regressions.itexi index 50b038b..45ccbaf 100644 --- a/Documentation/contributor/regressions.itexi +++ b/Documentation/contributor/regressions.itexi @@ -188,18 +188,16 @@ twice. @enumerate @item -Ensure that currently built binary is the one without your changes. +Run @code{make} with current git master without any of your changes. @item -Before making changes to the code, establish a baseline for the -comparison by running: +Before making changes to the code, establish a baseline for the comparison by +going to the @file{lilypond-git/build/} directory and running: @example make test-baseline @end example -in @file{lilypond-git/build/} directory. - @item Make your changes, or apply the patch(es) to consider. @@ -214,10 +212,10 @@ make check @end example After this has finished, a regression test comparison will be -available at: +available (relative to the current @file{build/} directory) at: @example -build/out/test-results/index.html +out/test-results/index.html @end example For each regression test that differs between the baseline and the @@ -269,6 +267,15 @@ automatic regression comparison again. @end enumerate address@hidden +Once a test baseline has been established, there is no need to run it again +unless git master changed. In other words, if you work with several branches +and want to do regtests comparison for all of them, you can address@hidden test-baseline} with git master, checkout some branch, address@hidden and @code{make check} it, then switch to another branch, address@hidden and @code{make check} it without doing @code{make test-baseline} +again.} + @node Finding the cause of a regression @section Finding the cause of a regression -- 1.7.0.4