Rebase for libxml 2.9.7
[platform/upstream/libxml2.git] / README.tests
1                        README.tests
2
3    Instructions for standalone test regressions of libxml2
4
5 libxml2-tests-$version.tar.gz contains 3 standalone C programs as well
6 as a large amount of tests and results coming from libxml2 itself and
7 from W3C, NIST, Sun Microsystems, Microsoft and James Clark. Each C
8 program has a different testing purpose:
9
10   runtest.c : runs libxml2 basic internal regression tests
11   runsuite.c: runs libxml2 against external regression tests
12   testapi.c : exercises the library public entry points
13   testchar.c: exercise the check of character ranges and UTF-8 validation
14
15 The command:
16
17   make check
18 or
19   make -f Makefile.tests check
20
21 should be sufficient on an Unix system to build and exercise the tests
22 for the version of the library installed on the system. Note however
23 that there isn't backward compatibility provided so if the installed
24 version is older than the testsuite one, failing to compile or run the tests
25 is likely. In any event this won't work with an installed libxml2 older
26 than 2.6.20.
27
28 Building on other platforms should be a matter of compiling the C files
29 like any other program using libxml2, running the test should be done
30 simply by launching the resulting executables.
31
32 Also note the availability of a "make valgrind" target which will run the
33 above tests under valgrind to check for memory errors (but this relies
34 on the availability of the valgrind command and take far more time to
35 complete).
36
37 Daniel Veillard
38 Mon May  7 2012
39