<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<!--
- File : $Source: /cvsroot/ijbswa/current/project.h,v $
+ File : $Source: /cvsroot/ijbswa/current/doc/webserver/developer-manual.html,v $
- Purpose : Developer Manualk
+ Purpose : Developer Manual
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: Makefile.in,v 1.12 2001/06/12 17:15:56 swa Exp $
+ $Id: developer-manual.html,v 1.3 2001/09/10 17:06:41 swa Exp $
Written by and Copyright (C) 2001 the SourceForge
IJBSWA team. http://ijbswa.sourceforge.net
<body>
<p>
<br><br>
-<h1>How to quickly dive into Junkbuster Development:</h1>
+<h1>Junkbuster Developer Manual</h1>
+<h2>Table of Contents</h2>
+<p>
+<ol>
+ <li>Quickstart to Junkbuster Development
+ <li>Documentation Guidelines
+ <li>Coding Guidelines
+ <li>Testing Guidelines
+ <li>Copyright and History
+ <li>See also
+</ol>
+
+<h2>1. Quickstart to Junkbuster Development</h2>
+<p>To be filled.
+<h3>Introduction</h3>
+<p>To be filled.
+<h3>Read the developers manual</h3>
+<p>To be filled.
+<h3>Getting an account on sourceforge.net</h3>
+<p>To be filled.
+<h3>Subscribe to the developer's mailing list</h3>
+<p>To be filled.
+<h3>Downloading the sources</h3>
+<p>To be filled.
+<h2>2. Documentation Guidelines</h2>
+<p>
+All docs should be ...
+<ul>
+ <li>in a format that is widely used. I propose HTML.
+ <li>we either
+ <ul>
+ <li>generate man pages from the documentation (let's _NOT_ write them manually), or
+ <li>we have a man page that points to the documentation (I propose
+ this option)
+ </ul>
+ <li>have a consistent layout
+ <li>have a link to the latest version of the document (i.e. point to a URL at sf)
+ <li>be consistent with the redirect script (i.e. the junkbuster program
+ points via the redirect URL at sf to valid end-points in the document)
+ <li>started from scratch but recycle parts from the original junkbuster documents
+</ul>
+
+<h2>3. Coding Guidelines</h2>
+<p>To be filled.
+<p>
+
+<h2>4. Testing Guidelines</h2>
+<h3>Testplan for releases:</h3>
+<p>
+<ol>
+ <li>Remove any existing rpm with rpm -e
+ <li>Remove any file that was left over. This includes (but is not limited
+ to)
+ <ul>
+ <li>/var/log/junkbuster
+ <li>/etc/junkbuster
+ <li>/usr/sbin/junkbuster
+ <li>/etc/init.d/junkbuster
+ <li>/usr/doc/junkbuster*
+ </ul>
+ <li>Install the rpm. Any error messages?
+ <li>start,stop,status junkbuster with the specific script
+ (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does
+ autostart work?
+ <li>Start browsing. Does the junkbuster work? Logfile written?
+ <li>Remove the rpm. Any error messages? All files removed?
+</ol>
+
+<h3>Test reports:</h3>
+<p>
+Please submit test reports only with the <a href="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</a>
+at sourceforge. Three simple steps:
+<ul>
+ <li>Select category: the distribution you test on.
+ <li>Select group: the version of Junkbuster that we are about to release.
+ <li>Fill the Summary and Detailed Description with something intelligent
+ (keep it short and precise).
+</ul>
+<p>
+Do not mail to the mailinglist (we cannot keep track on issues there).
+
<p>
<br>
<hr>
+<
p><address><a href=mailto:ijbswa-developers@lists.sourceforge.net>the developers</a></address><p>
<!-- hhmts start -->
-Last modified: Wed Jun 13 16:11:22 CEST 2001
+Last modified: Mon Sep 10 19:18:44 CEST 2001
<!-- hhmts end -->
</body>
<!--
or write to the Free Software Foundation, Inc., 59
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-$Log: Makefile.in,v $
- Revision 1.12 2001/06/12 17:15:56 swa
- fixes, because a clean build on rh6.1 was impossible.
- GZIP confuses make, %configure confuses rpm, etc.
+$Log: developer-manual.html,v $
+Revision 1.3 2001/09/10 17:06:41 swa
+doc and testing guidelines should be part of the developers manual.
+
+Revision 1.2 2001/06/13 14:28:31 swa
+docs should have an author.
+
+Revision 1.1 2001/06/13 14:20:37 swa
+first import of project's documentation for the webserver.
-->
</html>
projects / privoxy.git / blobdiff