NAME ( 名前 )

CPAN::Changes::Spec - Specification for CPAN Changes files

CPAN::Changes::Spec - 仕様 CPAN Changes ファイルのための

VERSION

version 0.04

SYNOPSIS ( 概要 )

Revision history for perl module Foo::Bar



0.02 2009-07-17



 - Added more foo() tests



0.01 2009-0716



 - Initial release

DESCRIPTION ( 説明 )

This document describes version 0.03 of the specification for Changes files included in a CPAN distribution.

このドキュメントは説明します version 0.03 を 仕様の Changes ファイルのための 含まれる CPAN ディストリビューションに.

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.

それは意図されています ガイドとして モジュール作者のための 奨励するために 彼らが書くことを 意味のあるチェンジログを 提供することと同様に プログラム的なインターフェースを 確実に読み書きするための Changes ファイルを.

DATA TYPES ( データタイプ )

Version ( バージョン )

Versions should be formatted as described in "Version-Formats" in CPAN::Meta::Spec.

バージョンはフォーマットする必要があります 説明されているように "Version-Formats" で CPAN::Meta::Spec の.

Date ( 日付 )

A date/time in the format specified by http://www.w3.org/TR/NOTE-datetime aka W3CDTF. Note: The "T" marker before the time portion is optional.

date/time です フォーマットの 指定された http://www.w3.org/TR/NOTE-datetime によって またの名を W3CDTF. 注意: "T" マーカは time 部分の前の オプションです.

In order to satisfy release events not made to the public, or dates that are historically unknown, the following strings are also available:

満たすために リリースイベントを 公開されていない, または 日付を 歴史的に知られていない, 次の文字列がまた利用可能です:

・Unknown Release Date
・Unknown
・Not Released
・Development Release
・Development
・Developer Release

・不明なリリース日
・不明
・リリースされていない
・開発リリース
・開発
・開発者リリース

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, Date と noted changes だけです. 空行は Version 行と最初の Change 行の間の オプショナルです. 空行も Change 行の間の またオプショナルです.

<Version>(whitespace/non-"word" characters)<Date>

(whitespace)<Change>

NOTE: The characters between a Version and a Date must start with whitespace, but may subsquently contain any combination of whitespace and non-"word" characters. Example:

注意: 文字は Version と Date の間の 始まる必要があります 空白で, しかし続いてもよいです 含むすべての組み合わせが 空白と 非-"単語" 文字を. 例:

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

Change 行はもっていません 特定のフォーマットを. 一般的に, 作者は使います ダッシュ - を スペースが続く 始めるために 新しい change を, それと インデントします 続く行を 複数行の changes のために. 例

- Simple Change

- This is a very very very long

  change line

制限はありませんが 行の長さに, 著者は通常ラップします 各行を 78 列に.

Optional Elements ( オプショナルの要素 )

Release Note ( リリースノート )

Any text following the Date portion of the Version line will be considered the Release Note. Example:

すべてのテキストは 続く Date 部分に Version 行の みなされます Relese Note と. 例:

0.01 2013-04-01 Codename: April Fool



  - First Release

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:

どれだけの量のテキストも 最初の Version 行の前の みなされます 一部と preamble ( 前文 ) の. ほとんどの既存のディストリビューションは含みます 何かを 行に沿って:

Revision history for perl module My::Module

Or

Revision history for perl distribution My-Distribution

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.

Changelog エントリはグループにすることができます 見出しの下で. 見出し行は 始まります オープニングスクエアブラケット ( [ ) で, それと 終わります マッチするスクエアブラケット ( ] ) で. 解析するとき グループ見出しを, 先頭と末尾の空白は ブラケットの内側の 破棄される必要があります.

(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:

空行は保持しないので 特別な意味を, すべての Change 行は 配下になります 現在のグループの 新しいグループの見出しが見つかるまで. 例:

[ Firse Group ]

- First Change



- Second Chnage; 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 ( 関連項目 )

・CPAN::Changes
・Test::CPAN::Chnages

AUTHOR ( 作者 )

Braian Cassidy <bricas@cpan.org>

COPYRIGHT AND LICENSE ( コピーライトとライセンス )

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.

これはフリーソフトウェアです; あなたはできます これの再配布 and/or 変更を 下で 同じ規約の Perl それ自身と.

NEXT

次回は、ディストリビューションの作成時にコアとなる用語「 package 」, 「 module 」, 「 distribution 」 の定義について確認します。


参考情報は書籍「 続・初めての Perl 改訂版 」, 「 Effective Perl 第 2 版 」を中心に perldoc, Wikipedia および各 Web サイト。それと詳しい先輩。

目次 - Perl Index