diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2015-05-31 11:28:55 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2015-05-31 11:28:55 (GMT) |
commit | 39228176c052fd293382dc9bc9b4b69b2a6af277 (patch) | |
tree | e26792a32babb5199b1f136d2188d179c318bd96 /testing/README | |
parent | 635d8cf30e702bdf83fe5c96452f8f863d57bdee (diff) | |
download | Doxygen-39228176c052fd293382dc9bc9b4b69b2a6af277.zip Doxygen-39228176c052fd293382dc9bc9b4b69b2a6af277.tar.gz Doxygen-39228176c052fd293382dc9bc9b4b69b2a6af277.tar.bz2 |
Added missing files and build instructions
Diffstat (limited to 'testing/README')
-rw-r--r-- | testing/README | 48 |
1 files changed, 0 insertions, 48 deletions
diff --git a/testing/README b/testing/README deleted file mode 100644 index 993ff48..0000000 --- a/testing/README +++ /dev/null @@ -1,48 +0,0 @@ -Doxygen regession test suite -============================ - -This directory contains a set of regression tests. Each test consists of a -file starting with a 3 digit number and a corresponding directory whose name -has the same 3 digit number. The directory contains one or more reference -files that are compared against the XML output produced by doxygen. If the -result is the same, there is no regression and the test passes. If there is a -difference the test fails and the difference (in diff -u format) will be shown. - -The runtest.pl script responsible for running the tests takes a number of -optional parameters: --id n: run test with number n only (the option may be specified - multiple times) default is to run all tests. --updateref: update the reference files. Should be used in combination - with -id to update the reference file(s) for the given test. --all: can be used in combination with -updateref to update the - reference files for all tests. --doxygen exe: run the specified doxygen executable. --xmllint exe: run the specified xmllint executable. - -The runtest.pl has the following dependenies on 3rd party tools: -- perl to run the script -- xmllint to normalize the XML output -- diff to show the differences in case a test fails - -Each test file can have a number of special comment lines that are extracted by -the runtest.pl script and take the form: -// <identifier>: 'argument' -Where <identifier> can be one of: -- objective: 'argument' provides the objective for the test (i.e. its purpose) -- check: 'argument' names a file that is generated by doxygen, which should - be compared against the reference. -- config: 'argument' is a line that is added to the default Doxyfile used to - run doxygen on the test file. - -Example to run all tests: - perl runtest.pl - -Example to run a test - perl runtest.pl -id 10 - -Example to update the reference files for a test - perl runtest.pl -updateref -id 10 - -There is also a Makefile, which can be used to run all tests by simply -invoking make. - |