2011/6/15  <percival.music...@gmail.com>:
> LGTM, please make one change, then send me the final version for
> pushing.
> http://codereview.appspot.com/4621041/diff/9001/Documentation/contributor/regressions.itexi#newcode215
> Documentation/contributor/regressions.itexi:215: available (relative to
> the current build/ directory) at:
> oops, that should be
>
> @file{build/}
>
> sorry about that, my fault.

I should've noticed that also.

Patches attached.

cheers,
Janek
From 4dd5eee0f2ee77b740bdb4f61604efc9abb87b6f Mon Sep 17 00:00:00 2001
From: Janek Warchol <lemniskata.bernoull...@gmail.com>
Date: Tue, 14 Jun 2011 23:32:16 +0200
Subject: [PATCH 1/2] describing regression checking more explicitely

---
 Documentation/contributor/regressions.itexi |   11 ++++++++---
 1 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/Documentation/contributor/regressions.itexi b/Documentation/contributor/regressions.itexi
index 3ec39d4..50b038b 100644
--- a/Documentation/contributor/regressions.itexi
+++ b/Documentation/contributor/regressions.itexi
@@ -188,13 +188,18 @@ twice.
 @enumerate
 
 @item
-Before making changes, a baseline should be established by
-running:
+Ensure that currently built binary is the one without your changes.
+
+@item
+Before making changes to the code, establish a baseline for the
+comparison by running:
 
 @example
 make test-baseline
 @end example
 
+in @file{lilypond-git/build/} directory.
+
 @item
 Make your changes, or apply the patch(es) to consider.
 
@@ -212,7 +217,7 @@ After this has finished, a regression test comparison will be
 available at:
 
 @example
-out/test-results/index.html
+build/out/test-results/index.html
 @end example
 
 For each regression test that differs between the baseline and the
-- 
1.7.0.4

From 34dddc4f2fb84ba8495a0ec4acf33f667cd07a52 Mon Sep 17 00:00:00 2001
From: Janek Warchol <lemniskata.bernoull...@gmail.com>
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
 
+@advanced{
+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
+@code{make test-baseline} with git master, checkout some branch,
+@code{make} and @code{make check} it, then switch to another branch,
+@code{make} 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

_______________________________________________
lilypond-devel mailing list
lilypond-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/lilypond-devel

Reply via email to