cvs commit: ports UPDATING

[Doug Barton]

Alexey Dokuchaev wrote:
> On Mon, Aug 10, 2009 at 05:22:22PM -0700, Doug Barton wrote:
>> Alexey Dokuchaev wrote:
>>> danfe       2009-08-10 22:41:23 UTC
>>>
>>>   FreeBSD ports repository
>>>
>>>   Modified files:
>>>     .                    UPDATING 
>>>   Log:
>>>   Beautify.
>> Can we get a little more detail in the log messages please? :)  I'm
>> all for brevity being the soul of wit and all that ....
> 
> Well, it's really hard to add anything here.  :-)  


"Update line breaks, punctuation, and white space on the recent KDE4
and libtool entries to improve readability."

I'm picking on a trivial case here, so sorry Alexey, but from what I
can see the trend is getting worse, not better.

There are 3 main rules for log entries:
1. Keep in mind that people will be reading this years from now when
you are long gone.
2. A brief summary of WHAT was done makes browsing the logs and
finding specific entries easier. However if necessary that can always
be discovered with diff, so
3. Always err on the side of including more information about WHY a
change was made.

Once again, this is a trivial case, but practice makes perfect ...


Doug

-- 

    This .signature sanitized for your protection