Many here are familiar with CVS, the popular version management system, so I thought I would ask for some insight before possibly re-inventing the wheel or beginning an exercise in futility.

The question is, is there a tool that can extract "comments" put into source files and turn these comments into a log entry? I find that I would rather make notes about what I am doing, instead of having to remember until I 'commit' the changes. There is some talk here, such as Creating Changelogs from CVS with Perl, which deals with the logs once they have been created, but I couldn't find anything on creating the logs themselves. Use of VCS::CVS is likely to be required.

Conceptually, the idea is you would do something like: 
     # > Forgot to put in second parameter to Frobnicator
     # > constructor, which broke something fierce.
     my $frob = new Frobnicator($fooz, $zoof);

[download]
Which would get hauled out, formatted slightly, and crammed into the log file when it came time to update. If you made 1 change, or 1e9, everything would be tracked neatly. The special comments themselves would be hauled out before an import, to avoid filling the source code with heaps of redundant comments.

For the pursuit of laziness, of course.

In reply to Auto-Generating CVS Log Entries by tadman

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.