Developer's Guide

[Roozbeh Pournader <roozbeh sharif edu>]

Attached is a suggested patch for the Developer's Guide document,
against the current version in CVS.

One issue I didn't patch, is that 'epoch' is never explained in the
document, although it's referenced twice. It certainly needs to be
written about, since there are people who don't know what it is (I
didn't).

Changes are:

1. Fixed a typo in the legal notice.
2. Explained that anonymous access, as specified in the CVS guidelines,
is not enough for changing the files on the server.
3. Mentioned that the Guidelines on RPM should be used as a checklist
(almost all of its items were already explained elsewhere).
4. Mentioned that 'all' of the criteria should be met for a Beta
Exception (was I right?)

roozbeh

Index: legalnotice.xml
===================================================================
RCS file: /usr/local/CVS/fedora-docs/legalnotice.xml,v
retrieving revision 1.3
diff -u -3 -p -r1.3 legalnotice.xml
--- legalnotice.xml	22 Sep 2003 16:24:33 -0000	1.3
+++ legalnotice.xml	25 Sep 2003 19:56:11 -0000
@@ -12,7 +12,7 @@
   <para>
     This document may be copied and distributed in any medium, either
     commercially or noncommercially, provided that the GNU Free Documentation
-    License (FDL0, the copyright notices, and the license notice saying the GNU
+    License (FDL), the copyright notices, and the license notice saying the GNU
     FDL applies to the document are reproduced in all copies, and that you add
     no other conditions whatsoever to those of th GNU FDL.
   </para>
Index: common/cvs.xml
===================================================================
RCS file: /usr/local/CVS/fedora-docs/common/cvs.xml,v
retrieving revision 1.2
diff -u -3 -p -r1.2 cvs.xml
--- common/cvs.xml	22 Sep 2003 16:47:58 -0000	1.2
+++ common/cvs.xml	25 Sep 2003 19:56:17 -0000
@@ -212,6 +212,9 @@
 <computeroutput>export CVSROOT=:pserver:anonymous rhlinux redhat com:/usr/local/CVS
 </computeroutput> 
 </screen>    
+	  <para>(Replace <computeroutput>anonymous</computeroutput> with
+	    your username on the CVS server, if you have one.)
+	  </para>
 	</listitem>
 	<listitem>
 	  <para>Use the command <command>source ~/.bashrc</command> to have the
@@ -429,6 +432,11 @@ ml,v
 <command>cvs commit -m "some log message" <filename><replaceable>&lt;filename&gt;</replaceable></filename></command>
 </screen>
 
+	<para>
+	  (Note that you will need an account on the CVS server in order to
+	  change files on the server. The <screen>anonymous</screen>
+	  username won't do.)
+	</para>
 	<para>
 	  The log message should be as descriptive as possible so that you and
 	  anyone else working on the module understands what changed. Using a
Index: developer-guide/developers-guide.xml
===================================================================
RCS file: /usr/local/CVS/fedora-docs/developer-guide/developers-guide.xml,v
retrieving revision 1.1
diff -u -3 -p -r1.1 developers-guide.xml
--- developer-guide/developers-guide.xml	22 Sep 2003 16:28:26 -0000	1.1
+++ developer-guide/developers-guide.xml	25 Sep 2003 19:56:28 -0000
@@ -7,7 +7,7 @@
 <!ENTITY PROJECT-TITLE "Fedora Project"> <!-- Set the default name -->
 <!ENTITY DISTRO "Fedora Core"> <!-- Set the default name -->
 
-<!ENTITY BOOKID "developers-guide-0.1.1 (2003-09-16)"> <!-- change version of manual and date here -->
+<!ENTITY BOOKID "developers-guide-0.1.2 (2003-09-25)"> <!-- change version of manual and date here -->
 
 <!ENTITY LEGALNOTICE SYSTEM "../legalnotice.xml">
 <!ENTITY CVS SYSTEM "../common/cvs.xml">
@@ -99,8 +99,8 @@
 
       <para>
 	For large important packages with a maintained developer base, shipping
-	beta/pre-release versions is OK during a development cycle, provided the
-	following are met:
+	beta/pre-release versions is OK during a development cycle, provided
+	all the following are met:
       </para>
       <itemizedlist>
 	<listitem>
@@ -725,7 +725,7 @@ fi
       
       <para>
 	Adhere to the follow rules to make sure the package is packaged
-	properly:
+	properly. This should be used as a checklist:
       </para>
 
       <orderedlist>