skip, skip_block

(Skip a TAP test)

SYNOPSIS

#include <tap/basic.h>

void skip(const char *reason, ...);

void skip_block(unsigned long count, const char *reason, ...);

DESCRIPTION

skip() marks the next test as skipped. reason may be NULL; if not NULL, reason should be a printf-style format string with optional additional arguments specifying the reason why the test was skipped. Common reasons to skip tests include tests that are not applicable to the current platform, environment, or software configuration options, and tests that rely on optional test configuration that isn't present.

skip_block() is identical to skip() except that it marks the next count tests as skipped.

To skip an entire test case, call skip_all() before plan() or plan_lazy() rather than using these functions.

RETURN VALUE

None.

CAVEATS

plan() or plan_lazy() should always be called before calling skip() or skip_block().

AUTHOR

Russ Allbery <eagle@eyrie.org>

COPYRIGHT AND LICENSE

Copyright 2010, 2013 Russ Allbery <eagle@eyrie.org>

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty.

SEE ALSO

ok(3), plan(3), skip_all(3)

The current version of the C TAP Harness library is available from its web page at <https://www.eyrie.org/~eagle/software/c-tap-harness/>.

Last spun 2016-11-05 from POD modified 2016-10-26