[pkg-perl-tools] 01/03: Slightly improve documentation about DPT_* variables, dpt-config, and dpt.conf

[gregor herrmann]

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

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

commit a26fecec3e0f8f84f454da8bee80cee987bab6c1
Author: gregor herrmann <gregoa at debian.org>
Date:   Thu Jan 25 16:37:49 2018 +0100

    Slightly improve documentation about DPT_* variables, dpt-config, and dpt.conf
    
    in various scripts.
---
 scripts/github-oauth  | 6 +++---
 scripts/invite-github | 4 ++++
 scripts/takeover      | 2 +-
 3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/scripts/github-oauth b/scripts/github-oauth
index 7280ff9..372739b 100755
--- a/scripts/github-oauth
+++ b/scripts/github-oauth
@@ -24,7 +24,7 @@ dpt-github-oauth - Generate GitHub OAuth2 token
 B<dpt github-oauth> can be used for obtaining an OAuth2 token for
 authenticating to GitHub services without the need to enter your password on
 every request. The reason for this script is to allow you to populate the
-C<DPT_GITHUB_OAUTH> setting in F<dpt.conf> easily.
+C<DPT_GITHUB_OAUTH> setting in F<dpt.conf> or F<~/.config/dpt.conf> easily.
 
 You cannot obtain an OAuth2 token with this script if you have two-factor
 authentication (2FA) enabled on GitHub.
@@ -80,8 +80,8 @@ my $o = $oauth->create_authorization(
 );
 
 print <<EOF;
-The following line may be added to ~/.config/dpt.conf to allow dpt
-to identify as yourself before GitHub:
+The following line may be added to ~/.config/dpt.conf or ~/.config/dpt.conf
+to allow dpt to identify as yourself before GitHub:
 
  DPT_GITHUB_OAUTH=$o->{token}
 
diff --git a/scripts/invite-github b/scripts/invite-github
index 5a44214..53555a4 100755
--- a/scripts/invite-github
+++ b/scripts/invite-github
@@ -21,6 +21,10 @@ B<dpt invite-github> can be used for inviting people to become members
 of a GitHub organization. You can set the organization name through
 C<DPT_GITHUB_ORGNAME> environment variable (defaults to I<pkg-perl-tools>).
 
+This script needs the C<DPT_GITHUB_OAUTH> environment variable,
+which can be set in F<~/.dpt.conf> or F<~/.config/dpt.conf>.
+Cf. L<dpt-github-oauth(1)> and L<dpt-config(5)>.
+
 You need to have write access to the C<admin:org> scope to be able to
 manage organization memberships. Please, make sure the token you use
 has that scope in L<https://github.com/settings/tokens>.
diff --git a/scripts/takeover b/scripts/takeover
index 79980a9..81a73f9 100755
--- a/scripts/takeover
+++ b/scripts/takeover
@@ -20,7 +20,7 @@ Usage: $BN [options] package...
 
 Options:
     -t path     Top location of local repository clones (containing packages/)
-                Required. Defaults to the DPT_PACKAGES setting
+                Required. Defaults to the DPT_PACKAGES setting. Cf. dpt-config(5)
     -m URL      URL to a message in which the previous maintainer requests the
                 takeover
     -a #        RFA/ITA bug number (conflicts with -m)

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