[ctf-testsuite.git] / README.md

ctf-testsuite
=============

The Common Trace Format (CTF) test suite is intended to validate the
conformance of CTF readers.

To run the test suite:

  1. Set the `CTF_READER_BIN` environment variable to your CTF reader
    executable, e.g.:

        export CTF_READER_BIN=my-ctf-reader

  2. Execute the `run.sh` script found in the `tests/x.y` directory,
     where `x.y` is the CTF specification's version you want to check,
     e.g.:

        ( cd tests/1.8 && ./run.sh )

You may also set the `CTF_READER_OPTS` environment variable to options
to pass to the CTF reader defined by `CTF_READER_BIN`.
Commit	Line	Data
d56702a0 PP	1	ctf-testsuite
	2	=============
	3
	4	The Common Trace Format (CTF) test suite is intended to validate the
	5	conformance of CTF readers.
	6
	7	To run the test suite:
	8
	9	1. Set the `CTF_READER_BIN` environment variable to your CTF reader
	10	executable, e.g.:
	11
	12	export CTF_READER_BIN=my-ctf-reader
	13
	14	2. Execute the `run.sh` script found in the `tests/x.y` directory,
	15	where `x.y` is the CTF specification's version you want to check,
	16	e.g.:
	17
	18	( cd tests/1.8 && ./run.sh )
	19
	20	You may also set the `CTF_READER_OPTS` environment variable to options
	21	to pass to the CTF reader defined by `CTF_READER_BIN`.