r29496 - /trunk/dh-make-perl/dh-make-perl

Fri Jan 9 15:08:40 UTC 2009

Author: dmn
Date: Fri Jan  9 15:08:38 2009
New Revision: 29496

URL: http://svn.debian.org/wsvn/pkg-perl/?sc=1&rev=29496
Log:
POD: reorder options alphabetically

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=29496&op=diff
==============================================================================

--- trunk/dh-make-perl/dh-make-perl (original)
+++ trunk/dh-make-perl/dh-make-perl Fri Jan  9 15:08:38 2009
@@ -98,35 +98,88 @@
 
 =over
 
-=item B<--desc> I<SHORT DESCRIPTION>
-
-Uses the argument to --desc as short description for the package.
-
 =item B<--arch> I<any> | I<all>
 
 This switches between arch-dependent and arch-independet packages. If B<--arch>
 isn't used, B<dh-make-perl> uses a relatively good-working algorithms to
 decide this alone.
 
-=item B<--version> I<VERSION>
-
-Specifies the version of the resulting package.
-
-=item B<--email> | B<-e> I<EMAIL>
-
-Manually specify the Maintainer email address to use in debian/control and
-in debian/changelog.
-
-=item B<--packagename> | B<-p> I<PACKAGENAME>
-
-Manually specify the Package Name, useful when the module has dashes in its
-name.
+=item B<--basepkgs>
+
+Explicitly gives a comma-separated list of packages to consider "base"
+packages (i.e. packages that should always be available in Debian
+systems). This option defaults to C<perl,perl-base,perl-modules> - It
+is used to check for module dependencies. If a needed module is in the
+C<basepkgs>, it won't be mentioned in the C<depends:> field of
+C<debian/control>.
+
+If this option is specified, the above mentioned default packages will
+not be included (but will be mentioned as explicit dependencies in the
+resulting package). You can, of course, mention your own modules
+and explicitly specify the default values.
+
+Note that this option should be used sparsingly and with care, as it
+might lead to packages not being rebuildable because of unfulfilled
+dependencies.
+
+=item B<--bdepends> I<BUILD-DEPENDS>
+
+Manually specify the string to be used for the module's build-dependencies
+(that is, the packages and their versions that have to be installed in order to
+successfully build the package). Keep in mind that packages generated by
+dh-make-perl require debhelper to be specified as a build dependency. Same note
+as for --depends applies here - Use only when needed.
+
+=item B<--bdependsi> I<BUILD-DEPENDS-INDEP>
+
+Manually specify the string to be used for the module's build-dependencies
+for architecture-independent builds. Same notes as those for the --depends 
+and --bdepends options apply here.
+
+Note that for --depends, --bdepends and --bdependsi you can also specify that
+the field should not appear in debian/rules (if you really mean it, of course
+;-) ) by giving it an empty string as an argument.
+
+=item B<--build>
+
+Builds the package after setting it up.
+
+NB: This builds only a binary package (by calling "fakeroot debian/rules
+binary") and does not sign the package. It is meant for a quick local
+install of a package, not for creating a package ready for submission to the
+Debian archive.
 
 =item B<--closes> I<ITPBUG>
 
 Manually specify the ITP bug number that this package closes. If not 
 given, dh-make-perl will try to connect to bugs.debian.org to fetch the 
 appropriate bug number, using WWW::Mechanize.
+
+=item B<--core-ok>
+
+Allows building core Perl modules. By default, dh-make-perl will not allow
+building a module that is shipped as part of the standard Perl library; by
+specifying this option, dh-make-perl will build them anyway.
+
+Note that, although it is not probable, this might break unrelated items in 
+your system - If a newer version of a core module breaks the API, all kinds
+of daemons might get upset ;-)
+
+=item --cpan I<DIST>
+
+Instructs dh-make-perl to fetch and extract the given CPAN distribution.
+
+=item B<--cpan-mirror> I<MIRROR>
+
+Specifies a CPAN site to use as mirror.
+
+=item B<--data-dir directory>
+
+Use another data directory, instead of the default, C</usr/share/dh-make-perl>
+
+Data directory is were B<dh-make-perl> looks for its default rules.* templates.
+It is similar to B<--home-dir>, but does not change the location of the APT
+Contents cache file. If both are given, B<--home-dir> takes precedence.
 
 =item B<--depends> I<DEPENDS>
 
@@ -139,39 +192,30 @@
 
 dh-make-perl --depends libtest-more-perl 
 
