Source-Changes-D archive

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

The use of "previous". (Re: CVS commit: src/sys/nfs)



On Thu, Sep 03, 2009 at 08:59:13PM +0000, Thor Lancelot Simon wrote:
> Module Name:  src
> Committed By: tls
> Date:         Thu Sep  3 20:59:13 UTC 2009
> 
> Modified Files:
>       src/sys/nfs: nfs_srvsocket.c
> 
> Log Message:
> Missed this file in previous commit, accidentally checked in fix to local
> repository copy!  Sorry about that, folks.

Thanks for the fix(es).

However, please describe the actual change.  

Everyone, please remember that from the perspective of someone reading
cvs logs later, "previous" only makes sense for changes to the same
file.  It's perfectly appropriate and convenient there.

Otherwise it can be very difficult (or at least annoying) to figure
out what the comment refers to.

At least in this case, there's enough extra text about what went wrong
to suggest a reader go look for changes in nearby files on nearby
dates by the same author.  Better yet, the relevant changes *are* 
nearby; sometimes none of these things is true.  

Remember your audience.

--
Dan.

Attachment: pgpNwO0EzHovh.pgp
Description: PGP signature



Home | Main Index | Thread Index | Old Index