[libflickr-api-perl] 01/01: Fix doc issues and remove scripts .pl from POD

Alex Muntada alexm at debian.org
Thu Sep 14 23:28:38 UTC 2017


This is an automated email from the git hooks/post-receive script.

alexm pushed a commit to branch master
in repository libflickr-api-perl.

commit a04089c1d36820e636952e347a86005898c15448
Author: Alex Muntada <alexm at alexm.org>
Date:   Fri Sep 15 01:26:52 2017 +0200

    Fix doc issues and remove scripts .pl from POD
    
    Closes: #875835
    Gbp-Dch: ignore
---
 debian/changelog                                   |   7 +
 debian/control                                     |   3 +-
 debian/copyright                                   |   1 +
 debian/patches/fix_pod.patch                       | 194 +++++++++++++++++++++
 .../patches/remove-dot-pl-from-scripts-pod.patch   |  49 ++++++
 debian/patches/series                              |   2 +
 6 files changed, 255 insertions(+), 1 deletion(-)

diff --git a/debian/changelog b/debian/changelog
index 9329549..c8e8c0d 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+libflickr-api-perl (1.28-2) UNRELEASED; urgency=medium
+
+  * Fix POD issues; remove .pl from scripts POD.
+    Closes: #875835
+
+ -- Alex Muntada <alexm at debian.org>  Fri, 15 Sep 2017 00:57:33 +0200
+
 libflickr-api-perl (1.28-1) unstable; urgency=medium
 
   * Team upload
diff --git a/debian/control b/debian/control
index e9f3e74..40b2b5d 100644
--- a/debian/control
+++ b/debian/control
@@ -1,7 +1,8 @@
 Source: libflickr-api-perl
 Maintainer: Debian Perl Group <pkg-perl-maintainers at lists.alioth.debian.org>
 Uploaders: gregor herrmann <gregoa at debian.org>,
-           Xavier Guimard <x.guimard at free.fr>
+           Xavier Guimard <x.guimard at free.fr>,
+           Alex Muntada <alexm at debian.org>
 Section: perl
 Testsuite: autopkgtest-pkg-perl
 Priority: optional
diff --git a/debian/copyright b/debian/copyright
index 5bd2ecc..7d2eac7 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -18,6 +18,7 @@ Copyright: 2007, Jose Luis Rivas <ghostbar38 at gmail.com>
  2009, Nathan Handler <nhandler at debian.org>
  2012-2013, Xavier Guimard <x.guimard at free.fr>
  2015, Lucas Kanashiro <kanashiro.duarte at gmail.com>
+ 2017, Alex Muntada <alexm at debian.org>
 License: Artistic or GPL-1+
 
 License: Artistic
