|o||Unknown Release Date|
In its simplest form, the only required elements are a Version, a Date and the noted changes. Blank lines between the Version line and the first Change line are optional. Blank lines between Change lines are also optional.
<Version>(whitespace/non-"word" characters)<Date> (whitespace)<Change>
0.01 - 2013-12-11
Change lines have no specific format. Commonly, authors will use a dash - followed by a space to start a new change, and indent subsequent lines for multi-line changes. Example
- Simple Change - This is a very very very long change line
Although there is no limit on line length, authors generally wrap each line at 78 columns.
Any text following the Date portion of the Version line will be considered the Release Note. Example:
0.01 2013-04-01 Codename: April Fool - First Release
Any amount of text before the first Version line will be considered part of the preamble. Most existing distributions include something along the lines of:
Revision history for perl module My::Module
Revision history for perl distribution My-Distribution
Changelog entries may be grouped under headings. Heading lines begin with an opening square bracket ([), and end with a matching square bracket (]). When parsing group headings, leading and trailing whitespace inside the brackets should be discarded.
(whitespace)[Grouping Name] (whitespace)<Change>
Since empty lines hold no special meaning, all Change lines will fall under the current group until a new group heading is found. Example:
[ First Group ] - First Change - Second Change; in first group [ Second Group ] - First Change; in second group
0.01 2009-07-16 - Initial release
Revision history for perl module Foo::Bar 0.02 2009-07-17 - Added more foo() tests 0.01 2009-07-16 - Initial release
o CPAN::Changes o Test::CPAN::Changes
Brian Cassidy <email@example.com>
Copyright 2011-2013 by Brian Cassidy
This is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
|perl v5.20.3||CPAN::CHANGES::SPEC (3)||2014-10-10|