Branko Čibej wrote:
> Julian Foad wrote:
>
>> In each log message, please try to say why the change is being made.
>> Otherwise, a future committer may want to change it back to a full
>> path, and won't know whether you had a better reason for making it a
>> relative path.
>
> I disagree. The "why" should be in a comment in the code, not in a log
> message where is't not seen immediately by anyone browsing through the
> code.
Er, I think you must have misread what I said. Comments in the code should
certainly indicate why the code does what it did ... but not why it was changed
from some previous behaviour. Comments about changes to the code belong in the
change management system, don't they?
So, in this case, the code could say "We use a relative path here as specified
in the design document" (though that's presumably implicit and redundant), and
the change log should say something to the effect of, "Changed to a relative
path because it was previously contravening the documented design."
- Julian
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Thu Sep 1 11:20:16 2005