aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO_8859-1/articles
diff options
context:
space:
mode:
authorNik Clayton <nik@FreeBSD.org>2000-07-23 16:22:16 +0000
committerNik Clayton <nik@FreeBSD.org>2000-07-23 16:22:16 +0000
commita26dd557ebde405111c45ca755aa00501ea1eae2 (patch)
treede4551fa36e00f56b9e0c6338c5376349db74a75 /en_US.ISO_8859-1/articles
parent5293e57422e4858b770ad2ab96833cf6a9e91310 (diff)
downloaddoc-a26dd557ebde405111c45ca755aa00501ea1eae2.tar.gz
doc-a26dd557ebde405111c45ca755aa00501ea1eae2.zip
Rewrite the abstract. This isn't just a CVS document any more.
Shift the information about the repository-meisters in to the first section about CVS. Re-write the list of things that a new committer should do as a numbered list. Mention the existence of the xearth committers' markers file.
Notes
Notes: svn path=/head/; revision=7699
Diffstat (limited to 'en_US.ISO_8859-1/articles')
-rw-r--r--en_US.ISO_8859-1/articles/committers-guide/article.sgml135
1 files changed, 76 insertions, 59 deletions
diff --git a/en_US.ISO_8859-1/articles/committers-guide/article.sgml b/en_US.ISO_8859-1/articles/committers-guide/article.sgml
index a6293c9c30..6899ce8dba 100644
--- a/en_US.ISO_8859-1/articles/committers-guide/article.sgml
+++ b/en_US.ISO_8859-1/articles/committers-guide/article.sgml
@@ -16,7 +16,7 @@
</author>
</authorgroup>
- <pubdate>$Date: 2000-07-13 21:07:52 $</pubdate>
+ <pubdate>$Date: 2000-07-23 16:22:16 $</pubdate>
<copyright>
<year>1999</year>
@@ -25,16 +25,10 @@
</copyright>
<abstract>
- <para>Welcome, committer, to the FreeBSD development
- team!</para>
-
- <para>The following docs are provided to orient you on doing CVS
- operations on the FreeBSD central repository machine. A basic
- familiarity with CVS is already assumed, although CVS
- reference information, tutorials, and FAQs can also be found
- at: <ulink url="http://www.cyclic.com/CVS/support">http://www.cyclic.com/CVS/support</ulink></para>
-
- <para>Good luck, and welcome aboard!</para>
+ <para>This document provides information for the FreeBSD committer
+ community. All new committers should read this document before they
+ start, and existing committers are strongly encouraged to review it
+ from time to time.</para>
</abstract>
</artheader>
@@ -111,6 +105,24 @@
<sect1 id="cvs.operations">
<title>CVS Operations</title>
+ <para>It is assumed that you are already familiar with the basic operation
+ of CVS.</para>
+
+ <para>The CVS Repository Meisters (Peter Wemm and John Polstra)
+ are the <quote>owners</quote> of the CVS repository and are
+ responsible for any and <emphasis>all</emphasis> direct
+ modification of it for the purposes of cleanup or fixing some
+ grievous abuse of CVS by a committer. No one else should
+ attempt to touch the repository directly. Should you cause some
+ repository accident, say a bad cvs import or tag operation, do
+ <emphasis role="bold">not</emphasis> attempt to fix it yourself!
+ Mail or call John or Peter immediately and report the problem to
+ one of them instead. The only ones allowed to directly fiddle
+ the repository bits are the repomeisters. Satoshi Asami is also a
+ repomeister for the <filename>ports/</filename> portion of the
+ tree. Mark Murray is the repomeister for the International
+ Crypto Repository in South Africa.</para>
+
<para>CVS operations are usually done by logging into
<hostid>freefall</hostid>, making sure the
<envar>CVSROOT</envar> environment variable is set to
@@ -144,61 +156,66 @@
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 CVS gives to the project.</para>
+
+ <para>CVS reference information, tutorials, and FAQs can also be found at:
+ <ulink
+ url="http://www.cyclic.com/CVS/support">http://www.cyclic.com/CVS/support</ulink></para>
+
</sect1>
<sect1 id="conventions">
<title>Conventions and Traditions</title>
- <para>The CVS Repository Meisters (Peter Wemm and John Polstra)
- are the <quote>owners</quote> of the CVS repository and are
- responsible for any and <emphasis>all</emphasis> direct
- modification of it for the purposes of cleanup or fixing some
- grievous abuse of CVS by a committer. No one else should
- attempt to touch the repository directly. Should you cause some
- repository accident, say a bad cvs import or tag operation, do
- <emphasis role="bold">not</emphasis> attempt to fix it yourself!
- Mail or call John or Peter immediately and report the problem to
- one of them instead. The only ones allowed to directly fiddle
- the repository bits are the repomeisters. Satoshi Asami is also a
- repomeister for the <filename>ports/</filename> portion of the
- tree. Mark Murray is the repomeister for the International
- Crypto Repository in South Africa.</para>
+ <para>As a new committer there are a number of things you should do
+ first.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Add yourself to the <quote>Developer's</quote> section of the
+ Handbook and remove yourself from the <quote>Additional
+ Contributors</quote> section.</para>
+
+ <para>This is a relatively easy task, but remains a good first test of
+ your CVS skills.</para>
+ </listitem>
- <para>If you are a new committer, your very first commit should be
- to add yourself to the developer's section (D.2) of the
- Handbook and remove yourself from the Additional Contributors section
- (19.6). Figuring out how to check the handbook out and add an
- entry for yourself is relatively easy but still remains a good
- first test of your CVS skills. If you can handle that one,
- you are probably going to be ok.</para>
-
- <para>Your second commit should be to add an entry for yourself to
- <filename>www/en/news/newsflash.sgml</filename>. Look for the other
- entries that look like <quote>A new committer</quote> and follow the
- format.</para>
-
- <para>Your next step should be to introduce yourself to the other
- committers, otherwise no one will have any idea who you are or
- what you are working on. You do not have to write a comprehensive
- biography, just write a paragraph or two about who you are and
- what you plan to be working on as a committer in FreeBSD. Email
- this to <email>cvs-committers@FreeBSD.org</email> and you will be on
- your way!</para>
-
- <para>Also, be sure to log into <hostid>hub.FreeBSD.org</hostid>
- and create a
- <filename>/var/forward/<replaceable>user</replaceable></filename>
- (where <replaceable>user</replaceable> is your username) file
- containing the e-mail address where you want mail addressed
- to <replaceable>yourusername</replaceable>@FreeBSD.org
- to be forwarded. This includes all of the commit messages as
- well as any other mail addressed to
- <email>cvs-committers@FreeBSD.org</email>. Really large
- mailboxes which have taken up permanent residence on
- <hostid>hub</hostid> often get <quote>accidently</quote>
- truncated without warning, so forward it or read it and you will
- not lose it.</para>
+ <listitem>
+ <para>Add an entry for yourself to
+ <filename>www/en/news/newsflash.sgml</filename>. Look for the other
+ entries that look like <quote>A new committer</quote> and follow the
+ format.</para>
+ </listitem>
+ <listitem>
+ <para>Some people also add an entry for themselves to
+ <filename>ports/astro/xearth/files/freebsd.committers.markers</filename>.</para>
+ </listitem>
+
+ <listitem>
+ <para>Introduce yourself to the other committers, otherwise no one
+ will have any idea who you are or what you are working on. You do
+ not have to write a comprehensive biography, just write a paragraph
+ or two about who you are and what you plan to be working on as a
+ committer in FreeBSD. Email this to
+ <email>cvs-committers@FreeBSD.org</email> and you will be on your
+ way!</para>
+ </listitem>
+
+ <listitem>
+ <para>Log into <hostid>hub.FreeBSD.org</hostid> and create a
+ <filename>/var/forward/<replaceable>user</replaceable></filename>
+ (where <replaceable>user</replaceable> is your username) file
+ containing the e-mail address where you want mail addressed to
+ <replaceable>yourusername</replaceable>@FreeBSD.org to be forwarded.
+ This includes all of the commit messages as well as any other mail
+ addressed to <email>cvs-committers@FreeBSD.org</email>. Really
+ large mailboxes which have taken up permanent residence on
+ <hostid>hub</hostid> often get <quote>accidently</quote> truncated
+ without warning, so forward it or read it and you will not lose
+ it.</para>
+ </listitem>
+ </itemizedlist>
+
<para>All new committers also have a mentor assigned to them for
the first few months. Your mentor is more or less responsible for
explaining anything which is confusing to you and is also