From e8fc7813b17822c138150807484197ef8d4e7c21 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Janek=20Warcho=C5=82?= Date: Wed, 11 Jul 2012 21:33:28 +0200 Subject: [PATCH] CG: explain what big staff size means in regtests Regtests about small or easy to overlook changes should use bigger staff size. --- Documentation/contributor/programming-work.itexi | 4 ++++ Documentation/contributor/regressions.itexi | 16 ++++++++++++++-- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/Documentation/contributor/programming-work.itexi b/Documentation/contributor/programming-work.itexi index 016145d83c..a76335c8b9 100644 --- a/Documentation/contributor/programming-work.itexi +++ b/Documentation/contributor/programming-work.itexi @@ -1311,6 +1311,10 @@ Regression tests should generally cover one issue per test. Several short, single-issue regression tests are preferred to a single, long, multiple-issue regression test. +If the change in the output is small or easy to overlook, use bigger +staff size -- 40 or more (up to 100 in extreme cases). Size 30 means +"pay extra attention to details in general". + Use existing regression tests as templates to demonstrate the type of header information that should be included in a regression test. diff --git a/Documentation/contributor/regressions.itexi b/Documentation/contributor/regressions.itexi index 5de3f8aa91..7bca714f2c 100644 --- a/Documentation/contributor/regressions.itexi +++ b/Documentation/contributor/regressions.itexi @@ -99,8 +99,20 @@ verify that the regression tests have, in fact, run.} The test comparison shows all of the changes that occurred between the current release and the prior release. Each test that has a -significant difference in output is displayed, with the old -version on the left and the new version on the right. +significant (noticeable) difference in output is displayed, with +the old version on the left and the new version on the right. + +Some of the small changes can be ignored (slightly different slur +shapes, small variations in note spacing), but this is not always +the case: sometimes even the smallest change means that something +is wrong. To help in distinguishing these cases, we use bigger +staff size when small differences matter. + +Staff size 30 generally means "pay extra attention to details". +Staff size 40 (two times bigger than default size) or more means +that the regtest @strong{is} about the details. + +Staff size smaller than default doesn't mean anything. Regression tests whose output is the same for both versions are not shown in the test comparison. -- 2.39.2