=begin
= cvs log メッセージから ChangeLog ファイルを作る (cvs2cl)
#* 小高正嗣, 森川 靖大
# * 2006/06/26 (森川靖大) オプションに関して追記
# * 2006/06/20 (小高正嗣) 新規作成
== はじめに
ChangeLog ファイルとは, ソースコードの変更履歴を記録するためのファイルである.
cvs2cl は, Changelog ファイルを cvs log メッセージから自動的に作成してくれる
ソフトウェアである.
cvs2cl によって出力された ChangeLog ファイルは過去の cvs log のメッセー
ジ全てを含むため, 大雑把な改変の概要ではなく, 過去の改変の詳細を知るこ
とができる. そのため主に利用者よりも開発者のためのファイルといえる.
== cvs2cl のインストール
cvs2cl は perl で書かれたスクリプトである.
ソースは (()) よりダウンロードできる.
Debian GNU/Linux 3.1 (sarge) を使う環境では,
# apt-get install cvs2cl
でインストールできる. cvs2cl のマニュアルは
# perldoc cvs2cl.pl
# man cvs2cl
とすると出力される. (Debian GNU/Linux ではどちらも同じマニュアルが表示
される).
== 使い方
レポジトリからチェックアウトしたソースツリーのトップディレクトリにおいて
$ cvs2cl
と実行してみると, カレントディレクトリに Changlog ファイルが作成される.
== オプション
: -h, -help, --help, -?
短いヘルプメッセージを出力し, プログラムを終了する.
: --version
バージョンナンバーを出力し, プログラムを終了する.
: -r, -revisions
出力する内容に個々のファイルのリビジョンナンバーを含める.
: -b, --branches
可能であればブランチの名前も含める.
: -t, --tags
タグ名 (symbolic names) も出力に含める
: --fsf
ログ情報を FSF ChangeLog スタイルで出力する.
くわしいことはよく分からんけど, FSF ChangeLog スタイルにすると,
コミットされたファイル名に関するログメッセージが, 改行されて
出力されているようだ. --fsf を付けないと, ログメッセージはファイル名
のすぐ後ろに出力される.
つまりこのオプションをつけ, 且つログメッセージ自体を RD のリスト形式
(項目の頭に "*" をつける) で書くと, ChangeLog も RD 形式っぽくなる.
: -w, --day-of-week
曜日を出力に含める.
: --header FILE
FILE を ChangeLog のヘッダとする. ("-" とすれば標準入力がヘッダとなる).
== 参考文献
* cvs2cl.pl: CVS-log-message-to-ChangeLog conversion script
(()).
* Chngelog -- ソフトウェアの変更履歴を書くためのテキストの形式,
(())
=end