X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_testversion;h=a17f22e9ffe7f7add9a9f13be7c544bfc10af331;hb=bd8be49df01084337ca320208d1268e79de76bae;hp=8f252146fd6abcc6e1a3de3e2c6285a40e2bc73a;hpb=67b74298f08a3e2b30e43cbcd7cdaccc2e1b1614;p=debhelper.git

diff --git a/dh_testversion b/dh_testversion
index 8f25214..a17f22e 100755
--- a/dh_testversion
+++ b/dh_testversion
@@ -1,9 +1,55 @@
 #!/usr/bin/perl -w
-#
-# Debhelper version check.
+
+=head1 NAME
+
+dh_testversion - ensure that the correct version of debhelper is installed
+
+=cut
 
 use Debian::Debhelper::Dh_Lib;
 use Debian::Debhelper::Dh_Version; # contains the version number of debhelper.
+
+=head1 SYNOPSIS
+
+B<dh_testversion> [S<I<debhelper options>>] [I<operator>] [I<version>]
+
+=head1 DESCRIPTION
+
+Note: This program is deprecated. You should use build dependencies
+instead.
+
+dh_testversion compares the version of debhelper against the version you
+specify, and if the condition is not met, exits with an error message.
+
+You can use this in your debian/rules files if a new debhelper feature is
+introduced, and your package requires that feature to build correctly. Use
+debhelper's changelog to figure out the version you need.
+
+Be sure not to overuse dh_testversion. If debhelper version 9.5
+introduces a new dh_autofixbugs command, and your package uses it, then if
+someone tries to build it with debhelper 1.0, the build will fail anyway when
+dh_autofixbugs cannot be found, so there is no need for you to use
+dh_testversion.
+
+=head1 OPTIONS
+
+=over 4
+
+=item I<operator>
+
+Optional comparison operator used in comparing the versions. If not 
+specified, ">=" is used. For descriptions of the comparison operators, see 
+dpkg --help.
+
+=item I<version>
+
+Version number to compare against the current version of debhelper. If not
+specified, dh_testversion does nothing.
+
+=back
+
+=cut
+
 init();
 
 my($compare, $ver);
@@ -17,7 +63,22 @@ elsif ($#ARGV eq 0) {
 	$ver=shift;
 }
 
+warning("This program is deprecated, you should use build dependencies instead.");
+
 if (defined $compare and defined $ver) {
+	warning("Something like: \"Build-Depends: debhelper ($compare $ver)\"");
 	system('dpkg','--compare-versions',$Debian::Debhelper::Dh_Version::version,$compare,$ver) == 0 ||
 		error("debhelper version $Debian::Debhelper::Dh_Version::version is installed, but a version $compare $ver is needed to build this package.");
 }
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut