Remove old testsuite
[dyninst.git] / newtestsuite / src / help.h
1 static void print_help()
2 {
3    fprintf(stderr, "General Information:\n");
4    fprintf(stderr, "-------------------------\n");
5    fprintf(stderr, "Usage: runTests [OPTION]...\n");
6    fprintf(stderr, "\n");
7    fprintf(stderr, "runTests is a wrapper program for running test_driver.  It monitors test_driver\n");
8    fprintf(stderr, "for crashes, and if one happens it reports the crash point and restarts\n");
9    fprintf(stderr, "test_driver.  It should be used when running multiple tests and looking for\n");
10    fprintf(stderr, "failures.\n");
11    fprintf(stderr, "\n");
12    fprintf(stderr, "Usage: test_driver [OPTION]...\n");
13    fprintf(stderr, "\n");
14    fprintf(stderr, "test_driver is the executable that loads mutators runs Dyninst/Symtab/etc.\n");
15    fprintf(stderr, "It should be used when debugging.  For example if you want to debug a single\n");
16    fprintf(stderr, "test run in gdb you should use test_driver.\n");
17    fprintf(stderr, "\n");
18    fprintf(stderr, "test_driver and runTests take the same arguments.\n");
19    fprintf(stderr, "\n");
20    fprintf(stderr, "\n");
21    fprintf(stderr, "Specifying tests to run:\n");
22    fprintf(stderr, "-------------------------\n");
23    fprintf(stderr, "\n");
24    fprintf(stderr, "You can use the following options to specify which tests should be run.  If\n");
25    fprintf(stderr, "multiple options are specified on the same command line, then options that\n");
26    fprintf(stderr, "specified the same class of thing are 'OR'd together.  Options from seperate\n");
27    fprintf(stderr, "classes are 'AND'd together when determining what tests to run.\n");
28    fprintf(stderr, "\n");
29    fprintf(stderr, "For example, the command: 'runTests -dyninst -create -low -none -gcc -g++'\n");
30    fprintf(stderr, "runs all 'Dyninst' tests in 'create' mode with optimization level 'low' or\n");
31    fprintf(stderr, "'none' and compiler 'gcc' or 'g++'.\n");
32    fprintf(stderr, "\n");
33    fprintf(stderr, "Tests\n");
34    fprintf(stderr, "  -test <test>,<test>,...           specifies test mutators to run.\n");
35    fprintf(stderr, "                                    Wildcards are valid in the test name.\n");
36    fprintf(stderr, "  -mutatee <mutatee>,<mutatee>,...  specifies test mutatees to run\n");
37    fprintf(stderr, "                                    Wildcards are valid in the mutatee name.\n");
38    fprintf(stderr, "\n");
39    fprintf(stderr, "Create/Attach modes\n");
40    fprintf(stderr, "  -create                           Run tests using create mode\n");
41    fprintf(stderr, "  -attach                           Run tests using attach mode\n");
42    fprintf(stderr, "  -allmode                          Run all create modes\n");
43    fprintf(stderr, "\n");
44    fprintf(stderr, "Components\n");
45    fprintf(stderr, "  -dyninst                          Run DyninstAPI tests\n");
46    fprintf(stderr, "  -symtab                           Run SymtabAPI tests\n");
47    fprintf(stderr, "  -allcomp                          Run all components\n");
48    fprintf(stderr, "\n");
49    fprintf(stderr, "Mutatee Optimization Levels\n");
50    fprintf(stderr, "  -max                              Run mutatees with max optimization\n");
51    fprintf(stderr, "  -high                             Run mutatees with high optimization\n");
52    fprintf(stderr, "  -low                              Run mutatees with low optimization\n");
53    fprintf(stderr, "  -none                             Run mutatees with no optimization\n");
54    fprintf(stderr, "  -allopt                           Run all optimization levels\n");
55    fprintf(stderr, "\n");
56    fprintf(stderr, "Mutatee Compilers\n");
57    fprintf(stderr, "  -<compiler name>                  Run mutatees compiled with <compiler name>\n");
58    fprintf(stderr, "                                    Valid choices for <compiler name> are:\n");
59    fprintf(stderr, "                                    gcc, g++, g77, icc, icpc, pgcc, pgCC, \n");
60    fprintf(stderr, "                                    cc, CC, cxx, VC, VC++, sun_cc, xlc, xlC,\n");
61    fprintf(stderr, "                                    ibm_as, masm, nasm, nocompiler\n");
62    fprintf(stderr, "  -allcompilers                     Run all compilers\n");
63    fprintf(stderr, "\n");
64    fprintf(stderr, "ABIs\n");
65    fprintf(stderr, "  -32                               Run mutatees that use a 32 bit ABI\n");
66    fprintf(stderr, "  -64                               Run mutatees that use a 64 bit ABI\n");
67    fprintf(stderr, "\n");
68    fprintf(stderr, "Other\n");
69    fprintf(stderr, "  -all                              The same as '-allmode', '-allcomp', and \n");
70    fprintf(stderr, "                                    '-allcompilers'.\n");
71    fprintf(stderr, "  -full                             Same as '-all', but adds '-allopt'.\n");
72    fprintf(stderr, "\n");
73    fprintf(stderr, "\n");
74    fprintf(stderr, "Test Output Levels\n");
75    fprintf(stderr, "------------------\n");
76    fprintf(stderr, "  -log [logfile]                    Outputs test logging information to \n");
77    fprintf(stderr, "                                    'logfile'.  This contains debug \n");
78    fprintf(stderr, "                                    information that may be relevant to why \n");
79    fprintf(stderr, "                                    tests pass or fail.  If logfile is not\n");
80    fprintf(stderr, "                                    present then output is sent to stderr\n");
81    fprintf(stderr, "  -v+\n");
82    fprintf(stderr, "  -v++\n");
83    fprintf(stderr, "  -verbose                          These options control output levels of\n");
84    fprintf(stderr, "                                    debug information from test_driver.  These\n");
85    fprintf(stderr, "                                    are useful for debugging problems in the\n");
86    fprintf(stderr, "                                    testing infrastructure.\n");
87    fprintf(stderr, "\n");
88    fprintf(stderr, "  -dboutput [file]                  Instead of printing human readable output, \n");
89    fprintf(stderr, "                                    test_driver should print a SQL file that\n");
90    fprintf(stderr, "                                    is suitable for submission to a database.\n");
91    fprintf(stderr, "\n");
92 }