X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_auto_test;h=9d3fd93c56e738a0ba4ecc98e67322f8aae63d80;hb=18a0da8092ea9f3dc48bca92b36f592af25a608d;hp=062563fd7d8db3ade4fb238ce580be96d11658f9;hpb=962a2e10c930e3504ea1c0327be2fdf70d53023e;p=debhelper.git

diff --git a/dh_auto_test b/dh_auto_test
index 062563f..9d3fd93 100755
--- a/dh_auto_test
+++ b/dh_auto_test
@@ -2,55 +2,54 @@
 
 =head1 NAME
 
-dh_auto_test - run package test suites after building
+dh_auto_test - automatically runs a package's test suites
 
 =cut
 
 use strict;
+use Debian::Debhelper::Dh_Lib;
 use Debian::Debhelper::Dh_Buildsystems;
 
 =head1 SYNOPSIS
 
-B<dh_auto_test> [S<I<debhelper options>>] [S<I<dh_auto options>>] [S<B<--> I<params>>]
+B<dh_auto_test> [S<I<build system options>>] [S<I<debhelper options>>] [S<B<--> I<params>>]
 
 =head1 DESCRIPTION
 
-dh_auto_test is a debhelper program that is responsible for the I<test> step of
-the L<dh_auto(7)> building process. Typically, this is the point when package
-test suite is run to check if the sources were built successfully and/or
-binaries provide expected functionality. dh_auto_test will fail if test suite
-fails.  However, if there's no test suite, it will exit with zero status
-without doing anything.
+B<dh_auto_test> is a debhelper program that tries to automatically run a
+package's test suite. It does so by running the appropriate command for the
+build system it detects the package uses. For example, if there's a
+Makefile and it contains a B<test> or B<check> target, then this is done by
+running B<make> (or B<MAKE>, if the environment variable is set). If the test
+suite fails, the command will exit nonzero. If there's no test suite, it
+will exit zero without doing anything.
 
-If dh_auto_test does not meet your needs or does not work, it is safe to
-skip/override it entirely and just run the test suite manually.
-
-=head1 NOTES
-
-If the DEB_BUILD_OPTIONS environment variable contains "nocheck", no tests will
-be performed.
-
-#DH_AUTO SHARED OPTIONS#
+This is intended to work for about 90% of packages with a test suite. If it
+doesn't work, you're encouraged to skip using B<dh_auto_test> at all, and
+just run the test suite manually.
 
 =head1 OPTIONS
 
+See L<debhelper(7)/B<BUILD SYSTEM OPTIONS>> for a list of common build
+system selection and control options.
+
 =over 4
 
 =item B<--> I<params>
 
-Pass "params" to the program that is run. These can be used to supplement
-or override the any standard parameters that dh_auto_test passes.
+Pass I<params> to the program that is run, after the parameters that
+B<dh_auto_test> usually passes.
 
 =back
 
-=head1 SUPPORTED BUILD SYSTEMS
+=head1 NOTES
 
-#SUPPORTED BUILD SYSTEMS INTRO#
-#SUPPORTED BUILD SYSTEMS LIST#
+If the B<DEB_BUILD_OPTIONS> environment variable contains B<nocheck>, no
+tests will be performed.
 
 =cut
 
-if (defined $ENV{DEB_BUILD_OPTIONS} && $ENV{DEB_BUILD_OPTIONS} =~ /nocheck/) {
+if (get_buildoption("nocheck")) {
 	exit 0;
 }
 
@@ -59,16 +58,12 @@ buildsystems_do();
 
 =head1 SEE ALSO
 
-L<dh_auto(7)>
-
 L<debhelper(7)>
 
-This program is a part of debhelper and its dh_auto package source building
-suite.
+This program is a part of debhelper.
 
-=head1 AUTHORS
+=head1 AUTHOR
 
- Joey Hess <joeyh@debian.org>
- Modestas Vainius <modestas@vainius.eu>
+Joey Hess <joeyh@debian.org>
 
 =cut