doc/loupe-test.txt
changeset 105 2d48e8cdda24
parent 101 f44c530f80da
     1.1 --- a/doc/loupe-test.txt	Sat Oct 26 18:47:33 2013 +0100
     1.2 +++ b/doc/loupe-test.txt	Wed Oct 02 09:14:33 2013 +0100
     1.3 @@ -30,6 +30,13 @@
     1.4  C:\DP> set BOOKLOUPE=C:\GUTCHECK\GUTCHECK.EXE
     1.5  C:\DP> loupe-test *.tst
     1.6  
     1.7 +When a testcase fails, loupe-test shows the output of bookloupe (or gutcheck)
     1.8 +up until the point where it deviates from the expected result and displays a
     1.9 +carat (^) to point to the exact column where the deviation occurred. Sometimes
    1.10 +it can still be difficult to work out what is happening and so loupe-test also
    1.11 +supports a -o option which will simply print bookloupe's output without comment
    1.12 +or checking.
    1.13 +
    1.14  Writing your own testcases
    1.15  --------------------------
    1.16  
    1.17 @@ -163,6 +170,24 @@
    1.18         │    Line 3 column 29 - Query possible scanno arid              │
    1.19         └───────────────────────────────────────────────────────────────┘
    1.20  
    1.21 +Non standard output
    1.22 +-------------------
    1.23 +
    1.24 +Bookloupe normally follows a standard pattern when printing warnings which
    1.25 +loupe-test knows how to interpret. Occasionally this is not suitable and
    1.26 +the testcase needs to specify exactly what should be printed. This can
    1.27 +be done by adding a literal stdout to the EXPECTED tag:
    1.28 +
    1.29 +       ┌───────────────────────────────────────────────────────────────┐
    1.30 +       │**************** OPTIONS ****************                      │
    1.31 +       │--dump-config                                                  │
    1.32 +       │**************** EXPECTED(stdout) ****************             │
    1.33 +       │# Trivial configuration                                        │
    1.34 +       │                                                               │
    1.35 +       │[options]                                                      │
    1.36 +       │dp=true                                                        │
    1.37 +       └───────────────────────────────────────────────────────────────┘
    1.38 +
    1.39  False-positives
    1.40  ---------------
    1.41