Date: Fri, 27 Mar 2009 23:11:57 GMT From: Rene Ladan <rene@FreeBSD.org> To: Perforce Change Reviews <perforce@FreeBSD.org> Subject: PERFORCE change 159936 for review Message-ID: <200903272311.n2RNBvDf093888@repoman.freebsd.org>
index | next in thread | raw e-mail
http://perforce.freebsd.org/chv.cgi?CH=159936 Change 159936 by rene@rene_self on 2009/03/27 23:11:35 Replace all instances of "VCS" by a description in natural English. Submitted by: pgj Affected files ... .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/committers-guide/article.sgml#21 edit Differences ... ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/committers-guide/article.sgml#21 (text+ko) ==== @@ -240,15 +240,13 @@ <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 - generic term <literal>VCS</literal> (or none at all) will be used - unless the text is specific to CVS or SVN.</para> + CVS, but as of June 2008, Subversion is used for the src tree.</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 unfortunate abuse of VCS by a committer. + cleanup or fixing some unfortunate abuse of the version control system by a committer. Should you cause some repository accident, say a bad - import or tag creation, mail the + import or a bad 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 @@ -352,9 +350,7 @@ <para>This way they can do all CVS operations locally and use <command><replaceable>X</replaceable>cvs commit</command> for committing - to the official CVS tree. If you wish to add - something which is wholly new, - <command>cvs import</command> should be used. + to the official CVS tree. Refer to the &man.cvs.1; manual page for usage.</para> <note> @@ -385,7 +381,7 @@ to their new name and/or location and let you know when it is done. The purpose of a repository copy is to preserve file change history, or logs. We in the FreeBSD Project greatly - value the change history that a VCS gives to the project.</para> + value the change history that a version control system gives to the project.</para> <para>CVS reference information, tutorials, and FAQs can be found at: <ulink url="http://www.cvshome.org/docs/"></ulink>. @@ -447,14 +443,15 @@ <screen>&prompt.user; <userinput>cvs co Tools</userinput></screen> <para>You now have a directory named <filename>ports/Tools</filename> - with subdirectories <filename>portbuild</filename>, <filename>scripts</filename>, and <filename>CVS</filename>.</para> + with subdirectories <filename>portbuild</filename>, + <filename>scripts</filename>, and + <filename>CVS</filename>.</para> </listitem> <listitem> <para>Check out the same files, but with full path:</para> - <screen>&prompt.user; <userinput>cvs co ports/Tools</userinput></screen> - + <screen>&prompt.user; <userinput>cvs co ports/Tools</userinput></screen> <para>You now have a directory named <filename>ports</filename>, with subdirectories <filename>CVS</filename> and <filename>Tools</filename>. The <filename>ports/Tools</filename> directory has @@ -904,15 +901,14 @@ </listitem> <listitem> - <para>review your diffs, using - <command><replaceable>vcs</replaceable> diff</command></para> + <para>review your diffs, using the diff command of the version control system.</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><replaceable>vcs</replaceable> commit</command> - without any arguments will commit every modification in your + than the ones you intended — a commit operation + without any arguments usually will commit every modification in your current working directory and every subdirectory.</para> </listitem> </orderedlist> @@ -1289,7 +1285,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><replaceable>vcs</replaceable> log</command> + be, it may help to scan the revision history 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 @@ -1306,7 +1302,7 @@ rather than when it is part of the repository. If you do happen to commit something which results in controversy erupting, you may also wish to consider backing the change out - again until the matter is settled. Remember – with VCS we + again until the matter is settled. Remember – with a version control system we can always change it back.</para> <para>Do not impugn the intentions of someone you disagree with. @@ -1584,7 +1580,7 @@ <term>&a.committers;</term> <listitem> - <para><replaceable>repository</replaceable>-committers is the entity that VCS uses to send you all your + <para><replaceable>repository</replaceable>-committers is the entity that the version control system uses to send you all your commit messages. You should <emphasis>never</emphasis> send email directly to this list. You should only send replies to this list when they are short and are directly related to a commit.</para> @@ -1970,7 +1966,7 @@ maintainer need to be reviewed by at least one other maintainer. In cases where the <quote>maintainer-ship</quote> of something is not clear, - you can also look at the VCS logs for the file(s) in + you can also look at the repository logs for the file(s) in question and see if someone has been working recently or predominantly in that area.</para> @@ -1992,7 +1988,7 @@ <para>This may be hard to swallow in times of conflict (when each side is convinced that they are in the right, of - course) but VCS makes it unnecessary to have an ongoing + course) but a version control system makes it unnecessary to have an ongoing dispute raging when it is far easier to simply reverse the disputed change, get everyone calmed down again and then try to figure out what is the best way to proceed. If the change @@ -2222,7 +2218,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><replaceable>vcs</replaceable> diff</command>, which can hide + change when asking for differences between revisions, 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 @@ -3196,7 +3192,7 @@ and dedication in working on Problem Reports.</para> <para>Almost all of this document will apply to these developers as - well (except things specific to VCS commits and the mailing list + well (except things specific to commits and the mailing list memberships that go with them). In particular, we recommend that you read:</para> @@ -3314,13 +3310,13 @@ <qandaentry> <question> - <para>How do I add a new file to a VCS branch?</para> + <para>How do I add a new file to a branch?</para> </question> <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><replaceable>vcs</replaceable> add</command> as you normally would. This works + the add operation 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 thehelp
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200903272311.n2RNBvDf093888>