Skip to content

Commit d6afc49

Browse files
committed
Update of testing README.txt
Small update of the README.txt in the testing directory.
1 parent 4e75d77 commit d6afc49

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

testing/README.txt

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Doxygen regression test suite
2-
============================
2+
=============================
33

44
This directory contains a set of regression tests. Each test consists of a
55
file starting with a 3 digit number and a corresponding directory whose name
@@ -9,32 +9,44 @@ result is the same, there is no regression and the test passes. If there is a
99
difference the test fails and the difference (in diff -u format) will be shown.
1010
It is also possible to see whether or not the test can be built to a xhtml set
1111
of files (and tested against a DTD), it is also possible to create a pdf file
12-
for each test to see if the LaTeX / pdf generation is possible.
12+
for each test to see if the LaTeX / pdf generation is possible, similar for
13+
rtf and docbook output.
1314

1415
The runtest.py script responsible for running the tests takes a number of
1516
optional parameters:
16-
--updateref update the reference data for a test
17+
--updateref update the reference files. Should be used in
18+
combination with -id to update the reference file(s)
19+
for the given test
1720
--doxygen [DOXYGEN] path/name of the doxygen executable
1821
--xmllint [XMLLINT] path/name of the xmllint executable
19-
--id IDS [IDS ...] id of the test to perform
22+
--id IDS [IDS ...] run test with number n only (the option can be
23+
specified to run test with number n only (the option
24+
can be specified multiple times
2025
--start_id START_ID run tests starting with number n
2126
--end_id END_ID run tests ending with number n
22-
--all perform all tests
27+
--all can be used in combination with -updateref to update
28+
the reference files for all tests.
2329
--inputdir [INPUTDIR]
2430
input directory containing the tests
2531
--outputdir [OUTPUTDIR]
2632
output directory to write the doxygen output to
2733
--noredir disable redirection of doxygen warnings
34+
--pool [POOL] pool size of multiprocess tests
2835
--xml create xml output and check
2936
--rtf create rtf output
3037
--docbook create docbook output and check with xmllint
3138
--xhtml create xhtml output and check with xmllint
39+
--xmlxsd create xml output and check with xmllint against xsd
3240
--pdf create LaTeX output and create pdf from it
3341
--subdirs use the configuration parameter CREATE_SUBDIRS=YES
42+
--clang use CLANG_ASSISTED_PARSING, works only when doxygen
43+
has been compiled with "use_libclang"
3444
--keep keep result directories
35-
--cfg CFGS [CFGS ...] run test with extra doxygen configuration settings
45+
--cfg CFGS [CFGS ...]
46+
run test with extra doxygen configuration settings
3647
(the option may be specified multiple times
37-
In case neither --xml, --pdf, --rtf, --docbook or --xhtml is used the default is set to --xml.
48+
In case neither --xml, --xmlxsd, --pdf, --rtf, --docbook or --xhtml is used the
49+
default is set to --xml.
3850

3951
The runtest.pl has the following dependencies on 3rd party tools:
4052
- python to run the script

0 commit comments

Comments
 (0)