6.4.2 変更履歴の形式

ここに変更履歴の項目の例をいくつか挙げる。

     * register.el (insert-register): Return nil.
     (jump-to-register): Likewise.
     
     * sort.el (sort-subr): Return nil.
     
     * tex-mode.el (tex-bibtex-file, tex-file, tex-region):
     Restart the tex shell if process is gone or stopped.
     (tex-shell-running): New function.
     
     * expr.c (store_one_arg): Round size up for move_block_to_reg.
     (expand_call): Round up when emitting USE insns.
     * stmt.c (assign_parms): Round size up for move_block_from_reg.

変更された関数や変数を略さずに名前を付けることが重要だ。関数や変数の名前 を略していけない。そして、それらをくっ付けてはいけない。その後の管理者は しばしばある関数に属する変更履歴の項目を全部見付けるのに、関数名で検索す るだろう。もしその名前を略していると、彼らは検索するときそれを見付けられ ないだろう。

例えば、ある人々は`* register.el ({insert,jump-to}-register)'と書 くことで、関数名の集まりを略する傾向がある。これは良くない考えだ。 jump-to-registerやinsert-registerの検索はその項目を見付け ないだろうから。

無関係な変更履歴の項目を空行で分けなさい。二つの項目が一緒に働き、同じ変 更部分を表しているとき、それらの間に空行を入れてはいけない。そして、続い ている項目が同じファイルにあるとき、そのファイル名とアスタリスクを省いて 良い。