test: update README
* test/README: Tell the reader what this directory is actually for.
This commit is contained in:
parent
ec5480453b
commit
f9390b96f4
13
test/README
13
test/README
@ -1,20 +1,21 @@
|
||||
This directory contains some manual tests.
|
||||
This directory contains some corner case demo files. Most of them are
|
||||
quite old and probably will be of little interest to the casual reader.
|
||||
For automated tests, see ../tests/.
|
||||
|
||||
To run a test:
|
||||
To run a demo:
|
||||
* Run make
|
||||
* Run resulting executable(s) under strace
|
||||
* Check strace output and/or program's output and exitcode
|
||||
|
||||
To add a new test:
|
||||
To add a new demo:
|
||||
* Add its .c source to this dir
|
||||
* Add it to "all" and "clean" targets in Makefile
|
||||
* Add it to .gitignore file
|
||||
|
||||
Please spend some time making your testcase understandable.
|
||||
Please spend some time making your demo understandable.
|
||||
For example, it may print an explanation how it should be used
|
||||
(which strace options to use, and what to look for in strace output).
|
||||
|
||||
If possible, make it so that your testcase detects error/bug
|
||||
it is intended to test for, and prints error message and exits with 1
|
||||
If possible, make it so that your demo detects error/bug
|
||||
it is intended to demonstrate, and prints error message and exits with 1
|
||||
if the bug is detected, instead of relying on user to peruse strace output.
|
||||
|
Loading…
x
Reference in New Issue
Block a user