How To Participate

First of all checkout the latest sources from the cvs and try to compile XNap. If it doesn't work make sure you meet the build requirements listed in the readme file.

Then subscribe to the xnap-devel mailing list and have a look at the todo file . Pick a task you would like to work on and let the mailing list know, so we don't double do things.

Once you have code to share, send it! If your code works, we will happily incorporate it into the head branch. See below for details.

Programming Guidelines

Please try to stick to the formatting present in the XNap source.

Creating and sending patches

If you want to send code, only send diffs againt the latest cvs. That will make merging much easier for us.

Here are instructions about how you might want to do this:

1. Checkout the latest sources from the cvs:
   
   

   cvs -d:pserver:anonymous@cvs.xnap.sourceforge.net:/cvsroot/xnap co xnap3

2. Now make your changes.
3. Once you are done, merge the latest changes from HEAD and resolve all conflicts:
   
   

   cvs up -Pd

4. Clean your local repository and create a patch:
   
   

   make mrproper
   cvs diff -ubBdNw -U 5 > my_xnap.patch
   

5. Submit my_xnap.patch with a list of your changes to the patch tracker .

Compiling XNap

Our Makefile is somewhat Debian GNU/Linux specific. You can use ant for compiling if you do not run Linux. The most important Makefile targets are:

make clean - clean up

make dev - create proxy makefiles in sub directory and etags for emacs

make jar - create xnap.jar

make run - start XNap



Please note that we use jikes as our default compiler. Unfortunately because of a compiler bug version 1.18 or higher is required. If you prefer javac or would like to change other compile flags please edit the approriate lines in the file Makefile.define.

Capture Debug Output

You can start xnap with -d ALL, a nicer way to capture is creating a ~/.xnap/debug.prefs file. Read the log4j documentation for configuration hints. Here is an example:

log4j.logger.xnap=ALL,File,Socket

log4j.appender.File=org.apache.log4j.FileAppender
log4j.appender.File.file=debug.log
log4j.appender.File.layout=org.apache.log4j.PatternLayout
log4j.appender.File.layout.conversionPattern=%-5p [%t] %m%n
log4j.appender.File.append=false

log4j.appender.Socket=org.apache.log4j.net.SocketAppender
log4j.appender.Socket.remoteHost=localhost
log4j.appender.Socket.port=4445
log4j.appender.Socket.locationInfo=true

Eclipse

1. Check out the sources from cvs:

cvs -d:pserver:anonymous@cvs.xnap.sourceforge.net:/cvsroot/xnap co xnap3

2. Start eclipse
3. Select File -> Import -> "Existing Project into Workspace" -> Next
4. Type the full path of the XNap sources into the "Project contents" input field
5. Hit Finish

A new project named XNap will be created in your eclipse workspace.

To run XNap:

1. Select Run -> Run...
2. Create a new Java Application profile
3. Set the "Main class" to "org.xnap.XNap" and the "Program arguments" to "-x -d"
4. Hit Run