[MD:6777] Re: [MEADOW DEVELOPMENT] Issue #MW136

[Shun-ichi GOTO (後藤俊一) <shunichi.goto@xxxxxxxxx>]

On 9/8/05, Masanori Miyoshi <miyoshi@xxxxxxxxxxx> wrote:
> *Reason for change*
> 修正しました。
> 
> Meadow3での修正を取り込んだ際に、不具合も一緒に取り込んでしまったのが原因です。

このissue closeを見て思ったのですが。。。

この修正に関するcommitはr3859およびr3858かと思いますが、
出来ましたら、r3859およびr3859のcommit log およびChangeLog.Meadowに
"Fixed MW136" といったコメントを加えておいていただけるとよいと思います。特に
(mw32_message_loop): Set `keyboard_handle' to the signaled state.
というコメントは実を記述していないので、その変更が何を意味するのかを知るには、
MW136へのリンクが助けになります。というか、それがないと、なぜその修正が必要
だったのかという背景を知るのが困難だと思います。

また一方、MW136を閉じる際のコメントにも
"修正しました(r3858)。
同様の問題がtrunkにもありましたのでこちらもあわせて修正しました(r3859)。
"
のように書いておくのがよいと思います。

あと、GNU ChangeLogの書き方にこだわると、ChangeLogの記載はついつい
関数単位での修正内容になりがちなのが心配なので近年はあまり好きでなかったり
するのですが、実際にはそのChangeSet全体で1つの意味を持つわけですから、

r3858の分のChangeLogは
 * mw32term.c (mw32_message_loop): Do not forget set keyboard event.
This is a bug came from r3821 merge in r3845.
Fixed issue MW136.

r3859の分のChangeLogは
 * mw32term.c (mw32_message_loop): Do not forget set keyboard event.
This is follow-up of r3821.

といったように書けるとよいかなと思いました。

必ずそうて、といいっているわけではないのですが、今回のようにcommitとfixが
直接対応する場合は特に、そうしたほうが、ChangeLogおよびissue/ticketの
価値がグンと上がるかと思います。

-- 
Shun-ichi GOTO (後藤俊一)