develnews #2 (5/5) 翻訳

["Satoru KURASHIKI" <lurdan@xxxxxxxxx>]

倉敷です。

表題の翻訳です。査読お願いします。

> Changelog entries must describe changes
> ---------------------------------------
>
>    While reading changelogs (through debian-devel-changes@xxxxx), we
>    see too often bad changelog entries that describe the problem that they
>    fix without indicating how they fix it. In a changelog the important
>    bits are the description of the change and not only what lead you
>    to do the change. Hopefully some examples will make it clearer:
>
>    Bad:
>      * Fix lintian error.
>    Good:
>      * Fix spelling error (maintainance -> maintenance) in description
>        (detected by lintian).
>
>    Bad:
>      * Fix package building with new dpkg-shlibdeps.
>    Good:
>      * Pass LD_LIBRARY_PATH=/usr/lib/mypackage to dpkg-shlibdeps so that
>        the private libraries are properly found.
>
>    When you write changelog entries, have in mind that one must be able to
>    have a reasonably clear idea of what change you did without being
>    forced to read a debdiff between both versions.

Changelog エントリには変更を記述すること
----------------------------------------------------------

(debian-devel-changes@xxxxx に流れる) changelog を読んでいると、
どのように修正したのかを明示せずに修正した問題を書いたような
お粗末な changelog エントリがやたらと目につきます。changelog
で重要なのは、変更の経緯はもちろんですが、変更内容の説明です。
いくつかの例ではっきりすればいいのですが：

悪い例：
 * lintian のエラーを修正
良い例：
 * (lintian が検出した) description 中のスペルミス (maintainance -> maintenance) を修正

悪い例：
 * 新しい dpkg-shlibdeps 用にパッケージビルド方法を修正
良い例：
 * LD_LIBRARY_PATH=/usr/lib/mypackage を dpkg-shlibdeps に渡して、プライベート
   ライブラリが適切に検出されるようにした

changelog エントリを書くときは、わざわざ両方のバージョンの
debdiff を読まなくても、それなりにきちんと変更内容がわかる
ようにしなくてはならない、ということを頭に置いてください。

ではでは。
-- 
KURASHIKI Satoru