Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl Monk, Perl Meditation
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??
If you're gonna be distributing your module on CPAN, you should be aware of the following CPAN FAQ item

How do I report/fix a bug in a module/script?

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.


In reply to Re: How to make a CPAN Module Distribution by PodMaster
in thread How to make a CPAN Module Distribution by tachyon

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others imbibing at the Monastery: (6)
    As of 2015-07-05 04:33 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      The top three priorities of my open tasks are (in descending order of likelihood to be worked on) ...









      Results (60 votes), past polls