Also fix up one gtkdoc fumble in igt_fb. We should use symbolic defines if possible instead of just listening the magic 0, 77, 78 values for exit codes, but that's a separate patch. Cc: tim.gore@xxxxxxxxx Signed-off-by: Daniel Vetter <daniel.vetter@xxxxxxxx> --- lib/igt_core.c | 23 +++++++++++++++++++++++ lib/igt_fb.c | 1 + 2 files changed, 24 insertions(+) diff --git a/lib/igt_core.c b/lib/igt_core.c index 6f137ab93ad4..7996fa45e2e6 100644 --- a/lib/igt_core.c +++ b/lib/igt_core.c @@ -173,6 +173,29 @@ * - For general coding style issues please follow the kernel's rules laid out * in * [CodingStyle](https://www.kernel.org/doc/Documentation/CodingStyle). + * + * # Interface with Testrunners + * + * i-g-t testcase are all executables which should be run as root on an + * otherwise completely idle system. The test status is reflected in the + * exitcode. 0 means "success", 77 "skip", 78 that some operation "timed out". + * All other exit codes encode a failed test result, including any abnormal + * termination of the test (e.g. by SIGKILL). + * + * On top of that tests may report unexpected results and minor issues to + * stderr. If stderr is non-empty the test result should be treated as "warn". + * + * The test lists are generated at build time. Simple testcases are listed in + * tests/single-tests.txt and tests with subtests are listed in + * tests/multi-tests.txt. When running tests with subtest from a test runner it + * is recommend to run each subtest individually, since otherwise the return + * code will only reflect the overall result. + * + * To do that obtain the lists of subtests with "--list-subtests", which can be + * run as non-root and doesn't require the i915 driver to be loaded (or any + * intel gpu to be present). Then individual subtests can be run with + * "--run-subtest". Usage help for tests with subtests can be obtained with the + * "--help" commandline option. */ static unsigned int exit_handler_count; diff --git a/lib/igt_fb.c b/lib/igt_fb.c index 29a12c6cc640..2149fcd09d90 100644 --- a/lib/igt_fb.c +++ b/lib/igt_fb.c @@ -544,6 +544,7 @@ cairo_t *igt_get_cairo_ctx(int fd, struct igt_fb *fb) } /** + * igt_write_fb_to_png: * @fd: open i915 drm file descriptor * @fb: pointer to an #igt_fb structure * @filename: target name for the png image -- 1.9.2 _______________________________________________ Intel-gfx mailing list Intel-gfx@xxxxxxxxxxxxxxxxxxxxx http://lists.freedesktop.org/mailman/listinfo/intel-gfx
