add ere backref regression test
[libc-test] / README
diff --git a/README b/README
index ccf9fda..aa50091 100644 (file)
--- a/README
+++ b/README
@@ -49,7 +49,7 @@ may be used to simplify the code like
 #define T2(f,w) (result=(f), result==(w) || (t_error("%s failed: got %s, want %s\n", #f, result, w),0))
 
 binaries should be possible to run from arbitrary directory.
-the build system runs the tests using the src/common/run tool which
+the build system runs the tests using the src/common/runtest tool which
 kills the test process after a timeout and reports the exit status
 in case of failure
 
@@ -68,14 +68,17 @@ Rich Felker, regression tests should contain reference of the bug
 build system:
 
 the main non-file make targets are all, run, clean and cleanall.
-(cleanall removes the reports as well, run reruns the dynamically
+(cleanall removes the reports unlike clean, run reruns the dynamically
 linked executables)
 
-for each directory under src there are targets like src/directory/all,
-src/directory/run and src/directory/clean to make only the contents
+make variable can be overridden from config.mak or the make command line,
+the variable B sets the build directory which is src by default
+
+for each directory under src there are targets like $(B)/directory/all,
+$(B)/directory/run and $(B)/directory/clean to make only the contents
 of that directory, each directory has its own Makefile set up so it
-invokes the top level make with src/directory/foo for the foo target,
-so it is possible to work only under a specific test directory
+invokes the top level make with B=src src/directory/foo for the foo
+target, so it is possible to work only under a specific test directory
 
 the build and runtime errors of each target are accumulated into a
 target.err file and in the end they are concatenated into a REPORT
@@ -85,9 +88,9 @@ dynamic linked and a static linked executable test binary by default,
 this behaviour can be changed by a similarly named .mk file changing
 make variables and specifying additional rules:
 
-$(N) is the name of the binary target (the file name without the .c)
-$(N)-static is the name of the static binary target
-$(D) is the directory
+$(B)/$(N) is the name of the binary target (the file name without the .c)
+$(B)/$(N)-static is the name of the static binary target
+$(B)/$(D) is the build directory
 $(N).CFLAGS are added to the CFLAGS at compilation
 $(N).LDFLAGS are added to the LDFLAGS at linking
 $(N).LDLIBS are added to the LDLIBS at linking