r29491 - /trunk/dh-make-perl/dh-make-perl

dmn at users.alioth.debian.org dmn at users.alioth.debian.org
Fri Jan 9 14:24:38 UTC 2009


Author: dmn
Date: Fri Jan  9 14:24:36 2009
New Revision: 29491

URL: http://svn.debian.org/wsvn/pkg-perl/?sc=1&rev=29491
Log:
document all commands and separate them from the options

Modified:
    trunk/dh-make-perl/dh-make-perl

Modified: trunk/dh-make-perl/dh-make-perl
URL: http://svn.debian.org/wsvn/pkg-perl/trunk/dh-make-perl/dh-make-perl?rev=29491&op=diff
==============================================================================
--- trunk/dh-make-perl/dh-make-perl (original)
+++ trunk/dh-make-perl/dh-make-perl Fri Jan  9 14:24:36 2009
@@ -16,11 +16,53 @@
 
 =head1 SYNOPSIS
 
-B<dh-make-perl> [B<SOURCE_DIR> | B<--cpan> I<MODULE>]
-
-B<dh-make-perl> B<--refresh>
-
-You can modify B<dh-make-perl>'s behaviour with some switches:
+=over
+
+=item dh-make-perl [--make] {I<SOURCE_DIR> | --cpan I<MODULE>} I<options...>
+
+=item dh-make-perl --refresh I<options...>
+
+=item dh-make-perl --refresh-cache
+
+=item dh-make-perl --dump-config
+
+=back
+
+=head2 COMMANDS
+
+=over
+
+=item --make
+
+Default command if no command is given. Needs a source directory given as
+argument to the command line or the B<--cpan> option. Adds debianisation to
+upstream sources.
+
+=item --refresh
+
+To be run inside unpacked source package. Rebuilds F<debian/copyright>,
+F<debian/rules>, F<debian/compat> and adjusts the debhelper dependency in
+F<debian/control>.
+
+=item --refresh-cache
+
+dh-make-perl parses the Contents files, fetched by L<apt-file(1)> and stores
+the result in a cache. The cache is refreshed automatically if it is older than
+any Contents file. However, if you run L<apt-file(1)> in your nightly cron job,
+the first time you run C<dh-make-perl> during the day, you shall wait for the
+cache to be reconstructed. With this option, you can move the cache re-creation
+to the cron job, right after C<apt-file update>.
+
+=item --dump-config
+
+Causes the current config, including any default settings to be printed to the
+standard output.
+
+Useful for populating L<dh-make-perl.conf> file.
+
+=over
+
+=head2 OPTIONS
 
 =over
 
@@ -215,12 +257,12 @@
 Refresh the APT contents cache. If there is no change in the Contents files,
 does nothing. Useful after C<apt-file update> in your crontab.
 
-=back
-
 =item B<--dump-config>
 
 Print the configuration to STDOUT. Useful for initial population of
 F<dh-make-perl.conf> file.
+
+=back
 
 =head1 DESCRIPTION
 




More information about the Pkg-perl-cvs-commits mailing list