ocarina/design/test.txt
Bryan Schumaker a190047648 design: Add unit test library documentation
This will make it easier to keep track of what functions are available.

Signed-off-by: Bryan Schumaker <bjschuma@gmail.com>
2014-04-06 19:56:52 -04:00

20 lines
488 B
Plaintext

== Files ==
ocarina/include/
test.h
ocarina/lib/
test.cpp
== Depends ==
install
Test framework: (lib/test.cpp)
Unit tests will require a basic framework for manipulating files and
directories in the filesystem. Compiling the tests/ directory will
enable the CONFIG_TEST option, which in turn compiles the test library.
API:
void rm_test_config()
Remove the $XDG_CONFG_HOME/ocarina-test/ directory.
void rm_test_data()
Remove the $XDG_DATA_HOME/ocarina-test/ directory.