README revision 145620 
1$FreeBSD: head/tools/regression/usr.bin/make/README 145620 2005-04-28 13:20:48Z harti $
2
3This directory contains regression tests for make(1).
4
5The tests are invoked via the test.sh script or prove(1) from p5-Test-Harness
6
7	% test.sh [-v] [-m path_to_make_binary] command
8
9	clean	- Remove the results and the other temp files that
10		  are produced by running the test. This brings the
11		  test into its initial state.
12
13	compare	- Check if results of the test match the expected
14		  output from stdout, stderr, and the status.
15
16	desc	- print description of test
17
18	diff	- Output the diffs from the tests and the expected
19		  stdout, stderr, and the status files.
20
21	run	- Invoke test, compare, and clean in sequence.
22
23	test	- Invoke the test code
24
25	update	- Copy the output of the last test run as the expected
26		  output from stdout, stderr, and the status.
27
28	% [MAKE_PROG=path_to_make_binary] prove [options] [files/directories]
29
30Example:
31	% sh test.t -m `pwd`/../obj/make run
32	% MAKE_PROG=/usr/obj/usr/src/usr.bin/make/make prove -r
33
34Variables
35---------
36WORK_BASE	- base directory for working files
37SRC_BASE	- test source base directory
38SUBDIR		- subdirectory below WORK_BASE and SRC_BASE for current test
39WORK_DIR	- ${WORK_BASE}/${SUBDIR}
40SRC_DIR		- ${SRC_BASE}/${SUBDIR}
41MAKE_PROG	- path to the make program to test
42
43WORK_BASE and MAKE_PROG are intented to be set by the user. All other
44variables are set by the script and can be used in scripts.
45
46Directory layout
47----------------
48common.sh		- common code
49all.sh			- recursively call test scripts
50
51basic/
52      t0/test.t	- regression test
53      t1/test.t	- regression test
54      t2/test.t	- regression test
55variables/
56          t0/test.t	- regression test
57          t1/test.t	- regression test
58
59Each test directory should contain at least a test.t script
60and the expected output files.
61