Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

cpan::changes::spec(3) [centos man page]

CPAN::Changes::Spec(3)					User Contributed Perl Documentation				    CPAN::Changes::Spec(3)

NAME
CPAN::Changes::Spec - Specification for CPAN Changes files VERSION
version 0.01 SYNOPSIS
Revision history for perl module Foo::Bar 0.02 2009-07-17 - Added more foo() tests 0.01 2009-07-16 - Initial release 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. DATA TYPES
Version Versions should be formatted as described in "Version-Formats" in CPAN::Meta::Spec. Date A date/time in the format specified by <http://www.w3.org/TR/NOTE-datetime> aka W3CDTF. STRUCTURE
Required Elements 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)<Date> (whitespace)<Change> "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 Preamble 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 Groups 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 EXAMPLES
Basic Example 0.01 2009-07-16 - Initial release 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 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 SEE ALSO
o CPAN::Changes o Test::CPAN::Changes AUTHOR
Brian Cassidy <bricas@cpan.org> COPYRIGHT AND LICENSE
Copyright 2011-2012 by Brian Cassidy This is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.16.3 2012-04-30 CPAN::Changes::Spec(3)

Check Out this Related Man Page

CPAN::Meta::History(3)					User Contributed Perl Documentation				    CPAN::Meta::History(3)

NAME
CPAN::Meta::History - history of CPAN Meta Spec changes VERSION
version 2.133380 DESCRIPTION
The CPAN Meta Spec has gone through several iterations. It was originally written in HTML and later revised into POD (though published in HTML generated from the POD). Fields were added, removed or changed, sometimes by design and sometimes to reflect real-world usage after the fact. This document reconstructs the history of the CPAN Meta Spec based on change logs, repository commit messages and the published HTML files. In some cases, particularly prior to version 1.2, the exact version when certain fields were introduced or changed is inconsistent between sources. When in doubt, the published HTML files for versions 1.0 to 1.4 as they existed when version 2 was developed are used as the definitive source. Starting with version 2, the specification document is part of the CPAN-Meta distribution and will be published on CPAN as CPAN::Meta::Spec. Going forward, specification version numbers will be integers and decimal portions will correspond to a release date for the CPAN::Meta library. HISTORY
Version 2 April 2010 o Revised spec examples as perl data structures rather than YAML o Switched to JSON serialization from YAML o Specified allowed version number formats o Replaced 'requires', 'build_requires', 'configure_requires', 'recommends' and 'conflicts' with new 'prereqs' data structure divided by phase (configure, build, test, runtime, etc.) and relationship (requires, recommends, suggests, conflicts) o Added support for 'develop' phase for requirements for maintaining a list of authoring tools o Changed 'license' to a list and revised the set of valid licenses o Made 'dynamic_config' mandatory to reduce confusion o Changed 'resources' subkey 'repository' to a hash that clarifies repository type, url for browsing and url for checkout o Changed 'resources' subkey 'bugtracker' to a hash for either web or mailto resource o Changed specification of 'optional_features': o Added formal specification and usage guide instead of just example o Changed to use new prereqs data structure instead of individual keys o Clarified intended use of 'author' as generalized contact list o Added 'release_status' field to indicate stable, testing or unstable status to provide hints to indexers o Added 'description' field for a longer description of the distribution o Formalized use of "x_" or "X_" for all custom keys not listed in the official spec Version 1.4 June 2008 o Noted explicit support for 'perl' in prerequisites o Added 'configure_requires' prerequisite type o Changed 'optional_features' o Example corrected to show map of maps instead of list of maps (though descriptive text said 'map' even in v1.3) o Removed 'requires_packages', 'requires_os' and 'excluded_os' as valid subkeys Version 1.3 November 2006 o Added 'no_index' subkey 'directory' and removed 'dir' to match actual usage in the wild o Added a 'repository' subkey to 'resources' Version 1.2 August 2005 o Re-wrote and restructured spec in POD syntax o Changed 'name' to be mandatory o Changed 'generated_by' to be mandatory o Changed 'license' to be mandatory o Added version range specifications for prerequisites o Added required 'abstract' field o Added required 'author' field o Added required 'meta-spec' field to define 'version' (and 'url') of the CPAN Meta Spec used for metadata o Added 'provides' field o Added 'no_index' field and deprecated 'private' field. 'no_index' subkeys include 'file', 'dir', 'package' and 'namespace' o Added 'keywords' field o Added 'resources' field with subkeys 'homepage', 'license', and 'bugtracker' o Added 'optional_features' field as an alternate under 'recommends'. Includes 'description', 'requires', 'build_requires', 'conflicts', 'requires_packages', 'requires_os' and 'excluded_os' as valid subkeys o Removed 'license_uri' field Version 1.1 May 2003 o Changed 'version' to be mandatory o Added 'private' field o Added 'license_uri' field Version 1.0 March 2003 o Original release (in HTML format only) o Included 'name', 'version', 'license', 'distribution_type', 'requires', 'recommends', 'build_requires', 'conflicts', 'dynamic_config', 'generated_by' AUTHORS
o David Golden <dagolden@cpan.org> o Ricardo Signes <rjbs@cpan.org> COPYRIGHT AND LICENSE
This software is copyright (c) 2010 by David Golden and Ricardo Signes. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. perl v5.18.2 2013-12-03 CPAN::Meta::History(3)
Man Page

Featured Tech Videos