I am in the process of cleaning up a module I've written called JobQueue for submission to CPAN. The module is an API that allows job submission to either a Sun Grid Engine installation, or a local fork/wait bundle of processes, in case that's useful to anyone.

Anyway, tt's all very exciting. However, since it's my first submission, I have some stylistic questions. I use Log::Log4perl as a development tool, and as a consequence have a variety of debug, info and a few logdie statements in the JobQueue code. These are very useful to have in the event that something goes horribly wrong, but the bad news is that Log::Log4perl is not a core module (in fact, installing it can be a bit of a pain), and I don't want to force users of my module to install it.

But that leaves me in a difficult place -- if they don't have the logging module installed, and the module misbehaves, they don't have any log file to look at to assist them (and me) in understanding what went wrong.

So, force them into installing the logger, or do without, and have no diagnostic tools?

Alex / talexb / Toronto

"Groklaw is the open-source mentality applied to legal research" ~ Linus Torvalds

In reply to Any suggestions on cleaning up a module for submission to CPAN? by talexb

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!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • 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, details, 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, summary, 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.