Top | Wiki | Blog | Github  

ChangeLog

ChangeLog は,本来プログラムの作成過程において施した修正などを一括して記述しておくファイルのこと.いつ,だれが,どのファイルに,どんな修正を,なぜ加えたのか,を明記しておくことができる.近年 ChangeLog は,日記を書き記したり,アイディアを貯めておくファイルとしても利用されている.

基本書式

2000-01-01    Hoge Hoge    <hoge@hoge.com>

        * sample.c: ループ処理の最適化

        * sample.h: 命名ルールの修正

        * encode.cpp (getName): 引数を一つ削除

1999-12-31    Hoge Hoge     <hoge@hoge.com>

        * Makefile: 初期生成

ファイル名の後の括弧には,関数名や変数名を入れるのが一般的.複数の関数に修正を加えたのならば,次のように書けばよい.

2001-01-02    Hoge Hoge     <hoge@hoge.com>

        * sample.c: エラー出力に対応
        (setVal): エラー値を格納.
        (error_log): 状態値を格納する変数を追加.

        * Makefile: コンパイルオプションを追加.

Emacs から呼ぶ

Emacs を起動後,[Ctrl-x 4 a] と押すと ChangeLog ファイルが開かれ,次のような状態に自動的になる.

2001-01-03    Hoge Hoge     <hoge@hoge.com>

        * |

つまり,エントリーヘッダ(日付,名前,メールアドレス)およびアスタリスクまでを自動補完してくれる.(|はカーソルの意味)

何かしら記述後,さらに [Ctrl-x 4 a] と押すと,新しいアスタリスクが生成されカーソルが移動される.実際は,カラフルに色分けが行われる.

エントリーヘッダの値

シェルの設定ファイルに次のようなコマンドを記しておけば,エントリーヘッダはこれを参照する.

(setq user-full-name "Hoge HOGE")
(setq user-mail-address "hoge@hoge.com")

Link