| < skip and skip_block | Russ Allbery > Software > C TAP Harness | test_cleanup_register > |
(Tell a TAP harness that all of a test case is skipped)
#include <tap/basic.h>
void skip_all(const char *format, ...);
skip_all() tells a TAP harness that all of a test case is being skipped. format may be NULL to give no reason; if format is not NULL, it should be a printf-style format string with optional following arguments that explains the reason why the test case was skipped. skip_all() will print an output line like:
1..0 # skip <reason>
and then exit with an exit status of 0. skip_all() must be called before plan() or plan_lazy(), since it presents an alternative plan to the TAP test harness.
skip_all() should be used if prerequisites for a test case are not met and it would be meaningless to run that test case (if, for example, optional test configuration is not present, or if the test case only applies to a particular platform).
None. skip_all() exits the program with an exit status of 0 when called.
Russ Allbery <eagle@eyrie.org>
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.
SPDX-License-Identifier: FSFAP
plan(3), skip(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/>.
| < skip and skip_block | Russ Allbery > Software > C TAP Harness | test_cleanup_register > |