freebsd

mirror of https://git.FreeBSD.org/src.git synced 2024-12-11 09:50:12 +00:00

History

Enji Cooper 4fb696d630 atf-sh(3): document atf_init_test_cases(3) fully The function was missing from the NAME/SYNOPSIS sections. Add a manpage link to complete the documentation reference. MFC after: 1 month		2017-06-30 05:49:12 +00:00
..
atf-c	Skip tests depending on coredumps if coredumps are disabled via kern.coredump.	2017-05-16 18:42:44 +00:00
atf-c++	Remove *-api(3) manpages removed in ATF 0.21	2017-03-06 22:18:14 +00:00
atf-sh	atf-sh(3): document atf_init_test_cases(3) fully	2017-06-30 05:49:12 +00:00
doc	Fix grammar warning noted by igor	2017-03-06 21:26:45 +00:00
test-programs	MFV: Import atf-0.21.	2014-11-01 11:17:54 +00:00
atf-c.h	MFV: Import atf-0.21.	2014-11-01 11:17:54 +00:00
atf-c++.hpp	MFV: Import atf-0.21.	2014-11-01 11:17:54 +00:00
AUTHORS
config.h	Don't let ATF call basename() and dirname() in a non-standard way.	2016-06-08 20:54:56 +00:00
COPYING
FREEBSD-upgrade	Fix a typo in the upgrade directions	2014-09-24 06:50:14 +00:00
FREEBSD-Xlist	MFV: Import atf-0.21.	2014-11-01 11:17:54 +00:00
Kyuafile	MFV: Import atf-0.20.	2014-02-14 19:33:16 +00:00
NEWS	MFV: Import atf-0.21.	2014-11-01 11:17:54 +00:00
README	MFV: Import atf-0.20.	2014-02-14 19:33:16 +00:00

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