次: , 前: Style of Change Logs, 上: Change Logs


6.4.3 単純な変更

ある単純な類いの変更は変更履歴にやたら詳細に記す必要はない。

単純なやり方で関数の呼び出し順序を変更し、その関数の呼び出し元を全て 変更するとき、変更した呼び出し元全てに個々の項目を作る必要はない。単に 呼ばれる関数の項目に“All callers changed”と書きなさい。

     * keyboard.c (Fcommand_execute): New arg SPECIAL.
     All callers changed.

コメントや解説の文字列だけを変更するとき、関数に言及せずに、そのファイル の項目を書けば十分だ。単なる“Doc fixes”だけで変更履歴には十分だ。

解説ファイルのための変更履歴の項目は作る必要はない。これは解説は直すのが 困難であるバグに影響しないからだ。解説は正確に設計されたやり方で相互作用 するに違いない部分から成り立っているわけではない。誤りを正すために、間違っ た経過の履歴を知る必要はない。その解説が言っていることと、そのプログラム が実際に働く方法を比較すれば十分だ。