freebsd

mirror of https://git.FreeBSD.org/src.git synced 2024-12-27 11:55:06 +00:00

History

Enji Cooper 1d30387920 atf-c: fix documentation description for atf_utils_wait(3) atf_utils_wait(3) should be used in combination with atf_utils_fork(3), not itself (atf_utils_wait(3)). MFC after: 2 months Sponsored by: Dell EMC Isilon		2017-04-06 03:50:58 +00:00
..
atf-c	atf-c: fix documentation description for atf_utils_wait(3)	2017-04-06 03:50:58 +00:00
atf-c++	Remove *-api(3) manpages removed in ATF 0.21	2017-03-06 22:18:14 +00:00
atf-sh	Remove *-api(3) manpages removed in ATF 0.21	2017-03-06 22:18:14 +00:00
doc	Fix grammar warning noted by igor	2017-03-06 21:26:45 +00:00
test-programs
atf-c.h
atf-c++.hpp
AUTHORS
config.h
COPYING
FREEBSD-upgrade
FREEBSD-Xlist
Kyuafile
NEWS
README

README

Introductory information                        Automated Testing Framework
===========================================================================


Introduction
************

The Automated Testing Framework (ATF) is a collection of libraries to
implement test programs in a variety of languages.  At the moment, ATF
offers C, C++ and POSIX shell bindings with which to implement tests.
These bindings all offer a similar set of functionality and any test
program written with them exposes a consistent user interface.

ATF-based test programs rely on a separate runtime engine to execute them.
The runtime engine is in charge of isolating the test programs from the
rest of the system to ensure that their results are deterministic and that
they cannot affect the running system.  The runtime engine is also
responsible for gathering the results of all tests and composing reports.
The current runtime of choice is Kyua.


Other documents
***************

* AUTHORS: List of authors and contributors for this project.

* COPYING: License information.

* INSTALL: Compilation and installation instructions.  These is not the
  standard document shipped with many packages, so be sure to read it for
  things that are specific to ATF's build.

* NEWS: List of major changes between formal, published releases.


===========================================================================
vim: filetype=text:textwidth=75:expandtab:shiftwidth=2:softtabstop=2