Date: Fri, 27 Mar 2009 15:44:15 GMT From: Rene Ladan <rene@FreeBSD.org> To: Perforce Change Reviews <perforce@FreeBSD.org> Subject: PERFORCE change 159910 for review Message-ID: <200903271544.n2RFiFJB006163@repoman.freebsd.org>
next in thread | raw e-mail | index | archive | help
http://perforce.freebsd.org/chv.cgi?CH=159910 Change 159910 by rene@rene_self on 2009/03/27 15:44:12 Committers guide: * link to svn book at red-bean.com * mark vcs as replaceable in command tags * language nits Submitted by: trhodes,gabor Affected files ... .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/committers-guide/article.sgml#20 edit Differences ... ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/committers-guide/article.sgml#20 (text+ko) ==== @@ -240,15 +240,15 @@ <para>It is assumed that you are already familiar with the basic operation of the version control systems in use. Traditionally this was - CVS, but as of June 2008 Subversion is used for the src tree. The + CVS, but as of June 2008, Subversion is used for the src tree. The generic term <literal>VCS</literal> (or none at all) will be used unless the text is specific to CVS or SVN.</para> <para>The &a.cvsadm; are the <quote>owners</quote> of the repository and are responsible for direct modification of it for the purposes of - cleanup or fixing some grievous abuse of VCS by a committer. - Should you cause some repository accident, say a bad <command>vcs - import</command> or <command>vcs tag</command> operation, mail the + cleanup or fixing some unfortunate abuse of VCS by a committer. + Should you cause some repository accident, say a bad + import or tag creation, mail the responsible part of &a.cvsadm;, as stated in the table below, (or call one of them) and report the problem. For very important issues affecting the entire tree—not @@ -287,7 +287,7 @@ combined under a single <literal>CVSROOT</literal> when distributed via <application>CVSup</application> for the convenience of our users. The <literal>src</literal> tree is automatically exported to - CVSup.</para> + CVS.</para> <note><para>Note that the <literal>www</literal> module containing sources for the <ulink url="http://www.FreeBSD.org">FreeBSD website</ulink> is @@ -848,7 +848,8 @@ things missing in Subversion when compared to CVS</ulink>. The notes at <ulink url="http://people.freebsd.org/~peter/svn_notes.txt"></ulink>; - might also be useful.</para> + might also be useful. Subversion is also described in-depth + in <ulink url="http://svnbook-red-bean.com/">Version Control with Subversion</ulink>.</para> <itemizedlist> <listitem> @@ -904,13 +905,13 @@ <listitem> <para>review your diffs, using - <command>cvs diff</command></para> + <command><replaceable>vcs</replaceable> diff</command></para> </listitem> </itemizedlist> <para>Also, ALWAYS specify which files to commit explicitly on the command line, so you do not accidentally commit other files - than the ones you intended - <command>vcs commit</command> + than the ones you intended - <command><replaceable>vcs</replaceable> commit</command> without any arguments will commit every modification in your current working directory and every subdirectory.</para> </listitem> @@ -1288,7 +1289,7 @@ listed <makevar>MAINTAINER</makevar> in the <filename>Makefile</filename>. For other parts of the repository, if you are unsure who the active maintainer might - be, it may help to scan the output of <command>vcs log</command> + be, it may help to scan the output of <command><replaceable>vcs</replaceable> log</command> to see who has committed changes in the past. &a.fenner; has written a nice shell script that can help determine who the active maintainer might be. It lists each person who has @@ -2221,7 +2222,7 @@ <para>Do not mix style fixes with new functionality. A style fix is any change which does not modify the functionality of the code. Mixing the changes obfuscates the functionality - change when using <command>vcs diff</command>, which can hide + change when using <command><replaceable>vcs</replaceable> diff</command>, which can hide any new bugs. Do not include whitespace changes with content changes in commits to <filename>doc/</filename> or <filename>www/</filename>. The extra clutter in the diffs @@ -3319,7 +3320,7 @@ <answer> <para>To add a file onto a branch, simply checkout or update to the branch you want to add to and then add the file using - <command>vcs add</command> as you normally would. This works + <command><replaceable>vcs</replaceable> add</command> as you normally would. This works fine for the <literal>doc</literal> and <literal>ports</literal> trees. The <literal>src</literal> tree uses SVN and requires more care because of the
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200903271544.n2RFiFJB006163>