Debian Codegraph @

README

raw
1 NAME
2 Dist::Zilla::Plugin::Bugtracker - Automatically sets the bugtracker URL
3 and mailto
4
5 VERSION
6 version 1.111080
7
8 SYNOPSIS
9 In "dist.ini":
10
11 [Bugtracker]
12
13 DESCRIPTION
14 This plugin sets the distribution's bugtracker URL and possibly the
15 email address as metadata. You can set the "web" and the "mailto" values
16 independently in the plugin configuration.
17
18 METHODS
19 web
20 This is the bugtracker URL. It defaults to the CPAN RT URL, so it
21 equivalent to:
22
23 [Bugtracker]
24 web = http://rt.cpan.org/Public/Dist/Display.html?Name=%s
25
26 See "interpolate()" for more information.
27
28 mailto
29 This is the optional email address to which bug reports can be sent. If
30 the CPAN RT bugtracker is used, the email address defaults to "bug-%l at
31 rt.cpan.org" - see "interpolate()" for what this means.
32
33 If a different bugtracker URL is used, the email address is only
34 included in the metadata if it is explicitly given.
35
36 In the following examples, assume that the distribution is called
37 "Foo-Bar".
38
39 Example 1:
40
41 [Bugtracker]
42
43 will produce the defaults:
44
45 web: http://rt.cpan.org/Public/Dist/Display.html?Name=Foo-Bar
46 mailto: bug-foo-bar at rt.cpan.org
47
48 Example 2:
49
50 To suppress the "mailto" from example 1, use:
51
52 [Bugtracker]
53 mailto =
54
55 Example 3:
56
57 [Bugtracker]
58 web = http://github.com/me/%s/issues
59
60 will only produce a "web" entry, but not a "mailto" entry:
61
62 web: http://github.com/me/Foo-Bar/issues
63
64 Example 4:
65
66 [Bugtracker]
67 mailto = [email protected]
68
69 will produce:
70
71 web: http://rt.cpan.org/Public/Dist/Display.html?Name=Foo-Bar
72 mailto: [email protected]
73
74 Example 5:
75
76 [Bugtracker]
77 web = http://github.com/me/%s/issues
78 mailto = bug-%[email protected]
79
80 will only produce a "web" entry, but not a "mailto" entry:
81
82 web: http://github.com/me/Foo-Bar/issues
83 mailto: [email protected]
84
85 See CPAN::Meta::Spec
86 <http://search.cpan.org/dist/CPAN-Meta/lib/CPAN/Meta/Spec.pm#resources>
87 for more information.
88
89 interpolate
90 Both the "web" and "mailto" strings are interpolated as follows:
91
92 %s The distribution name as is (e.g., 'Foo-Bar')
93 %l The distribution name in lowercase (e.g., 'foo-bar')
94 %U The distribution name in uppercase (e.g., 'FOO-BAR')
95 %% A literal '%' sign
96
97 metadata
98 Sets the bugtracker URL and possibly email address in the distribution's
99 metadata.
100
101 INSTALLATION
102 See perlmodinstall for information and options on installing Perl
103 modules.
104
105 BUGS AND LIMITATIONS
106 No bugs have been reported.
107
108 Please report any bugs or feature requests through the web interface at
109 <http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Bugt
110 racker>.
111
112 AVAILABILITY
113 The latest version of this module is available from the Comprehensive
114 Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a
115 CPAN site near you, or see
116 <http://search.cpan.org/dist/Dist-Zilla-Plugin-Bugtracker/>.
117
118 The development version lives at
119 <http://github.com/hanekomu/Dist-Zilla-Plugin-Bugtracker> and may be
120 cloned from
121 <git://github.com/hanekomu/Dist-Zilla-Plugin-Bugtracker.git>. Instead of
122 sending patches, please fork this project using the standard git and
123 github infrastructure.
124
125 AUTHOR
126 Marcel Gruenauer <[email protected]>
127
128 COPYRIGHT AND LICENSE
129 This software is copyright (c) 2010 by Marcel Gruenauer.
130
131 This is free software; you can redistribute it and/or modify it under
132 the same terms as the Perl 5 programming language system itself.
133