1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
3 File : $Source: /cvsroot/ijbswa/current/doc/webserver/developer-manual.html,v $
5 Purpose : Developer Manual
7 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
9 $Id: developer-manual.html,v 1.2 2001/06/13 14:28:31 swa Exp $
11 Written by and Copyright (C) 2001 the SourceForge
12 IJBSWA team. http://ijbswa.sourceforge.net
14 Based on the Internet Junkbuster originally written
15 by and Copyright (C) 1997 Anonymous Coders and
16 Junkbusters Corporation. http://www.junkbusters.com
20 <title>Junkbuster|Developer Manual</title>
21 <link rel=stylesheet type="text/css" href="swa.css">
25 <body bgcolor="#ffffff"
26 topmargin="0" leftmargin="0" marginwidth = "0" marginheight = "0"
36 <h1>Junkbuster Developer Manual</h1>
37 <h2>Table of Contents</h2>
40 <li>Quickstart to Junkbuster Development
41 <li>Documentation Guidelines
43 <li>Testing Guidelines
46 <h2>Quickstart to Junkbuster Development</h2>
50 <h3>Read the developers manual</h3>
52 <h3>Getting an account on sourceforge.net</h3>
54 <h3>Subscribe to the developer's mailing list</h3>
56 <h3>Downloading the sources</h3>
58 <h2>Documentation Guidelines</h2>
60 All docs should be ...
62 <li>in a format that is widely used. I propose HTML.
65 <li>generate man pages from the documentation (let's _NOT_ write them manually), or
66 <li>we have a man page that points to the documentation (I propose
69 <li>have a consistent layout
70 <li>have a link to the latest version of the document (i.e. point to a URL at sf)
71 <li>be consistent with the redirect script (i.e. the junkbuster program
72 points via the redirect URL at sf to valid end-points in the document)
73 <li>started from scratch but recycle parts from the original junkbuster documents
76 <h2>Coding Guidelines</h2>
80 <h2>Testing Guidelines</h2>
81 <h3>Testplan for releases:</h3>
84 <li>Remove any existing rpm with rpm -e
85 <li>Remove any file that was left over. This includes (but is not limited
88 <li>/var/log/junkbuster
90 <li>/usr/sbin/junkbuster
91 <li>/etc/init.d/junkbuster
92 <li>/usr/doc/junkbuster*
94 <li>Install the rpm. Any error messages?
95 <li>start,stop,status junkbuster with the specific script
96 (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does
98 <li>Start browsing. Does the junkbuster work? Logfile written?
99 <li>Remove the rpm. Any error messages? All files removed?
102 <h3>Test reports:</h3>
104 Please submit test reports only with the <a href="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</a>
105 at sourceforge. Three simple steps:
107 <li>Select category: the distribution you test on.
108 <li>Select group: the version of Junkbuster that we are about to release.
109 <li>Fill the Summary and Detailed Description with something intelligent
110 (keep it short and precise).
113 Do not mail to the mailinglist (we cannot keep track on issues there).
120 <p><address><a href=mailto:ijbswa-developers@lists.sourceforge.net>the developers</a></address><p>
122 Last modified: Mon Sep 10 19:03:17 CEST 2001
126 This program is free software; you can redistribute it
127 and/or modify it under the terms of the GNU General
128 Public License as published by the Free Software
129 Foundation; either version 2 of the License, or (at
130 your option) any later version.
132 This program is distributed in the hope that it will
133 be useful, but WITHOUT ANY WARRANTY; without even the
134 implied warranty of MERCHANTABILITY or FITNESS FOR A
135 PARTICULAR PURPOSE. See the GNU General Public
136 License for more details.
138 The GNU General Public License should be included with
139 this file. If not, you can view it at
140 http://www.gnu.org/copyleft/gpl.html
141 or write to the Free Software Foundation, Inc., 59
142 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
144 $Log: developer-manual.html,v $
145 Revision 1.2 2001/06/13 14:28:31 swa
146 docs should have an author.
148 Revision 1.1 2001/06/13 14:20:37 swa
149 first import of project's documentation for the webserver.