summaryrefslogtreecommitdiff
path: root/dh_testroot
diff options
context:
space:
mode:
Diffstat (limited to 'dh_testroot')
-rwxr-xr-xdh_testroot30
1 files changed, 28 insertions, 2 deletions
diff --git a/dh_testroot b/dh_testroot
index 9192f853..dc36c253 100755
--- a/dh_testroot
+++ b/dh_testroot
@@ -1,6 +1,20 @@
#!/usr/bin/perl -w
-#
-# Checks to make sure you are root.
+
+=head1 NAME
+
+dh_testroot - ensure that a package is built as root
+
+=head1 SYNOPSIS
+
+ dh_testroot [debhelper options]
+
+=head1 DESCRIPTION
+
+dh_testroot simply checks to see if you are root. If not, it exits with an
+error. Debian packages must be built as root, though you can use
+L<fakeroot(1)>
+
+=cut
use strict;
use Debian::Debhelper::Dh_Lib;
@@ -8,3 +22,15 @@ use Debian::Debhelper::Dh_Lib;
if ($< != 0) {
error("You must run this as root (or use fakeroot).");
}
+
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut