Document how to install the test suite.

As part of this, install the tests(7) manual page unconditionally (not only
when WITH_TESTS=yes) so that users that have not yet enabled the build of
the test suite can read details on how to do so.
This commit is contained in:
Julio Merino 2014-04-13 11:35:42 +00:00
parent 0b41d3b0bc
commit e1c6a283f3
2 changed files with 24 additions and 7 deletions

View File

@ -27,12 +27,9 @@ MAN= adding_user.7 \
sprog.7 \
stdint.7 \
sticky.7 \
tests.7 \
tuning.7
.if ${MK_TESTS} != "no"
MAN+= tests.7
.endif
MLINKS= intro.7 miscellaneous.7
MLINKS+= security.7 securelevel.7
MLINKS+= c99.7 c.7

View File

@ -26,7 +26,7 @@
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd March 20, 2014
.Dd April 13, 2014
.Dt TESTS 7
.Os
.Sh NAME
@ -50,12 +50,31 @@ maintenance.
.Pp
The
.Fx
test suite is installed in the
test suite can be found in the
.Pa /usr/tests
hierarchy.
.Pp
This manual page describes how to run the test suite and how to configure
some of its optional features.
.Ss Installing the test suite
The test suite is not yet installed by default as part of
.Fx ,
but this is bound to change during the development of
.Fx 11.0 .
.Pp
If the
.Pa /usr/tests
directory is missing, then you will have to enable the build of the test
suite, rebuild your system and install the results.
You can do so by setting
.Sq WITH_TESTS=yes
in your
.Pa /etc/src.conf
file (see
.Xr src.conf 5
for details)
and rebuilding the system as described in
.Xr build 7 .
.Ss When to run the tests?
Before diving into the details of how to run the test suite, here are some
scenarios in which you should run it:
@ -197,7 +216,8 @@ test suite.
Top-level test suite definition file.
.El
.Sh SEE ALSO
.Xr kyua 1 .
.Xr kyua 1 ,
.Xr build 7
.Sh HISTORY
This test suite first appeared in
.Fx 11.0 .