doc/webserver/developer-manual.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
   2 <!--
   3  File        :  $Source: /cvsroot/ijbswa/current/doc/webserver/developer-manual.html,v $
   4
   5  Purpose     :  Developer Manual
   6                 This file belongs into
   7                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
   8
   9  $Id: developer-manual.html,v 1.2 2001/06/13 14:28:31 swa Exp $
  10
  11  Written by and Copyright (C) 2001 the SourceForge
  12  IJBSWA team.  http://ijbswa.sourceforge.net
  13
  14  Based on the Internet Junkbuster originally written
  15  by and Copyright (C) 1997 Anonymous Coders and
  16  Junkbusters Corporation.  http://www.junkbusters.com
  17 -->
  18
  19 <head>
  20 <title>Junkbuster|Developer Manual</title>
  21 <link rel=stylesheet type="text/css" href="swa.css">
  22
  23 </head>
  24
  25  <body bgcolor="#ffffff"
  26  topmargin="0" leftmargin="0" marginwidth = "0" marginheight = "0"
  27  text="#000000"
  28  link="#0000ff"
  29  vlink="#ff0000"
  30  alink="#ff0000"
  31  >
  32
  33 <body>
  34 <p>
  35 <br><br>
  36 <h1>Junkbuster Developer Manual</h1>
  37 <h2>Table of Contents</h2>
  38 <p>
  39 <ol>
  40   <li>Quickstart to Junkbuster Development
  41   <li>Documentation Guidelines
  42   <li>Coding Guidelines
  43   <li>Testing Guidelines
  44 </ol>
  45
  46 <h2>Quickstart to Junkbuster Development</h2>
  47 <p>To be filled.
  48 <h3>Introduction</h3>
  49 <p>To be filled.
  50 <h3>Read the developers manual</h3>
  51 <p>To be filled.
  52 <h3>Getting an account on sourceforge.net</h3>
  53 <p>To be filled.
  54 <h3>Subscribe to the developer's mailing list</h3>
  55 <p>To be filled.
  56 <h3>Downloading the sources</h3>
  57 <p>To be filled.
  58 <h2>Documentation Guidelines</h2>
  59 <p>
  60 All docs should be ...
  61 <ul>
  62   <li>in a format that is widely used. I propose HTML.
  63   <li>we either
  64       <ul>
  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
  67             this option)
  68       </ul>
  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
  74 </ul>
  75
  76 <h2>Coding Guidelines</h2>
  77 <p>To be filled.
  78 <p>
  79
  80 <h2>Testing Guidelines</h2>
  81 <h3>Testplan for releases:</h3>
  82 <p>
  83 <ol>
  84   <li>Remove any existing rpm with rpm -e
  85   <li>Remove any file that was left over. This includes (but is not limited
  86       to)
  87       <ul>
  88         <li>/var/log/junkbuster
  89         <li>/etc/junkbuster
  90         <li>/usr/sbin/junkbuster
  91         <li>/etc/init.d/junkbuster
  92         <li>/usr/doc/junkbuster*
  93       </ul>
  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
  97       autostart work?
  98   <li>Start browsing. Does the junkbuster work? Logfile written?
  99   <li>Remove the rpm. Any error messages? All files removed?
 100 </ol>
 101
 102 <h3>Test reports:</h3>
 103 <p>
 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:
 106 <ul>
 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).
 111 </ul>
 112 <p>
 113 Do not mail to the mailinglist (we cannot keep track on issues there).
 114
 115 <p>
 116
 117 <br>
 118
 119 <hr>
 120 <p><address><a href=mailto:ijbswa-developers@lists.sourceforge.net>the developers</a></address><p>
 121 <!-- hhmts start -->
 122 Last modified: Mon Sep 10 19:03:17 CEST 2001
 123 <!-- hhmts end -->
 124 </body>
 125  <!--
 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.
 131
 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.
 137
 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.
 143
 144 $Log: developer-manual.html,v $
 145 Revision 1.2  2001/06/13 14:28:31  swa
 146 docs should have an author.
 147
 148 Revision 1.1  2001/06/13 14:20:37  swa
 149 first import of project's documentation for the webserver.
 150
 151 -->
 152 </html>