r29506 - in /trunk/dh-make-perl: dh-make-perl lib/DhMakePerl.pm

gregoa at users.alioth.debian.org gregoa at users.alioth.debian.org
Sat Jan 10 01:10:25 UTC 2009


Author: gregoa
Date: Sat Jan 10 01:10:22 2009
New Revision: 29506

URL: http://svn.debian.org/wsvn/pkg-perl/?sc=1&rev=29506
Log:
minor documentation improvements (typos, capitalizations, ...)

Modified:
    trunk/dh-make-perl/dh-make-perl
    trunk/dh-make-perl/lib/DhMakePerl.pm

Modified: trunk/dh-make-perl/dh-make-perl
URL: http://svn.debian.org/wsvn/pkg-perl/trunk/dh-make-perl/dh-make-perl?rev=29506&op=diff
==============================================================================
--- trunk/dh-make-perl/dh-make-perl (original)
+++ trunk/dh-make-perl/dh-make-perl Sat Jan 10 01:10:22 2009
@@ -12,7 +12,7 @@
 
 =head1 NAME
 
-B<dh-make-perl> - Create debian source packages from perl modules
+B<dh-make-perl> - Create debian source packages from Perl modules
 
 =head1 SYNOPSIS
 
@@ -20,29 +20,29 @@
 
 =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
+
 =item cpan2deb I<DIST> I<options...>
 
-=item dh-make-perl --refresh I<options...>
-
-=item dh-make-perl --refresh-cache
-
-=item dh-make-perl --dump-config
-
 =back
 
 =head1 DESCRIPTION
 
 B<dh-make-perl> will create the files required to build
-a debian source package out of a perl package.
+a debian source package out of a Perl module.
 This works for most simple packages and is also useful
-for getting started with packaging perl modules.
+for getting started with packaging Perl modules.
 
 You can specify a module name with the L<--cpan|/cpan_dist> switch
 and B<dh-make-perl> will download the module for you from
 a CPAN mirror, or you can specify the directory with the
 already unpacked sources. If neither L<--cpan|/cpan_dist> nor a directory
-is given as argument, dh-make-perl tries to create a
-perl package from the data in the current directory.
+is given as argument, B<dh-make-perl> tries to create a
+Perl package from the data in the current directory.
 
 There is an override mechanism in place to handle most of
 the little changes that may be needed for some modules
@@ -52,7 +52,7 @@
 You can build and install the debian package using the L</--build>
 and L</--install> command line switches.
 
-If dh-make-perl is called as
+If B<dh-make-perl> is called as
 
     cpan2deb <options...> Foo-Bar
 
@@ -62,7 +62,7 @@
 
 Using this program is no excuse for not reading the
 debian developer documentation, including the Debian policy,
-the perl policy, the packaging manual and so on.
+the Debian Perl policy, the packaging manual and so on.
 
 =head2 COMMANDS
 
@@ -85,10 +85,10 @@
 
 =item --refresh-cache
 
-dh-make-perl parses the Contents files, fetched by L<apt-file(1)> and stores
+B<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
+the first time you run B<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>.
 
@@ -117,7 +117,7 @@
 
 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
+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>.
@@ -136,8 +136,8 @@
 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.
+B<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>
 
@@ -161,22 +161,22 @@
 =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 
+given, B<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
+Allows building core Perl modules. By default, B<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.
+specifying this option, B<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
+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.
+Instructs B<dh-make-perl> to fetch and extract the given CPAN distribution.
 
 =item B<--cpan-mirror> I<MIRROR>
 
@@ -193,13 +193,13 @@
 =item B<--depends> I<DEPENDS>
 
 Manually specify the string to be used for the module's dependencies. This 
-should be used when building modules where dh-make-perl cannot guess the Perl
+should be used when building modules where B<dh-make-perl> cannot guess the Perl
 dependencies (such as modules built using L<Module::Install>), or when the
-Perl code depends on non-Perl binaries or libraries. Usually, dh-make-perl
-will figure out the dependencies by itself. If you need to pass dh-make-perl
+Perl code depends on non-Perl binaries or libraries. Usually, B<dh-make-perl>
+will figure out the dependencies by itself. If you need to pass B<dh-make-perl>
 dependency information, you must do it using the debian package format. i.e.
 
-dh-make-perl --depends libtest-more-perl 
+    dh-make-perl --depends libtest-more-perl 
 
 =item B<--desc> I<SHORT DESCRIPTION>
 
@@ -260,11 +260,11 @@
 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.
+F<debian/control> accordingly.
 
 =item B<--requiredeps>
 
-Fail if a dependency perl package was not found (dependency tracking
+Fail if a dependency Perl package was not found (dependency tracking
 requires the apt-file package installed and updated)
 
 =item B<--sources-list file>
@@ -286,14 +286,12 @@
 
 Specifies the version of the resulting package.
 
-
-
 =back
 
 =head1 FILES
 
 The following directories will be searched to find additional files
-required by dh-make-perl:
+required by B<dh-make-perl>:
 
 	/usr/share/dh-make-perl/
 	$HOME/.dh-make-perl/
@@ -302,7 +300,8 @@
 
 =item * dh-make-perl.conf
 
-User configuration. The file is in YAML format. The keys are option names, as documented in L</OPTIONS> (without leading I<-->).
+User configuration. The file is in YAML format. The keys are option names,
+as documented in L</OPTIONS> (without leading I<-->).
 
 See the output of C<dh-make-perl --dump-config>, which can also be used for
 population of F<dh-make-perl.conf>.
@@ -357,7 +356,7 @@
 Maintained for a time by Marc Brockschmdit E<lt>marc at dch-faq.deE<gt>.
 
 Now maintained by Gunnar Wolf E<lt>gwolf at gwolf.orgE<gt>, and team-maintained 
-by the Debian pkg-perl team, http://alioth.debian.org/projects/pkg-perl
+by the Debian Perl Group, http://alioth.debian.org/projects/pkg-perl
 
 Patches from:
 

Modified: trunk/dh-make-perl/lib/DhMakePerl.pm
URL: http://svn.debian.org/wsvn/pkg-perl/trunk/dh-make-perl/lib/DhMakePerl.pm?rev=29506&op=diff
==============================================================================
--- trunk/dh-make-perl/lib/DhMakePerl.pm (original)
+++ trunk/dh-make-perl/lib/DhMakePerl.pm Sat Jan 10 01:10:22 2009
@@ -121,7 +121,7 @@
     );
 
     # Help requested? Nice, we can just die! Isn't it helpful?
-    die pod2usage(-message => "See `man (1) dh-make-perl' for details.\n") if $self->cfg->help;
+    die pod2usage(-message => "See `man 1 dh-make-perl' for details.\n") if $self->cfg->help;
     die "CPANPLUS support disabled, sorry" if $self->cfg->cpanplus;
 
     if ( $self->cfg->command eq 'refresh-cache' ) {




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