[Date Prev][Date Next][Thread Prev][][Date Index][Thread Index]

Re: [Conclusion] coding-system of ChangeLog



高橋です。

From: TSUCHIYA Masatoshi <tsuchiya@pine.kuee.kyoto-u.ac.jp>
Subject: [emacs-w3m:01777] Re: [Conclusion] coding-system of ChangeLog
Date: Tue, 16 Oct 2001 12:12:39 +0900

土> ChangeLog はプログラムの変更について書くものだという意識があったこ
土> とと、ドキュメント類の変更は大抵の場合「Follow changes of main
土> trunk」とか「Update」の一言で済んでしまうので、cvs log で十分だと
土> 思ってましたから。

山> ぼくもドキュメントはそれ自体が語っているので ChangeLog は要らない
山> と思っていました。

土> うーん、だとすると、これを公式見解にしてしまって良いでしょうか? 他のプ
土> ロジェクトなどではどのような扱いになっているのでしょう?

GNU Coding Standards には以下の記述があります。
(ノード Simple Changes)

| There's no need to make change log entries for documentation files.
| This is because documentation is not susceptible to bugs that are hard
| to fix.  Documentation does not consist of parts that must interact in a
| precisely engineered fashion.  To correct an error, you need not know
| the history of the erroneous passage; it is enough to compare what the
| documentation says with the way the program actually works.

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

参考まで。

-- 
TAKAHASHI "beatmaria" Kaoru (高橋 郁) <kaoru@trans-nt.com>
  "Remember, the source will be with you...always."