[libconfig-model-dpkg-perl] 02/03: Updated pod of new files to produce correct man pages
dod at debian.org
dod at debian.org
Mon Jan 12 18:31:53 UTC 2015
This is an automated email from the git hooks/post-receive script.
dod pushed a commit to branch master
in repository libconfig-model-dpkg-perl.
commit 2218fade1d9a7ba748ebcf3006b38793ea6a24d9
Author: Dominique Dumont <dod at debian.org>
Date: Mon Jan 12 19:21:28 2015 +0100
Updated pod of new files to produce correct man pages
---
bin/scan_copyrights | 26 +++++++++-----------------
lib/Config/Model/Dpkg/Copyright.pm | 16 ++++++++++++----
lib/Dpkg/Copyright/Scanner.pm | 10 ++++++----
3 files changed, 27 insertions(+), 25 deletions(-)
diff --git a/bin/scan_copyrights b/bin/scan_copyrights
index 99f1540..0569522 100644
--- a/bin/scan_copyrights
+++ b/bin/scan_copyrights
@@ -11,9 +11,15 @@ __END__
=pod
+=head1 NAME
+
+ scan-copyrights - Scan source file and print lines for debian/copyright files
+
=head1 SYNOPSIS
- scan_copyrights
+ # in source package directory
+ scan-copyrights > debian/copyright.new
+ meld debian/copyright{,.new}
=head1 DESCRIPTION
@@ -32,6 +38,7 @@ license is unknown.
In pan source directory:
+ $ scan-copyright
no info for ./uulib/fptools.h, check manually this file
no info for ./uulib/fptools.c, check manually this file
no info for ./uulib/uustring.h, check manually this file
@@ -61,22 +68,7 @@ In pan source directory:
=head1 SUPPORT
-For support, please check the following resources:
-
-=over
-
-=item *
-
-The config-model users mailing list:
-
- config-model-users at lists.sourceforge.net
-
-=item *
-
-The config-model wiki: L<http://github.com/dod38fr/config-model/wiki>
-
-=back
-
+For support, please contact the author.
=head1 SEE ALSO
diff --git a/lib/Config/Model/Dpkg/Copyright.pm b/lib/Config/Model/Dpkg/Copyright.pm
index d9a2bc1..a71dd93 100644
--- a/lib/Config/Model/Dpkg/Copyright.pm
+++ b/lib/Config/Model/Dpkg/Copyright.pm
@@ -1,5 +1,3 @@
-# ABSTRACT: Fill the File sections of debian/copyright file
-
package Config::Model::Dpkg::Copyright ;
use strict;
@@ -124,8 +122,14 @@ sub update ($self) {
__END__
+
+=head1 NAME
+
+ Config::Model::Dpkg::Copyright - Fill the File sections of debian/copyright file
+
=head1 SYNOPSIS
+ # this modules is used by cme when invoked with this command
$ cme update dpkg-copyright
=head1 DESCRIPTION
@@ -136,10 +140,14 @@ debian/copyright file.
In debian package directory:
-* run 'cme update dpkg-copyright' or 'cme update dpkg'
-* check the result with your favorite VCS diff tool. (you do use
+* run 'cme update dpkg-copyright' or 'cme update dpkg'
+* check the result with your favorite VCS diff tool. (you do use
a VCS for your package files, do you ?)
Note: this command is experimental.
+=head1 AUTHOR
+
+Dominique Dumont <dod at debian.org>
+
=cut
diff --git a/lib/Dpkg/Copyright/Scanner.pm b/lib/Dpkg/Copyright/Scanner.pm
index c168de4..68a8d4c 100644
--- a/lib/Dpkg/Copyright/Scanner.pm
+++ b/lib/Dpkg/Copyright/Scanner.pm
@@ -1,5 +1,3 @@
-# ABSTRACT: Scan fiels to provide copyright data
-
package Dpkg::Copyright::Scanner ;
use strict;
@@ -231,6 +229,10 @@ sub __squash ($h) {
__END__
+=head1 NAME
+
+ Dpkg::Copyright::Scanner - Scan files to provide copyright data
+
=head1 SYNOPSIS
use Dpkg::Copyright::Scanner qw/print_copyright scan_files/;
@@ -244,9 +246,9 @@ __END__
=head1 DESCRIPTION
-This command scans current package directory to extract copyright and
+This modules scans current package directory to extract copyright and
license information. Information are packed in a way to ease review and
-maintenance. Files informations are grouped with wildcards ('*') to reduce
+maintenance. Files information is grouped with wildcards ('*') to reduce
the list of files.
=head1 METHODS
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libconfig-model-dpkg-perl.git
More information about the Pkg-perl-cvs-commits
mailing list