RFC: update to HACKING

[Robert Schuster <theBohemian at gmx dot net>]

Hi,
I updated HACKING with some info I found valuable as being not so experienced
with GCJ build machinery.

Ok, for commit?

Btw: Mark told me that there is some automatic that makes GCJ use the correct
file when natFooPosix, natFooWindows and natFooEcos are available but only
natFooPosix is part of the nat_source_files variable. Can someone explain this
to me or add the neccessary info to HACKING after I applied this patch?

ChangeLog:

2006-10-03  Robert Schuster  <robertschuster@fsfe.org>

        * HACKING: Added info about adding/removing C++ source files,
        applied minor corrections, added index and captions.

cya
Robert

Index: HACKING
===================================================================
--- HACKING	(Revision 117275)
+++ HACKING	(Arbeitskopie)
@@ -5,8 +5,15 @@
 following things. There are probably lots of other things that should be
 explained in this HACKING file. Please add them if you discover them :)
 
---
+Current items:
+  - Importing a new GNU Classpath release
+  - Using a CVS checkout of GNU Classpath
+  - Adding classes to java.lang, java.io, java.util and subpackages
+  - Adding or removing C++ source files
 
+Importing a new GNU Classpath release
+-------------------------------------
+
 libgcj uses GNU Classpath as an upstream provider.  Snapshots of
 Classpath are imported into the libgcj source tree.  Some classes are
 overridden by local versions; these files still appear in the libgcj
@@ -50,7 +57,7 @@
 - Use auto* to create configure, Makefile.in, etc
   Make sure you have Automake 1.9.6 installed. Exactly that version!
   You have to make sure to use the gcc libtool.m4 and gcc lt* scripts
-  cd .../classpath
+  cd classpath
   cp ../../lt* .
   cp ../../config.sub ../../config.guess .
   aclocal -I m4 -I ../.. -I ../../config
@@ -59,7 +66,7 @@
   automake
   rm -rf autom4te.cache
   cd ..
-  scripts/makemake.tcl > sources.am
+  ./scripts/makemake.tcl > sources.am
   automake
 - Build, fix, till everything works.
   Possibly update the gcj/javaprims.h file with scripts/classes.pl
@@ -86,7 +93,8 @@
 * On a release branch to fix a bug, where a full-scale import of
   Classpath is not advisable.
 
---
+Using a CVS checkout of GNU Classpath
+-------------------------------------
 
 You can develop in a GCC tree using a CVS checkout of Classpath, most
 of the time.  (The exceptions are when an incompatible change has been
@@ -101,7 +109,7 @@
 * cd classpath
   Now run the auto tools as specified in the import process; then
   cd ..
-* Run 'scripts/makemake.tcl > sources.am' in the source tree
+* Run './scripts/makemake.tcl > sources.am' in the source tree
 * Run automake for libgcj
 
 Now you should be ready to go.
@@ -110,7 +118,8 @@
 makemake.tcl and automake whenever you update your embedded classpath
 tree.
 
---
+Adding classes to java.lang, java.io, java.util and subpackages
+---------------------------------------------------------------
 
 If you add a class to java.lang, java.io, or java.util
 (including sub-packages, like java.lang.ref).
@@ -129,3 +138,10 @@
 offline `cvs add' (it will fake an `add' if you don't have write
 permission yet).  Then you can use `cvs diff -N' to generate the
 patch.  See http://www.red-bean.com/cvsutils/
+
+Adding or removing C++ source files
+-----------------------------------
+
+If you add or remove any C++ source files you need to update the 
+nat_source_files variable in Makefile.am accordingly. After that
+run automake.

Attachment: signature.asc
Description: OpenPGP digital signature