CvsChangeLog

Description

説明

Generates an XML-formatted report file of the change logs recorded in a CVS repository.

CVSリポジトリに記録されている変更履歴の、XML形式のレポートファイルを生成します。

Important: This task needs "cvs" on the path. If it isn't, you will get an error (such as error 2 on windows). If <cvs> doesn't work, try to execute cvs.exe from the command line in the target directory in which you are working.

重要:このタスクは、実行パス上の "cvs" を必要とします。 もし存在しなければエラー (Windows上では error 2) となります。 もし <cvs> が動かない場合は、コマンドラインで、ターゲットディレクトリに移動して cvs.exe を実行してみてください。

Parameters

パラメータ

Attribute Description Required
Attributes from parent Cvs task which are meaningful here
Since ant 1.6.1
cvsRoot the CVSROOT variable. No
cvsRsh the CVS_RSH variable. No
package the package/module to check out. No
port Port used by CVS to communicate with the server. No, default port 2401.
passfile Password file to read passwords from. No, default file ~/.cvspass.
failonerror Stop the build process if the command exits with a return code other than 0. Defaults to false No
tag query the changelog for a specific branch. No
Specific attributes
dir The directory from which to run the CVS log command. No; defaults to ${basedir}.
destfile The file in which to write the change log report. Yes
usersfile Property file that contains name-value pairs mapping user IDs and names that should be used in the report in place of the user ID. No
daysinpast Sets the number of days into the past for which the change log information should be retrieved. No
start The earliest date from which change logs are to be included in the report. No
end The latest date to which change logs are to be included in the report. No
属性 説明 必須
親であるCvsタスクから引き継いだ属性
Ant 1.6.1〜
cvsRoot CVSROOT変数。 No
cvsRsh CVS_RSH変数。 No
package チェックアウトしたいパッケージ、モジュール名 No
port CVSがサーバと通信するポート。 No, デフォルトは 2401
passfile パスワードが格納されているファイル。 No, デフォルトは ~/.cvspass
failonerror コマンドの終了コードが0でなかった場合にビルドを停止するかどうか。 デフォルトは false。 No
tag 指定したブランチの更新履歴を取得する。 No
このタスク用の属性
dir CVS log コマンドを実行するディレクトリ。 No; デフォルトは ${basedir}.
destfile 変更履歴レポートを書き出すファイル。 Yes
usersfile レポート中のユーザIDを名前に置き換えるための、名前と値のペアが入っているファイル名。 No
daysinpast 過去何日間のログ情報を取り出すか。 No
start レポート中に入れる変更履歴の開始日。 No
end レポート中に入れる変更履歴の終了日。 No

Parameters specified as nested elements

子要素で指定するパラメータ

user

The nested <user> element allows you to specify a mapping between a user ID as it appears on the CVS server and a name to include in the formatted report. Anytime the specified user ID has made a change in the repository, the <author> tag in the report file will include the name specified in displayname rather than the user ID.

<user>子要素で、 CVS サーバー上のユーザIDとレポートに含まれる名前とのマッピングを指定できます。 指定されたユーザIDによるリポジトリの修正に対して、 レポート中の<author>タグはユーザIDでなく、 displaynameで設定した名前が入ります。

Attribute Description Required
displayname The name to be used in the CVS change log report. Yes
userid The userid of the person as it exists on the CVS server. Yes
属性 説明 必須
displayname CVS 変更履歴のレポートで使われる名前 Yes
userid CVSサーバーに存在するユーザID Yes

Examples

  <cvschangelog dir="dve/network"
                destfile="changelog.xml"
  />

Generates a change log report for all the changes that have been made under the dve/network directory. It writes these changes into the file changelog.xml.

dve/networkディレクトリ以下の、全ての変更の履歴レポートを作成し、 ファイルchangelog.xmlに出力します。

  <cvschangelog dir="dve/network"
                destfile="changelog.xml"
                daysinpast="10"
  />

Generates a change log report for any changes that were made under the dve/network directory in the past 10 days. It writes these changes into the file changelog.xml.

過去10日間に行われた、dve/networkディレクトリ以下の変更履歴レポートを作成し、 ファイルchangelog.xmlに出力します。

  <cvschangelog dir="dve/network"
                destfile="changelog.xml"
                start="20 Feb 2002"
                end="20 Mar 2002"
  />

Generates a change log report for any changes that were made between February 20, 2002 and March 20, 2002 under the dve/network directory. It writes these changes into the file changelog.xml.

2002年2月20日から2002年3月20日までに行われた dve/networkディレクトリ以下の変更履歴レポートを作成し、 ファイルchangelog.xmlに出力します。

  <cvschangelog dir="dve/network"
                destfile="changelog.xml"
                start="20 Feb 2002"
  />

Generates a change log report for any changes that were made after February 20, 2002 under the dve/network directory. It writes these changes into the file changelog.xml.

2002年2月20日以降に行われた dve/networkディレクトリ以下の変更履歴レポートを作成し、 ファイルchangelog.xmlに出力します。

  <cvschangelog dir="dve/network"
                destfile="changelog.xml">
       <user displayname="Peter Donald" userid="donaldp"/>
  </cvschangelog>

Generates a change log report for all the changes that were made under the dve/network directory, substituting the name "Peter Donald" in the <author> tags anytime it encounters a change made by the user ID "donaldp". It writes these changes into the file changelog.xml.

ユーザID "donaldp" による変更は <author>タグの名前を"Peter Donald"に置き換えながら、 dve/networkディレクトリ以下の変更履歴レポートを作成し、 ファイルchangelog.xmlに出力します。

Generates a change log report on the ANT_16_BRANCH.

ANT_16_BRANCH上の変更履歴レポートを作成します。

 <cvschangelog dir="c:/dev/asf/ant.head" passfile="c:/home/myself/.cvspass"
                destfile="changelogant.xml" tag="ANT_16_BRANCH" />

Generate Report

レポートを生成する

Ant includes a basic XSLT stylesheet that you can use to generate a HTML report based on the xml output. The following example illustrates how to generate a HTML report from the XML report.

Antには、XML 出力を基に HTML レポートを生成するための基本的な XSLT スタイルシートが含まれています。 次の例は、XML出力からHTMLレポートを生成する方法を示しています。

        <style in="changelog.xml"
               out="changelog.html"
               style="${ant.home}/etc/changelog.xsl">
          <param name="title" expression="Ant ChangeLog"/>
          <param name="module" expression="ant"/>
          <param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/>
        </style>

Sample Output

出力例

<changelog>
  <entry>
    <date>2002-03-06</date>
    <time>12:00</time>
    <author>Peter Donald</author>
    <file>
      <name>org/apache/myrmidon/build/AntlibDescriptorTask.java</name>
      <revision>1.3</revision>
      <prevrevision>1.2</prevrevision>
    </file>
    <msg><![CDATA[Use URLs directly rather than go via a FIle.

This allows temp[lates to be stored inside jar]]></msg>
  </entry>
</changelog>

Copyright © 2002-2004 The Apache Software Foundation. All rights Reserved.
[訳注:これは漆島賢二の訳を参考に、的場が翻訳しました。日本語訳に対するコメントがあれば report@jajakarta.orgに送ってください]