/usr/share/perl5/CPAN/Changes/Spec.pod is in libcpan-changes-perl 0.18-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | =pod
=head1 NAME
CPAN::Changes::Spec - Specification for CPAN Changes files
=head1 VERSION
version 0.01
=head1 SYNOPSIS
Revision history for perl module Foo::Bar
0.02 2009-07-17
- Added more foo() tests
0.01 2009-07-16
- Initial release
=head1 DESCRIPTION
This document describes version 0.1 of the specification for Changes files
included in a CPAN distribution.
It is intended as a guide for module authors to encourage them to write
meaningful changelogs as well as provide a programmatic interface to
reliably read and write Changes files.
=head1 DATA TYPES
=head2 Version
Versions should be formatted as described in L<CPAN::Meta::Spec/Version_Formats>.
=head2 Date
A date/time in the format specified by L<http://www.w3.org/TR/NOTE-datetime>
aka W3CDTF.
=head1 STRUCTURE
=head2 Required Elements
In its simplest form, the only required elements are a version, a date and
the noted changes. Blank lines between the C<Version> line and the first
C<Change> line are optional. Blank lines between C<Change> lines are also
optional.
<Version>(whitespace)<Date>
(whitespace)<Change>
C<Change> lines have no specific format. Commonly, authors will use a dash
C<-> 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
=head2 Preamble
Any amount of text before the first C<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
=head2 Groups
Changelog entries may be grouped under headings. Heading lines begin with an
opening square bracket (C<[>), and end with a matching square bracket (C<]>).
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 C<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
=head1 EXAMPLES
=head2 Basic Example
0.01 2009-07-16
- Initial release
=head2 Example with a preamble
Revision history for perl module Foo::Bar
0.02 2009-07-17
- Added more foo() tests
0.01 2009-07-16
- Initial release
=head2 Example with groups
Revision history for perl module Foo::Bar
0.03 2009-07-18
[Important Security Information]
- This release fixes critical bug RT #1234
[Other Changes]
- Added some feature
0.02 2009-07-17
- Added more foo() tests
0.01 2009-07-16T19:20:30+01:00
- Initial release
=head1 SEE ALSO
=over 4
=item * L<CPAN::Changes>
=item * L<Test::CPAN::Changes>
=back
=head1 AUTHOR
Brian Cassidy E<lt>bricas@cpan.orgE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright 2011 by Brian Cassidy
This is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|