ECHANGELOG(1)

名前
echangelog - Gentoo: portage の ChangeLog を更新する

書式
echangelog [ text ]

説明
echangelog は Gentoo における Portage の ChangeLog を作成、または更新する負担を 軽減する。このツールは /usr/portage/app-editors/vim のようなパッケージディレク トリにいると仮定し、現在のディレクトリを走査して変更、もしくは追加されたファイル を見つけ、ChangeLog のエントリに追加する。text がコマンドラインであたえら れなかった場合、echangelog はユーザーに入力を促す。

ChangeLog のエントリとして、正確にファイルの情報を追加するために、全ての変更は echangelog を実行する前になされるべきである。たとえば、追加するファイルを "cvs add" しておかないと、echangelog は、それらのファイルが更新の一部だとは認識しない。

ChangeLog のエントリが 80文字を越えた場合には、ChangeLog の体裁を守るために自動 的に改行される。ChangeLog において特別な書式を用いたいのなら、(1) echangelog を コマンドラインから何の text も渡さずに実行し、text が長くならないことを確実にす る。(2) ChangeLog を直接編集する、のどちらでも可能である。(2) を選ぶ場合には、 "echangelog blah" のように実行し、自動的にヘッダ行が追加された後、"blah" を好き な text に編集することを勧める。

ChangeLog の更新について追記。echangelog は ChangeLog の著作権表示だけでなく、全 ebuild の著作権表示も自動的に更新する。更新が行われた後の差分表示には、この変更 点も表示される。

オプション
現在の echangelog は何ひとつオプションはない。 おそらく、--help と --version は将来追加されるだろうが、今のとこ ろは gentoolkit のバージョンを使う。

例
パッケージに新しく ChangeLog を作成する際には、skel.ebuild からヘッダを得る。
    $ cvs add metalog-0.1.ebuild
    cvs server: use 'cvs commit' to add this file permanently
    $ echangelog 'New ebuild, thanks to Harvey McGillicuddy'
    --- ChangeLog   1969-12-31 19:00:00.000000000 -0500
    +++ ChangeLog.new       2003-02-23 14:04:06.000000000 -0500
    @@ -0,0 +1,9 @@
    +# ChangeLog for app-admin/metalog
    +# Copyright 2000-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2
    +# $Header$
    +
    +*metalog-0.1 (23 Feb 2003)
    +
    +  23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog-0.1.ebuild :
    +  New ebuild, thanks to Harvey McGillicuddy
    +

レビジョンをあげる際には、echangelog が新しいファイルを識別できるように "cvs add" しておく必要がある。
    $ cvs add metalog-0.1-r1.ebuild
    cvs server: use 'cvs commit' to add this file permanently
    $ echangelog 'Bump revision to fix bug #999'
    --- ChangeLog   2003-02-23 14:04:06.000000000 -0500
    +++ ChangeLog.new       2003-02-23 14:07:48.000000000 -0500
    @@ -2,6 +2,11 @@
     # Copyright 2000-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2
     # $Header$
    +*metalog-0.1-r1 (23 Feb 2003)
    +
    +  23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog-0.1-r1.ebuild :
    +  Bump revision to fix bug #999
    +
     *metalog-0.1 (23 Feb 2003)
       23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog-0.1.ebuild :

複数行のエントリを入力する際には、コマンドライン引数を省略すればよい。
    $ echangelog
    Please type the log entry, finish with ctrl-d
    Bump revision to fix bug #999.  Necessary to bump the revision because
    the problem appears at run-time, not compile-time.  This should also
    give users the updated default configuration file.
    --- ChangeLog   2003-02-23 14:09:12.000000000 -0500
    +++ ChangeLog.new       2003-02-23 14:12:43.000000000 -0500
    @@ -2,6 +2,13 @@
     # Copyright 2000-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2
     # $Header$
    +*metalog-0.1-r1 (23 Feb 2003)
    +
    +  23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog-0.1-r1.ebuild :
    +  Bump revision to fix bug #999.  Necessary to bump the revision because
    +  the problem appears at run-time, not compile-time.  This should also
    +  give users the updated default configuration file.
    +
     *metalog-0.1 (23 Feb 2003)
       23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog-0.1.ebuild :

環境変数

ECHANGELOG_USER
    echangelog がエントリを追加する際に、あなたのユーザーネームをうまく取得できない 場合には ECHANGELOG_USER を設定すべきである。例、export ECHANGELOG_USER="Aron Griffis <agriffis@gentoo.org>"。

注意
最近の echangelog (この man ページが収録されるようになってから)は、新しいエント リをバージョンごとにまとめるのではなく、つねにファイルの始めに追加するようになっ た。これは、Gentoo 開発者にごとに新しい ChangeLog の書式が統一されていなかったか らである。両方の書式が存在することにより、混乱させてしまい申し訳ない。

またこれは、昔のメールからコピーしてきた上記の例も間違っているということを意味し ている。しかしながら、まったく違うというわけでも無い。;-)

このツールは Aron Griffis <agriffis@gentoo.org> によって書かれた。バグを発見した 場合は http://bug.gentoo.org/ にて私に対して報告してほしい。