X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_testdir;h=8e12489a0f28c2c6a3cff26a53e001e3eba5cd0c;hb=e2a6d4cec4a7ee952cf6a7f250d80f1d75a38f95;hp=3ba39e24bdfbfeee5acde2d0929c7b395bc2fa27;hpb=e446e8308e654785721d8036a1d53633207053f0;p=debhelper.git

diff --git a/dh_testdir b/dh_testdir
index 3ba39e2..8e12489 100755
--- a/dh_testdir
+++ b/dh_testdir
@@ -1,15 +1,54 @@
 #!/usr/bin/perl -w
-#
-# Checks to make sure we are building the package in the right directory.
-# Tests for the existance of debian/control, and for the existance
-# of any other files you specify on the command line.
+
+=head1 NAME
+
+dh_testdir - test directory before building Debian package
+
+=cut
 
 use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_testdir> [S<I<debhelper options>>] [S<I<file> ...>]
+
+=head1 DESCRIPTION
+
+B<dh_testdir> tries to make sure that you are in the correct directory when
+building a Debian package. It makes sure that the file F<debian/control>
+exists, as well as any other files you specify. If not,
+it exits with an error.
+
+=head1 OPTIONS
+
+=over 4
+
+=item I<file> ...
+
+Test for the existence of these files too.
+
+=back
+
+=cut
+
 init();
+inhibit_log();
 
 foreach my $file ('debian/control', @ARGV) {
 	if (! -e $file) {
 		error("\"$file\" not found. Are you sure you are in the correct directory?");
 	}
 }
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut