| 1 |
NAME |
| 2 |
CPAN::Changes - Parser for CPAN style change logs |
| 3 |
|
| 4 |
SYNOPSIS |
| 5 |
use CPAN::Changes; |
| 6 |
my $changes = CPAN::Changes->load('Changes'); |
| 7 |
$changes->release('0.01'); |
| 8 |
|
| 9 |
DESCRIPTION |
| 10 |
It is standard practice to include a Changes file in your distribution. |
| 11 |
The purpose the Changes file is to help a user figure out what has |
| 12 |
changed since the last release. |
| 13 |
|
| 14 |
People have devised many ways to write the Changes file. A preliminary |
| 15 |
specification has been created (CPAN::Changes::Spec) to encourage module |
| 16 |
authors to write clear and concise Changes. |
| 17 |
|
| 18 |
This module will help users programmatically read and write Changes |
| 19 |
files that conform to the specification. |
| 20 |
|
| 21 |
METHODS |
| 22 |
new ( %args ) |
| 23 |
Creates a CPAN::Changes object. |
| 24 |
|
| 25 |
%args |
| 26 |
preamble |
| 27 |
The preamble section of the changelog. |
| 28 |
|
| 29 |
releases |
| 30 |
An arrayref of CPAN::Changes::Release objects. |
| 31 |
|
| 32 |
load ( $filename, %args ) |
| 33 |
Creates a new CPAN::Changes object by parsing the given file via |
| 34 |
CPAN::Changes::Parser. |
| 35 |
|
| 36 |
load_string ( $filename, %args ) |
| 37 |
Creates a new CPAN::Changes object by parsing the given string via |
| 38 |
CPAN::Changes::Parser. |
| 39 |
|
| 40 |
preamble ( [ $preamble ] ) |
| 41 |
Gets or sets the preamble section. |
| 42 |
|
| 43 |
releases ( [ @releases ] ) |
| 44 |
Gets or sets the list of releases as CPAN::Changes::Release objects. |
| 45 |
|
| 46 |
add_release ( @releases ) |
| 47 |
Adds the given releases to the change log. If a release of the same |
| 48 |
version exists, it will be overwritten. |
| 49 |
|
| 50 |
delete_release ( @versions ) |
| 51 |
Removes the given versions from change log. |
| 52 |
|
| 53 |
find_release ( $version ) |
| 54 |
Finds a release with the given version. |
| 55 |
|
| 56 |
reversed |
| 57 |
Returns a new CPAN::Changes object with the releases in the opposite |
| 58 |
order. |
| 59 |
|
| 60 |
clone ( %attrs ) |
| 61 |
Returns a new "CPAN::Changes" object with the given attributes changed. |
| 62 |
|
| 63 |
serialize ( %options ) |
| 64 |
Returns the change log as a string suitable for saving as a Changes |
| 65 |
file. |
| 66 |
|
| 67 |
width |
| 68 |
The width to wrap lines at. By default, lines will be wrapped at 75 |
| 69 |
characters. |
| 70 |
|
| 71 |
styles |
| 72 |
An array reference of styles to use when outputting the entries, one |
| 73 |
for each level of change. The first entry is used for the release |
| 74 |
entry itself. |
| 75 |
|
| 76 |
The styles can be either a single character to prefix change lines |
| 77 |
or two characters to use as a prefix and suffix. |
| 78 |
|
| 79 |
indents |
| 80 |
An array reference of indent strings to use when outputting the |
| 81 |
entries. |
| 82 |
|
| 83 |
reverse (legacy) |
| 84 |
If true, releases will be output in reversed order. |
| 85 |
|
| 86 |
group_sort (legacy) |
| 87 |
A code reference used to sort the groups in the releases. |
| 88 |
|
| 89 |
LEGACY METHODS |
| 90 |
delete_empty_groups |
| 91 |
Removes empty groups. |
| 92 |
|
| 93 |
release |
| 94 |
An alias for find_release. |
| 95 |
|
| 96 |
AUTHOR |
| 97 |
haarg - Graham Knop (cpan:HAARG) <[email protected]> |
| 98 |
|
| 99 |
CONTRIBUTORS |
| 100 |
Brian Cassidy <[email protected]> |
| 101 |
|
| 102 |
COPYRIGHT |
| 103 |
Copyright (c) 2011-2015 the CPAN::Changes "AUTHOR" and "CONTRIBUTORS" as |
| 104 |
listed above. |
| 105 |
|
| 106 |
LICENSE |
| 107 |
This library is free software and may be distributed under the same |
| 108 |
terms as perl itself. See <http://dev.perl.org/licenses/>. |
| 109 |
|