[pkg-perl-tools] 02/04: forward: add POD on email fallback and relevant config

[Florian Schlichting]

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

fsfs pushed a commit to branch master
in repository pkg-perl-tools.

commit aeb0a481b88fef065e03892538e1d43f379a4a2e
Author: Florian Schlichting <fsfs at debian.org>
Date:   Mon Nov 28 00:49:26 2016 +0100

    forward: add POD on email fallback and relevant config
---
 scripts/forward | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/scripts/forward b/scripts/forward
index 2dce65c..2789e51 100755
--- a/scripts/forward
+++ b/scripts/forward
@@ -98,7 +98,9 @@ is mandatory for B<github>.
 
 =item B<--use-mail>
 
-Send bug and patch submissions by e-mail instead.
+Send bug and patch submissions by e-mail instead of creating an issue
+or pull request via API. As the resulting ticket URL is not known to
+B<dpt forward>, it cannot mark patch and bug as forwarded.
 
 =item B<--mailto> I<address>
 
@@ -113,6 +115,31 @@ fail for any reason. Defaults to false.
 
 =back
 
+=head1 FILES
+
+=over
+
+=item ~/.pause
+
+Your pause credentials. At least B<user> and B<password> are needed in order
+to create tickets on rt.cpan.org via REST API. B<dpt forward> will fall back
+to email (slower, won't mark patches and bugs forwarded) otherwise.
+
+=back
+
+=head1 ENVIRONMENT
+
+=over
+
+=item DPT_GITHUB_OAUTH
+
+In order to perform github operations, DPT_GITHUB_OAUTH must be set.
+See L<dpt-github-oauth(1)> on how to obtain an access token for your
+github account, and L<dpt-config(5)> on storing settings permanently
+in dpt.conf.
+
+=back
+
 =cut
 
 $| = 1;

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