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.3 2001/09/10 17:06:41 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   <li>Copyright and History
  45   <li>See also
  46 </ol>
  47
  48 <h2>1. Quickstart to Junkbuster Development</h2>
  49 <p>To be filled.
  50 <h3>Introduction</h3>
  51 <p>To be filled.
  52 <h3>Read the developers manual</h3>
  53 <p>To be filled.
  54 <h3>Getting an account on sourceforge.net</h3>
  55 <p>To be filled.
  56 <h3>Subscribe to the developer's mailing list</h3>
  57 <p>To be filled.
  58 <h3>Downloading the sources</h3>
  59 <p>To be filled.
  60 <h2>2. Documentation Guidelines</h2>
  61 <p>
  62 All docs should be ...
  63 <ul>
  64   <li>in a format that is widely used. I propose HTML.
  65   <li>we either
  66       <ul>
  67         <li>generate man pages from the documentation (let's _NOT_ write them manually), or
  68         <li>we have a man page that points to the documentation (I propose
  69             this option)
  70       </ul>
  71   <li>have a consistent layout
  72   <li>have a link to the latest version of the document (i.e. point to a URL at sf)
  73   <li>be consistent with the redirect script (i.e. the junkbuster program
  74       points via the redirect URL at sf to valid end-points in the document)
  75   <li>started from scratch but recycle parts from the original junkbuster documents
  76 </ul>
  77
  78 <h2>3. Coding Guidelines</h2>
  79 <p>To be filled.
  80 <p>
  81
  82 <h2>4. Testing Guidelines</h2>
  83 <h3>Testplan for releases:</h3>
  84 <p>
  85 <ol>
  86   <li>Remove any existing rpm with rpm -e
  87   <li>Remove any file that was left over. This includes (but is not limited
  88       to)
  89       <ul>
  90         <li>/var/log/junkbuster
  91         <li>/etc/junkbuster
  92         <li>/usr/sbin/junkbuster
  93         <li>/etc/init.d/junkbuster
  94         <li>/usr/doc/junkbuster*
  95       </ul>
  96   <li>Install the rpm. Any error messages?
  97   <li>start,stop,status junkbuster with the specific script
  98       (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does
  99       autostart work?
 100   <li>Start browsing. Does the junkbuster work? Logfile written?
 101   <li>Remove the rpm. Any error messages? All files removed?
 102 </ol>
 103
 104 <h3>Test reports:</h3>
 105 <p>
 106 Please submit test reports only with the <a href="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</a>
 107 at sourceforge. Three simple steps:
 108 <ul>
 109   <li>Select category: the distribution you test on.
 110   <li>Select group: the version of Junkbuster that we are about to release.
 111   <li>Fill the Summary and Detailed Description with something intelligent
 112       (keep it short and precise).
 113 </ul>
 114 <p>
 115 Do not mail to the mailinglist (we cannot keep track on issues there).
 116
 117 <p>
 118
 119 <br>
 120
 121 <hr>
 122 <p><address><a href=mailto:ijbswa-developers@lists.sourceforge.net>the developers</a></address><p>
 123 <!-- hhmts start -->
 124 Last modified: Mon Sep 10 19:18:44 CEST 2001
 125 <!-- hhmts end -->
 126 </body>
 127  <!--
 128  This program is free software; you can redistribute it
 129  and/or modify it under the terms of the GNU General
 130  Public License as published by the Free Software
 131  Foundation; either version 2 of the License, or (at
 132  your option) any later version.
 133
 134  This program is distributed in the hope that it will
 135  be useful, but WITHOUT ANY WARRANTY; without even the
 136  implied warranty of MERCHANTABILITY or FITNESS FOR A
 137  PARTICULAR PURPOSE.  See the GNU General Public
 138  License for more details.
 139
 140  The GNU General Public License should be included with
 141  this file.  If not, you can view it at
 142  http://www.gnu.org/copyleft/gpl.html
 143  or write to the Free Software Foundation, Inc., 59
 144  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 145
 146 $Log: developer-manual.html,v $
 147 Revision 1.3  2001/09/10 17:06:41  swa
 148 doc and testing guidelines should be part of the developers manual.
 149
 150 Revision 1.2  2001/06/13 14:28:31  swa
 151 docs should have an author.
 152
 153 Revision 1.1  2001/06/13 14:20:37  swa
 154 first import of project's documentation for the webserver.
 155
 156 -->
 157 </html>