diff --git a/debian/patches/fix_pod.patch b/debian/patches/fix_pod.patch
new file mode 100644
index 0000000..da5c63b
--- /dev/null
+++ b/debian/patches/fix_pod.patch
@@ -0,0 +1,194 @@
+Description: Fix several issues reported by 積丹尼 Dan Jacobson <jidanni at jidanni.org>
+Author: Alex Muntada <alexm at debian.org>
+Bug-Debian: https://bugs.debian.org/875835
+Forwarded: no
+
+--- a/examples/flickr_method_test_echo.pl
++++ b/examples/flickr_method_test_echo.pl
+@@ -7,9 +7,7 @@
+ 
+ =head1 NAME
+ 
+-flickr_method_test_echo.pl
+-
+-an example for using either OAuth or Old School Flickr
++flickr_method_test_echo.pl - example for using either OAuth or Old School Flickr
+ 
+ =cut
+ 
+@@ -32,8 +30,8 @@
+     --secret="de0cafe4feed0242"
+ 
+ Depending on what you specify with B<--use_api> the flickr.test.echo
+-call will use the appropriate parameter set. If B<Flickr::API->new> is
+-called with a consumer_key, OAuth is used. If B<Flickr::API->new> with
++call will use the appropriate parameter set. If C<< Flickr::API->new >> is
++called with a consumer_key, OAuth is used. If C<< Flickr::API->new >> with
+ key the old Flickr Authentication is used.
+ 
+ 
+--- a/script/flickr_dump_stored_config.pl
++++ b/script/flickr_dump_stored_config.pl
+@@ -62,12 +62,11 @@
+ 
+ =head1 SYNOPSIS
+ 
+-C<flickr_dump_stored_config.pl [/path/to/file or --config_in=Config-File_to_dump]>
++  flickr_dump_stored_config.pl [/path/to/file or --config_in=Config-File_to_dump]
+ 
+ =head1 OPTIONS
+ 
+ =head2 Required:
+-B< >
+ 
+ =over 5
+ 
+@@ -75,8 +74,6 @@
+ 
+ =item B<--config_in> pointing to the stored Flickr config file.
+ 
+-B< >
+-
+ =back
+ 
+ =over 5
+@@ -94,7 +91,7 @@
+ This script is a lightweight way to dump the contents of a
+ Flickr::API storable configuration. It does not I<use Flickr::API;> 
+ and sticks to modules from perl core so that it can be used 
+-prior to-- and perhaps in conjunction with-- installation 
++prior to --and perhaps in conjunction with-- installation
+ and testing of the Flickr::API module.
+ 
+ 
+--- a/script/flickr_make_stored_config.pl
++++ b/script/flickr_make_stored_config.pl
+@@ -283,12 +283,11 @@
+ 
+ =head1 SYNOPSIS
+ 
+-C<flickr_make_stored_config.pl --config_out=Config-File_to_build [--config_in=file  --consumer_key=...]>
++  flickr_make_stored_config.pl --config_out=Config-File_to_build [--config_in=file  --consumer_key=...]
+ 
+ =head1 OPTIONS
+ 
+ =head2 Required:
+-B< >
+ 
+ =over 5
+ 
+@@ -298,71 +297,42 @@
+ 
+ =head2 Optional:
+ 
+-
+-B< >
+-
+-
+ =over 5
+ 
+ =item  B<--config_in>   points to the optional input config file to use as a base 
+                         for the I<--config_out> file you are creating.
+ 
+-B< >
+-
+ =item  B<--api_type>  either I<flickr> for the original, but deprecated, Flickr
+                       authentication OR I<oauth> for the OAuth authentication.
+                       it defaults to I<oauth>
+ 
+-B< >
+-
+ I<For Flickr Auth>
+ 
+ =item  B<--api_key> The api key when used with Flickr authentication 
+        I<required for testing> B<--key> still works to maintain compatibility
+        with L<Flickr::API> 1.10 and before, but it is saved as api_key.
+ 
+-B< >
+-
+ =item  B<--secret> The api secret when used with Flickr authentication
+        I<required for testing> B<--secret> still works to maintain compatibility
+        with L<Flickr::API> 1.10 and before, but it is saved as api_secret.
+ 
+-B< >
+-
+ =item  B<--frob>  The frob used in Flickr authentication
+ 
+-B< >
+-
+ =item  B<--token> The auth token can be either a Flickr or OAuth Access token 
+        used with Flickr authentication
+ 
+-B< >
+-
+ I<For OAuth>
+ 
+-
+ =item  B<--consumer_key> The api key when used with OAuth authentication
+        I<required for testing>
+ 
+-B< >
+-
+-
+ =item  B<--consumer_secret> The api secret when used with OAuth authentication
+        I<required for testing>
+ 
+-B< >
+-
+-
+ =item  B<--callback> The callback uri for use in OAuth authentication
+ 
+-B< >
+-
+ =item  B<--token_secret> The OAuth access token secret
+ 
+-B< >
+-
+-B< >
+-
+ =item  B<--help> as expected
+ 
+ =item  B<--usage>
+@@ -394,7 +364,7 @@
+ or
+ 
+   make test MAKETEST_FLICKR_CFG=/home/myusername/test-flickrs-auth.cfg
+- 
++
+ or
+ 
+   make test MAKETEST_FLICKR_CFG=/home/myusername/test-flickrs-auth.cfg \
+--- a/script/flickr_make_test_values.pl
++++ b/script/flickr_make_test_values.pl
+@@ -136,12 +136,11 @@
+ 
+ =head1 SYNOPSIS
+ 
+-C<flickr_make_test_values.pl --values_out=file_to_build [--values_in=existing_file]>
++  flickr_make_test_values.pl --values_out=file_to_build [--values_in=existing_file]
+ 
+ =head1 OPTIONS
+ 
+ =head2 Required:
+-B< >
+ 
+ =over 5
+ 
+@@ -151,17 +150,11 @@
+ 
+ =head2 Optional:
+ 
+-
+-B< >
+-
+-
+ =over 5
+ 
+ =item  B<--values_in>   points to the optional input values file to use as a base 
+                         for the I<--values_out> file you are creating.
+ 
+-B< >
+-
+ =item  B<--help> as expected
+ 
+ =item  B<--usage>
diff --git a/debian/patches/remove-dot-pl-from-scripts-pod.patch b/debian/patches/remove-dot-pl-from-scripts-pod.patch
new file mode 100644
index 0000000..8416603
--- /dev/null
+++ b/debian/patches/remove-dot-pl-from-scripts-pod.patch
@@ -0,0 +1,49 @@
+--- a/script/flickr_dump_stored_config.pl
++++ b/script/flickr_dump_stored_config.pl
+@@ -57,12 +57,12 @@
+ 
+ =head1 NAME
+ 
+-flickr_dump_stored_config.pl - script to display contents of a Flickr::API
++flickr_dump_stored_config - script to display contents of a Flickr::API
+ storable configuration file.
+ 
+ =head1 SYNOPSIS
+ 
+-  flickr_dump_stored_config.pl [/path/to/file or --config_in=Config-File_to_dump]
++  flickr_dump_stored_config [/path/to/file or --config_in=Config-File_to_dump]
+ 
+ =head1 OPTIONS
+ 
+--- a/script/flickr_make_stored_config.pl
++++ b/script/flickr_make_stored_config.pl
+@@ -279,11 +279,11 @@
+ 
+ =head1 NAME
+ 
+-flickr_make_stored_config.pl - script to assist with testing and using the Flickr::API
++flickr_make_stored_config - script to assist with testing and using the Flickr::API
+ 
+ =head1 SYNOPSIS
+ 
+-  flickr_make_stored_config.pl --config_out=Config-File_to_build [--config_in=file  --consumer_key=...]
++  flickr_make_stored_config --config_out=Config-File_to_build [--config_in=file  --consumer_key=...]
+ 
+ =head1 OPTIONS
+ 
+--- a/script/flickr_make_test_values.pl
++++ b/script/flickr_make_test_values.pl
+@@ -132,11 +132,11 @@
+ 
+ =head1 NAME
+ 
+-flickr_make_test_values.pl - script to assist with testing the Flickr::API
++flickr_make_test_values - script to assist with testing the Flickr::API
+ 
+ =head1 SYNOPSIS
+ 
+-  flickr_make_test_values.pl --values_out=file_to_build [--values_in=existing_file]
++  flickr_make_test_values --values_out=file_to_build [--values_in=existing_file]
+ 
+ =head1 OPTIONS
+ 
diff --git a/debian/patches/series b/debian/patches/series
index 9417efd..3eb54b1 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1 +1,3 @@
+fix_pod.patch
+remove-dot-pl-from-scripts-pod.patch
 fix_script_path_autopkgtest.patch

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libflickr-api-perl.git



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