Add a tip about the -F option of `cvs commit' that can be used to

speed up commits, avoid locking parts of the CVS tree for a very
long time and lets the committer take his time when writing the
commit message.

Hopefully, this way the quality of commit messages is easier to
control and we'll save ourselves some of the problems that can
result from hickups of the CVS repo-locking mechanism.

Approved by:	re (Hiroki Sato)
This commit is contained in:
Giorgos Keramidas 2004-10-11 16:48:38 +00:00
parent a978c10d52
commit 22d00e050e
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=22594

View file

@ -727,11 +727,11 @@ alias scvs env CVS_RSH=ssh cvs -d <replaceable>user</replaceable>@ncvs.FreeBSD.o
</itemizedlist>
<para>You will almost certainly get a conflict because
of the <literal>$Id: article.sgml,v 1.213 2004-09-20 11:04:00 marck Exp $</literal> (or in FreeBSD's case,
of the <literal>$Id: article.sgml,v 1.214 2004-10-11 16:48:38 keramida Exp $</literal> (or in FreeBSD's case,
<literal>$<!-- stop expansion -->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.213 2004-09-20 11:04:00 marck Exp $</literal> line,
leaving the original <literal>$Id: article.sgml,v 1.213 2004-09-20 11:04:00 marck Exp $</literal> line intact).</para>
(remove the marker lines and the second <literal>$Id: article.sgml,v 1.214 2004-10-11 16:48:38 keramida Exp $</literal> line,
leaving the original <literal>$Id: article.sgml,v 1.214 2004-10-11 16:48:38 keramida Exp $</literal> line intact).</para>
</listitem>
<listitem>
@ -1015,8 +1015,18 @@ checkout -P</programlisting>
locks the directory you are working with and will prevent other
developers from committing into the same directory. If you have
to type a long commit message, type it before executing
<command>cvs commit</command>, and insert it into the commit
message.</para>
<command>cvs commit</command> and insert it into the commit
message or save it in a file before committing and use the
<option>-F</option> option of CVS to read the commit message from
that file, i.e.</para>
<screen>&prompt.user; <userinput>vi logmsg</userinput>
&prompt.user; <userinput>cvs ci -F logmsg shazam</userinput></screen>
<para>This is the fastest way of passing a commit message to CVS but
you should be careful when editing the <filename>logmsg</filename>
file before the commit, because CVS won't give you a chance to edit
the message when you do the actual commit.</para>
</listitem>
</orderedlist>