If you're gonna be distributing your module on CPAN, you should be aware of the following CPAN FAQ item
Use http://rt.cpan.org/ to open a bug ticket...
and I'd like to point out that you can also report bugs via RT by sending email to
bug-Distribution-Name#rt.cpan.org (# used in place of @ like on rt.cpan.org).
For example, if you wanted to send a bug report for PPM::Repositories
(for example you've discovered a new ppm repository you want added to the list),
you would send mail to
bug-PPM-Repositories#rt.cpan.org
So if you're releasing something on CPAN, it's not a bad idea to add the following to your pod
(replace the parts in bold with appropriate info)
=head1 BUGS
To report bugs, go to
E<lt>http://rt.cpan.org/NoAuth/Bugs.html?Dist=Distribution-NameE<gt>
or send mail to E<lt>bug-Distribution-Name#rt.cpan.orgE<gt>
Also, be sure to run podchecker to make sure your pod is proper ;)
update: A common mistake is to include example.pl in the same directory as Makefile.PL.
MakeMaker will pick up example.pl (any *.pl file) and install it next to Bar.pm.
The easiest workaround is to keep examples in a separate directory (eg or examples)
or rename the file to example_pl.
MJD says "you can't just make shit up and expect the computer to know what you mean, retardo!" | I run a Win32 PPM repository for perl 5.6.x and 5.8.x -- I take requests (README). | ** The third rule of perl club is a statement of fact: pod is sexy. |
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|