From bbba9d568f5b0c446d2c5ff0ae6d286fb16ae047 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Thu, 17 Mar 2005 12:16:24 +0000 Subject: added descriptions --- tests/runtests.1 | 59 +++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 22 deletions(-) (limited to 'tests/runtests.1') diff --git a/tests/runtests.1 b/tests/runtests.1 index af4402bfd..ed5e8af48 100644 --- a/tests/runtests.1 +++ b/tests/runtests.1 @@ -36,30 +36,45 @@ will be considered for running. You can specify single test cases to run, space-separated, like "1 3 5 7 11", and you can specify a range like "45 to 67". .SH OPTIONS -.IP "-v" -not yet written -.IP "-c" -not yet written +.IP "-a" +Continue running the rest of the test cases even if one test fails. By +default, the test script stops as soon as an error is detected. +.IP "-c " +Provide a custom curl binary to run the tests with. Default is the curl +executable in the build tree. .IP "-d" -not yet written +Enable protocol debug: have the servers display protocol output. .IP "-g" -not yet written -.IP "-s" -not yet written +Run the given test(s) with gdb. This is best used on a single test case and +curl built --disable-shared. This then fires up gdb with command line set to +run the specified test case. Simply (set a break-point and) type 'run' to +start. +.IP "-h" +Displays a help text about this program's command line options. +.IP "-k" +Keep output and log files in log/ after a test run, even if no error was +detected. Useful for debugging. +.IP "-l" +Lists all test case names. .IP "-n" -not yet written -.IP "-t" -not yet written -.IP "-a" -not yet written +Disable the check for and use of valgrind. .IP "-p" -not yet written -.IP "-l" -not yet written -.IP "-k" -not yet written -.IP "-h" -not yet written +Prints out all files in "log/" to stdout when a test case fails. Very +practical when used in the automated and distributed tests since then the +people checking the failures and the reasons for them might not have physical +access to the machine and logs. +.IP "-s" +Shorter output. Speaks less than default. +.IP "-t[num]" +Selects a \fBtorture\fP test for the given tests. This makes runtests.pl first +run the tests once and count the number of memory allocations made. It then +reruns the test that number of times, each time forcing one of the allocations +to fail until all allocs have been tested. By setting \fInum\fP you can force +the allocation with that number to be set to fail at once instead of looping +through everyone, which is very handy when debugging and then often in +combination with \fI-g\-P. +.IP "-v" +Enable verbose output. Speaks more than default. .SH "RUNNING TESTS" Many tests have conditions that must be met before the test case can run fine. They could depend on built-in features in libcurl or features present in @@ -67,9 +82,9 @@ the operating system or even in 3rd party libraries that curl may or may not use. The test script checks this by itself, why it is safe to attempt to run all -tests. They who cannot be run due to failed requirements, while simply be +tests. They who cannot be run due to failed requirements, will simply be skipped and you'll get a report about it when all test cases have completed. .SH "WRITING TESTS" -The simples way to write test cases is to start with a similar existing test, +The simplest way to write test cases is to start with a similar existing test, save it with a new number and then adjust it to fit. There's an attempt to document the test case file format in the tests/FILEFORMAT. -- cgit v1.2.3