os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

After much agonizing, attempt to refine the commit log composition

Browse source 
instructions.  The potentially conflicting instructions could be taken
to encourage less than ideal commit logs.  Explicitly say that we're
after a clear, concise and reasonable summary of the change.

Reviewed by:	obrien
This commit is contained in:
Peter Wemm 2001-11-28 21:25:56 +00:00
parent 08d52997c4
commit b9a19509fb
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=11313
1 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

17
en_US.ISO8859-1/articles/committers-guide/article.sgml
View file

@ -522,11 +522,11 @@
</itemizedlist>
<para>You will almost certainly get a conflict because
of the <literal>$Id: article.sgml,v 1.89 2001-11-05 19:13:01 chern Exp $</literal> (or in FreeBSD's case,
of the <literal>$Id: article.sgml,v 1.90 2001-11-28 21:25:56 peter Exp $</literal> (or in FreeBSD's case,
<literal>$FreeBSD<!-- stop expansion -->$</literal>) lines, so you will have to edit
the file to resolve the conflict (remove the marker lines and
the second <literal>$Id: article.sgml,v 1.89 2001-11-05 19:13:01 chern Exp $</literal> line, leaving the original
<literal>$Id: article.sgml,v 1.89 2001-11-05 19:13:01 chern Exp $</literal> line intact).</para>
the second <literal>$Id: article.sgml,v 1.90 2001-11-28 21:25:56 peter Exp $</literal> line, leaving the original
<literal>$Id: article.sgml,v 1.90 2001-11-28 21:25:56 peter Exp $</literal> line intact).</para>
</listitem>
<listitem>
@ -677,10 +677,13 @@
your source file. It is also an invaluable aid to deciding
which changes to MFC and which not to MFC.</para>
<para>Do not waste space in the commit messages explaining
<emphasis>what</emphasis> you did. That is what
<command>cvs diff</command> is for. Instead, tell us
<emphasis>why</emphasis> you did it.</para>
<para>Commit messages should be clear, concise and provide
a reasonable summary to give an indication of what was
changed and why.</para>
<para>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.</para>
<para>Avoid committing several unrelated changes in one go. It
makes merging difficult, and also makes it harder to determine