Date: Tue, 13 Apr 2004 15:41:01 -0700 From: Kris Kennaway <kris@obsecurity.org> To: Archie Cobbs <archie@dellroad.org> Cc: Kris Kennaway <kris@obsecurity.org> Subject: Re: cvs commit: ports/net/mpd Makefile ports/net/mpd/files patch-aa Message-ID: <20040413224101.GA38506@xor.obsecurity.org> In-Reply-To: <200404132228.i3DMSf8O004179@arch20m.dellroad.org> References: <20040413220052.GB37771@xor.obsecurity.org> <200404132228.i3DMSf8O004179@arch20m.dellroad.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--SLDf9lqlvOQaIe6s Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Tue, Apr 13, 2004 at 05:28:41PM -0500, Archie Cobbs wrote: > Kris Kennaway wrote: > > > Log: > > > Include patch that fixes ports/62477. > >=20 > > Commit logs should include a brief description of what the patch does, > > not just an external reference. >=20 > Is there some official policy about this?? >=20 > One might think that "patch that fixes ports/62477" would > be the most appropriate way to describe what the patch does... > it avoids duplicating information described more completely > and accurately elsewhere, but gives an unabiguous reference > to that information. The Committer's Guide says: Good commit messages are important. They tell others why you did the changes you did, not just right here and now, but months or years from now when someone wonders why some seemingly illogical or inefficient piece of code snuck into your source file. It is also an invaluable aid to deciding which changes to MFC and which not to MFC. Commit messages should be clear, concise and provide a reasonable summary to give an indication of what was changed and why. Commit messages should provide enough information to enable a third party to decide if the change is relevant to them and if they need to read the change itself. Admittedly, it doesn't come right out and say "don't just give a reference to an external PR with no other explanation", but the intent is "they should have a self-contained description of the problem and solution, and you should use the 'PR:' line in the CVS template to link to an external PR with more information if necessary". This is certainly the FreeBSD tradition. Kris --SLDf9lqlvOQaIe6s Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.4 (FreeBSD) iD8DBQFAfGx9Wry0BWjoQKURAqXdAJ9EmtKBZx2ekKuzjZE3XGf6dwcytQCfYOmN ijo+C/5/1Hqy71nV4MqQb1w= =J00a -----END PGP SIGNATURE----- --SLDf9lqlvOQaIe6s--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20040413224101.GA38506>