Date: Wed, 21 Jan 2009 21:12:24 GMT From: Rene Ladan <rene@FreeBSD.org> To: Perforce Change Reviews <perforce@FreeBSD.org> Subject: PERFORCE change 156500 for review Message-ID: <200901212112.n0LLCOtu077247@repoman.freebsd.org>
next in thread | raw e-mail | index | archive | help
http://perforce.freebsd.org/chv.cgi?CH=156500 Change 156500 by rene@rene_self on 2009/01/21 21:12:09 committers-guide: phase 1 of converting CVS to CVS + SVN * comment out CVS commands specific to src, they are to be replaced by their SVN equivalents. src committers welcome to review. * Don't mention ncvs as a commit host anymore, modifying ncvs is strictly forbidden since SVN. * Mention that src converted to SVN in June 2008. * Mention that the SVN repository is automatically exported for CVSup * use 'VCS' (Version Control System) or nothing at all for texts where CVS was used generically. * Mention the SVN equivalents of the Noteworthy CVS tags * No more RELENG_5, change some RELENG_6 to stable/7 * No need for 'vcs status' except for the src tree * Add 2009. Maybe &a.cvsadm; should be changed, it now expands to "CVS Repository Meisters" While here, fix a language nit. Affected files ... .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/committers-guide/article.sgml#15 edit Differences ... ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/committers-guide/article.sgml#15 (text+ko) ==== @@ -26,6 +26,7 @@ <year>2006</year> <year>2007</year> <year>2008</year> + <year>2009</year> <holder>The FreeBSD Documentation Project</holder> </copyright> @@ -75,7 +76,7 @@ <row> <entry><emphasis>Main CVSROOT</emphasis></entry> <entry> - <hostid role="fqdn">ncvs.FreeBSD.org</hostid><literal>:</literal><filename>/home/ncvs</filename> (although also see <xref linkend="cvs.operations">). + <hostid role="fqdn">ncvs.FreeBSD.org</hostid><literal>:</literal><filename>/home/ncvs</filename> (although also see <xref linkend="vcs.operations">). </entry> </row> @@ -115,11 +116,16 @@ <row> <entry><emphasis>Noteworthy CVS Tags</emphasis></entry> - <entry><literal>RELENG_5</literal> (5.X-STABLE), + <entry> <literal>RELENG_6</literal> (6.X-STABLE), <literal>RELENG_7</literal> (7.X-STABLE), <literal>HEAD</literal> (-CURRENT) </entry> + + <entry>These tags correspond to the SVN tags + <literal>stable/6</literal>, <literal>stable/7</literal>, + and <literal>head</literal> respectively. + </entry> </row> </tbody> </tgroup> @@ -140,7 +146,7 @@ <sect1 id="committer.types"> <title>Commit Bit Types</title> - <para>The FreeBSD CVS repository has a number of components which, + <para>The FreeBSD repository has a number of components which, when combined, support the basic operating system source, documentation, third party application ports infrastructure, and various maintained utilities. When FreeBSD commit bits are @@ -228,20 +234,23 @@ </sect1> - <sect1 id="cvs.operations"> - <title>CVS Operations</title> + <sect1 id="vcs.operations"> + <title>Version Control System Operations</title> <para>It is assumed that you are already familiar with the basic operation - of CVS.</para> + 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> - <para>The &a.cvsadm; are the <quote>owners</quote> of the CVS repository and + <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 CVS by a committer. - Should you cause some repository accident, say a bad <command>cvs - import</command> or <command>cvs tag</command> operation, mail the + 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 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 CVS tree—not + For very important issues affecting the entire tree—not just a specific area—you can contact the &a.cvsadm;. Please do <emphasis>not</emphasis> contact the &a.cvsadm; for repocopies or other things that the more specific teams can handle.</para> @@ -251,16 +260,12 @@ no login shells available on the repository machines, except to the repomeisters.</para> - <note><para>Depending on the affected area of the CVS repository, + <note><para>Depending on the affected area of the repository, you should send your request for a repocopy to one of the following email addresses. Email sent to these addresses will be forwarded to the appropriate repomeisters.</para> <itemizedlist> - <listitem><para>ncvs@ - regarding <filename class="directory"> - /home/ncvs</filename>, the src - repository</para></listitem> - <listitem><para>pcvs@ - regarding <filename class="directory"> /home/pcvs</filename>, the ports repository</para></listitem> @@ -275,11 +280,13 @@ </itemizedlist> </note> - <para>The CVS tree is currently split into four distinct repositories, + <para>The tree is currently split into four distinct repositories, namely <literal>doc</literal>, <literal>ports</literal>, <literal>projects</literal> and <literal>src</literal>. These are combined under a single <literal>CVSROOT</literal> when distributed - via <application>CVSup</application> for the convenience of our users.</para> + via <application>CVSup</application> for the convenience of our users. + The <literal>src</literal> tree is automatically exported to + CVSup.</para> <note><para>Note that the <literal>www</literal> module containing sources for the <ulink url="http://www.FreeBSD.org">FreeBSD website</ulink> is @@ -323,12 +330,6 @@ <entry>projcvs.FreeBSD.org</entry> <entry>/home/projcvs</entry> </row> - - <row> - <entry>src</entry> - <entry>ncvs.FreeBSD.org</entry> - <entry>/home/ncvs</entry> - </row> </tbody> </tgroup> </table> @@ -336,7 +337,7 @@ <para>CVS operations are done remotely by setting the <envar>CVSROOT</envar> environment variable to the appropriate host and top-level directory (for example, - <hostid role="fqdn">ncvs.FreeBSD.org</hostid><literal>:</literal><filename>/home/ncvs</filename>), + <hostid role="fqdn">dcvs.FreeBSD.org</hostid><literal>:</literal><filename>/home/dcvs</filename>), and doing the appropriate check-out/check-in operations. Many committers define aliases which expand to the correct <application>cvs</application> @@ -346,14 +347,13 @@ <programlisting>alias dcvs cvs -d <replaceable>user</replaceable>@dcvs.FreeBSD.org:/home/dcvs alias pcvs cvs -d <replaceable>user</replaceable>@pcvs.FreeBSD.org:/home/pcvs -alias projcvs cvs -d <replaceable>user</replaceable>@projcvs.FreeBSD.org:/home/projcvs -alias scvs cvs -d <replaceable>user</replaceable>@ncvs.FreeBSD.org:/home/ncvs</programlisting> +alias projcvs cvs -d <replaceable>user</replaceable>@projcvs.FreeBSD.org:/home/projcvs</programlisting> <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 (like contrib-ified - sources, etc), <command>cvs import</command> should be used. + something which is wholly new + <command>cvs import</command> should be used. Refer to the &man.cvs.1; manual page for usage.</para> <note> @@ -384,7 +384,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 CVS gives to the project.</para> + value the change history that a VCS gives to the project.</para> <para>CVS reference information, tutorials, and FAQs can be found at: <ulink url="http://www.cvshome.org/docs/"></ulink>. @@ -438,6 +438,7 @@ <para>Practical FreeBSD examples:</para> +<!-- TODO convert to SVN, add examples for doc and/or ports <itemizedlist> <listitem> <para>Check out the <filename>miscfs</filename> module, @@ -527,7 +528,7 @@ <para>You will not be able to commit modifications.</para> </listitem> </itemizedlist> - +--> <para>Note that cvs stores metadata in subdirectories named <filename>CVS</filename>.</para> @@ -597,7 +598,7 @@ <para>This updates the file <filename>shazam</filename> or the contents of the <filename>shazam</filename> directory to the latest version along the branch you checked out. If you - checked out a <quote>point in time</quote>, does nothing + checked out a <quote>point in time</quote>, it does nothing unless the tags have moved in the repository or some other weird stuff is going on.</para> @@ -616,11 +617,12 @@ <entry><option>-A</option></entry> <entry>Update to head of main branch.</entry> </row> - +<!--XXX obsolete? <row> <entry><option>-j<replaceable>rev</replaceable></option></entry> <entry>More magic (see below).</entry> </row> +--> </tbody> </tgroup> </informaltable> @@ -722,6 +724,7 @@ <literal>></literal> signs and the revision number you updated to.</para> +<!--XXX obsolete? <para>The <option>-j</option> option is slightly voodoo. It updates the local file to the specified revision as if you used <option>-r</option>, but it does not change the recorded @@ -752,10 +755,11 @@ <para>You will almost certainly get a conflict because of the <literal>$Id$</literal> (or in FreeBSD's case, - <literal>$<!-- stop expansion -->FreeBSD<!-- stop expansion -->$</literal>) + <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$</literal> line, leaving the original <literal>$Id$</literal> line intact).</para> +--> </listitem> <listitem> @@ -941,7 +945,8 @@ <itemizedlist> <listitem> <para>verify which branch you are committing to, using - <command>cvs status</command>.</para> + <command>svn status</command>. This is only needed for + the src tree, as the other trees are not branched.</para> </listitem> <listitem> @@ -952,7 +957,7 @@ <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>cvs commit</command> + than the ones you intended - <command>vcs commit</command> without any arguments will commit every modification in your current working directory and every subdirectory.</para> </listitem> @@ -1058,9 +1063,7 @@ ssh connection to the repository machine. First, put this configuration into your <filename>~/.ssh/config</filename>:</para> - <programlisting>Host ncvs.FreeBSD.org - ControlPath /home/<replaceable>user</replaceable>/.ssh/cvs.cpath -Host dcvs.FreeBSD.org + <programlisting>Host dcvs.FreeBSD.org ControlPath /home/<replaceable>user</replaceable>/.ssh/cvs.cpath Host projcvs.FreeBSD.org ControlPath /home/<replaceable>user</replaceable>/.ssh/cvs.cpath @@ -1325,14 +1328,14 @@ areas, to our shame), the same applies. If, however, you are about to modify something which is clearly being actively maintained by someone else (and it is only by watching the - <literal>cvs-committers</literal> mailing list that you can + <literal><replaceable>repository</replaceable>-committers</literal> mailing list that you can really get a feel for just what is and is not) then consider sending the change to them instead, just as you would have before becoming a committer. For ports, you should contact the 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>cvs log</command> + be, it may help to scan the output of <command>vcs 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 @@ -1346,10 +1349,10 @@ <para>If you are unsure about a commit for any reason at all, have it reviewed by <literal>-hackers</literal> before committing. Better to have it flamed then and there - rather than when it is part of the CVS repository. If you do + 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 CVS we + again until the matter is settled. Remember – with VCS we can always change it back.</para> <para>Do not impugn the intentions of someone you disagree with. @@ -1627,7 +1630,7 @@ <term>&a.committers;</term> <listitem> - <para>cvs-committers is the entity that CVS uses to send you all your + <para><replaceable>repository</replaceable>-committers is the entity that VCS 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> @@ -1976,7 +1979,7 @@ <para>Discuss any significant change <emphasis>before</emphasis> committing.</para> - <para>The CVS repository is not where changes should be + <para>The VCS repository is not where changes should be initially submitted for correctness or argued over, that should happen first in the mailing lists and the commit should only happen once something resembling consensus has @@ -2013,7 +2016,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 CVS logs for the file(s) in + you can also look at the VCS logs for the file(s) in question and see if someone has been working recently or predominantly in that area.</para> @@ -2035,7 +2038,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 CVS makes it unnecessary to have an ongoing + course) but VCS 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 @@ -2265,7 +2268,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>cvs diff</command>, which can hide + change when using <command>vcs 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 @@ -3239,7 +3242,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 CVS commits and the mailing list + well (except things specific to VCS commits and the mailing list memberships that go with them). In particular, we recommend that you read:</para> @@ -3357,18 +3360,19 @@ <qandaentry> <question> - <para>How do I add a new file to a CVS branch?</para> + <para>How do I add a new file to a VCS 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>cvs add</command> as you normally would. For + <command>vcs add</command> as you normally would. For example, if you wanted to MFC the file - <filename>src/sys/alpha/include/smp.h</filename> from HEAD - to RELENG_6 and it does not exist in RELENG_6 yet, you would + <filename>src/sys/alpha/include/smp.h</filename> from head + to stable/7 and it does not exist in stable/7 yet, you would use the following steps:</para> +<!--TODO update to SVN <example> <title>MFC'ing a New File</title> @@ -3390,6 +3394,7 @@ &prompt.user; <userinput>cvs commit</userinput> </screen> </example> +--> </answer> </qandaentry>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200901212112.n0LLCOtu077247>