add regex REG_ICASE test for austingroupbug #872
[libc-test] / README
diff --git a/README b/README
index c4ece08..aa50091 100644 (file)
--- a/README
+++ b/README
@@ -48,6 +48,11 @@ may be used to simplify the code like
 #define T1(a,b) (check(a,b) || (t_error("check(%s,%s) failed\n", a, b),0))
 #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/runtest tool which
+kills the test process after a timeout and reports the exit status
+in case of failure
+
 directories:
 
 src/api: interface tests, build time include header tests
@@ -62,10 +67,18 @@ Rich Felker, regression tests should contain reference of the bug
 
 build system:
 
-the targets src/directory/all and src/directory/clean build and clean
-only the specified directory, each directory has its own Makefile that
-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
+the main non-file make targets are all, run, clean and cleanall.
+(cleanall removes the reports unlike clean, run reruns the dynamically
+linked executables)
+
+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 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
@@ -75,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