nixo
/
guix-devel
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: Add section about the test suite. 

* doc/guix.texi (Running the Test Suite): New section.
This commit is contained in:
Ludovic Courtès 2015-03-19 22:40:21 +01:00
parent a5f6065910
commit ec0339cd42
1 changed files with 40 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/guix.texi
View File

@ -83,6 +83,7 @@ package management tool written for the GNU system.
Installation Installation
* Requirements:: Software needed to build and run Guix. * Requirements:: Software needed to build and run Guix.
* Running the Test Suite:: Testing Guix.
* Setting Up the Daemon:: Preparing the build daemon's environment. * Setting Up the Daemon:: Preparing the build daemon's environment.
* Invoking guix-daemon:: Running the build daemon. * Invoking guix-daemon:: Running the build daemon.
@ -239,6 +240,7 @@ is not covered here. Please see the files @file{README} and
@menu @menu
* Requirements:: Software needed to build and run Guix. * Requirements:: Software needed to build and run Guix.
* Running the Test Suite:: Testing Guix.
* Setting Up the Daemon:: Preparing the build daemon's environment. * Setting Up the Daemon:: Preparing the build daemon's environment.
* Invoking guix-daemon:: Running the build daemon. * Invoking guix-daemon:: Running the build daemon.
@end menu @end menu
@ -295,6 +297,32 @@ located, among other things. The default values for Nix are
Note that @code{--disable-daemon} is not required if Note that @code{--disable-daemon} is not required if
your goal is to share the store with Nix. your goal is to share the store with Nix.
@node Running the Test Suite
@section Running the Test Suite
After a successful @command{configure} and @code{make} run, it is a good
idea to run the test suite. It can help catch issues with the setup or
environment, or bugs in Guix itself---and really, reporting test
failures is a good way to help improve the software. To run the test
suite, type:
@example
make check
@end example
Test cases can run in parallel: you can use the @code{-j} option of
GNU@tie{}make to speed things up. The first run may take a few minutes
on a recent machine; subsequent runs will be faster because the store
that is created for test purposes will already have various things in
cache.
Upon failure, please email @email{bug-guix@@gnu.org} and attach the
@file{test-suite.log} file. When @file{tests/@var{something}.scm}
fails, please also attach the @file{@var{something}.log} file available
in the top-level build directory. Please specify the Guix version being
used as well as version numbers of the dependencies
(@pxref{Requirements}) in your message.
@node Setting Up the Daemon @node Setting Up the Daemon
@section Setting Up the Daemon @section Setting Up the Daemon