-=item B<--bdepends> I<BUILD-DEPENDS>
-
-Manually specify the string to be used for the module's build-dependencies
-(that is, the packages and their versions that have to be installed in order to
-successfully build the package). Keep in mind that packages generated by
-dh-make-perl require debhelper to be specified as a build dependency. Same note
-as for --depends applies here - Use only when needed.
-
-=item B<--bdependsi> I<BUILD-DEPENDS-INDEP>
-
-Manually specify the string to be used for the module's build-dependencies
-for architecture-independent builds. Same notes as those for the --depends 
-and --bdepends options apply here.
-
-Note that for --depends, --bdepends and --bdependsi you can also specify that
-the field should not appear in debian/rules (if you really mean it, of course
-;-) ) by giving it an empty string as an argument.
-
-=item B<--pkg-perl>
-
-Useful when preparing a package for the Debian Perl Group
-L<http://pkg-perl.alioth.debian.org>.
-
-Sets C<Maintainer>, C<Uploaders>, C<Vcs-Svn> and C<Vcs-Browser> fields in
-debian/control accordingly, and sets packaging-related licensing to GPLv2.
-
-=item --cpan I<DIST>
-
-Instructs dh-make-perl to fetch and extract the given CPAN distribution.
-
-=item B<--cpan-mirror> I<MIRROR>
-
-Specifies a CPAN site to use as mirror.
+=item B<--desc> I<SHORT DESCRIPTION>
+
+Uses the argument to --desc as short description for the package.
+
+=item B<--dh ver>
+
+Set desired debhelper version. If C<ver> is 7, generated debian/rules is
+minimalistic, using the auto-mode of debhelper. Also, any additional
+documentation and examples are listed in additional files under debian/, instead
+of being listed in debian/rules
+
+=item B<--dist pattern>
+
+Limit the distributions whose C<Contents> files are parsed. The argument is a shell pattern.
+
+Default: C<{sid,unstable}>.
+
+Example:
+    dh-make-perl --dist etch
+
+=item B<--email> | B<-e> I<EMAIL>
+
+Manually specify the Maintainer email address to use in debian/control and
+in debian/changelog.
 
 =item B<--exclude> | B<-i> [I<REGEX>]
 
@@ -180,64 +224,39 @@
 - not specifying the switch will include everything), it defaults to exclude
 CVS and .svn directories.
 
-=item B<--build>
-
-Builds the package after setting it up.
-
-NB: This builds only a binary package (by calling "fakeroot debian/rules
-binary") and does not sign the package. It is meant for a quick local
-install of a package, not for creating a package ready for submission to the
-Debian archive.
-
 =item B<--install>
 
 Installs the freshly built package. Specifying --install implies --build - The
 package will not be installed unless it was built (obviously ;-) )
 
+=item B<--home-dir directory>
+
+Where user overrides and APT Contents cache is stored.
+
+Default: ~/.dh-make-perl
+
 =item B<--notest>
 
 Does not run the automatic testing of the module as part of the build script.
 This is mostly useful when packaging buggy or incomplete software.
 
-=item B<--basepkgs>
-
-Explicitly gives a comma-separated list of packages to consider "base"
-packages (i.e. packages that should always be available in Debian
-systems). This option defaults to C<perl,perl-base,perl-modules> - It
-is used to check for module dependencies. If a needed module is in the
-C<basepkgs>, it won't be mentioned in the C<depends:> field of
-C<debian/control>.
-
-If this option is specified, the above mentioned default packages will
-not be included (but will be mentioned as explicit dependencies in the
-resulting package). You can, of course, mention your own modules
-and explicitly specify the default values.
-
-Note that this option should be used sparsingly and with care, as it
-might lead to packages not being rebuildable because of unfulfilled
-dependencies.
+=item B<--packagename> | B<-p> I<PACKAGENAME>
+
+Manually specify the Package Name, useful when the module has dashes in its
+name.
+
+=item B<--pkg-perl>
+
+Useful when preparing a package for the Debian Perl Group
+L<http://pkg-perl.alioth.debian.org>.
+
+Sets C<Maintainer>, C<Uploaders>, C<Vcs-Svn> and C<Vcs-Browser> fields in
+F<debian/control> accordingly, and sets packaging-related licensing to GPLv2.
 
 =item B<--requiredeps>
 
 Fail if a dependency perl package was not found (dependency tracking
 requires the apt-file package installed and updated)
-
-=item B<--core-ok>
-
-Allows building core Perl modules. By default, dh-make-perl will not allow
-building a module that is shipped as part of the standard Perl library; by
-specifying this option, dh-make-perl will build them anyway.
-
-Note that, although it is not probable, this might break unrelated items in 
-your system - If a newer version of a core module breaks the API, all kinds
-of daemons might get upset ;-)
-
-=item B<--dh ver>
-
-Set desired debhelper version. If C<ver> is 7, generated debian/rules is
-minimalistic, using the auto-mode of debhelper. Also, any additional
-documentation and examples are listed in additional files under debian/, instead
-of being listed in debian/rules
 
 =item B<--sources-list file>
 
@@ -248,34 +267,17 @@
 
 Default: C</etc/aptp/sources.list>
 
-=item B<--dist pattern>
-
-Limit the distributions whose C<Contents> files are parsed. The argument is a shell pattern.
-
-Default: C<{sid,unstable}>.
-
-Example:
-    dh-make-perl --dist etch
-
 =item B<--verbose> | B<--no-verbose>
 
 Print additional information while processing.
 
 Default: C<--verbose>
 
-=item B<--home-dir directory>
-
-Where user overrides and APT Contents cache is stored.
-
-Default: ~/.dh-make-perl
-
-=item B<--data-dir directory>
-
-Use another data directory, instead of the default, C</usr/share/dh-make-perl>
-
-Data directory is were B<dh-make-perl> looks for its default rules.* templates.
-It is similar to B<--home-dir>, but does not change the location of the APT
-Contents cache file. If both are given, B<--home-dir> takes precedence.
+=item B<--version> I<VERSION>
+
+Specifies the version of the resulting package.
+
+
 
 =back
 


