File: README.txt

package info (click to toggle)
pcb 20091103-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 21,568 kB
  • ctags: 13,286
  • sloc: ansic: 112,778; sh: 6,245; yacc: 5,035; pascal: 4,086; makefile: 1,425; perl: 560; lex: 432; awk: 158; tcl: 63; xml: 20
file content (72 lines) | stat: -rw-r--r-- 2,821 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
FIXME -- this is not really updated yet.  It is more or less verbatim
from gerbv and needs updating for pcb.

Please read this file before making any modifications to the test suite.



**********************************************************************
**********************************************************************
* Updating existing "golden" files
**********************************************************************
**********************************************************************

./run_tests.sh --regen <testname>

will regenerate the golden file for <testname>.  I suggest saving
off a copy and using ImageMagick to look for the differences visually.
The run_tests.sh script has examples of comparing .png files.  Make
sure the changes are only the expected ones and then check the new
files back into cvs.  Do not blindly update these files as that defeats
the purpose of the tests.

**********************************************************************
**********************************************************************
* Adding New Tests
**********************************************************************
**********************************************************************

----------------------------------------------------------------------
Create input files
----------------------------------------------------------------------

Create a *small* layout input file and put it in the inputs/
directory.  The goal is to have a file which tests one particular aspect
of the capabilities of pcb.

----------------------------------------------------------------------
Add to tests.list
----------------------------------------------------------------------

Add an entry to the tests.list file for your new tests.  Use existing
entries as an example.

----------------------------------------------------------------------
Generate the reference files
----------------------------------------------------------------------

Generate the reference files for your new tests using the following

./run_tests.sh --regen <new_test_name> 

where <new_test_name> is the name of your new test from tests.list.  If you
are adding multiple tests, then you can list them all on the same
command line.

*IMPORTANT*
Verify that the generated .png files for your new tests are correct.  These
files will have been placed in the golden/ subdirectory.

----------------------------------------------------------------------
Update Makefile.am's
----------------------------------------------------------------------

Update inputs/Makefile.am and golden/Makefile.am to include your new
files.

----------------------------------------------------------------------
Add the new files to git
----------------------------------------------------------------------

FIXME -- fill in this section