Junkbuster Developer Manual

Table of Contents

1. Quickstart to Junkbuster Development
2. Documentation Guidelines
3. Coding Guidelines
4. Testing Guidelines
5. Copyright and History
6. See also

1. Quickstart to Junkbuster Development

To be filled.

Introduction

To be filled.

Read the developers manual

To be filled.

Getting an account on sourceforge.net

To be filled.

Subscribe to the developer's mailing list

To be filled.

Downloading the sources

To be filled.

2. Documentation Guidelines

All docs should be ...

• in a format that is widely used. I propose HTML.
• we either
  • generate man pages from the documentation (let's _NOT_ write them manually), or
  • we have a man page that points to the documentation (I propose this option)
• have a consistent layout
• have a link to the latest version of the document (i.e. point to a URL at sf)
• 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)
• started from scratch but recycle parts from the original junkbuster documents

3. Coding Guidelines

To be filled.

4. Testing Guidelines

Testplan for releases:

1. Remove any existing rpm with rpm -e
2. Remove any file that was left over. This includes (but is not limited to)
   • /var/log/junkbuster
   • /etc/junkbuster
   • /usr/sbin/junkbuster
   • /etc/init.d/junkbuster
   • /usr/doc/junkbuster*
3. Install the rpm. Any error messages?
4. start,stop,status junkbuster with the specific script (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does autostart work?
5. Start browsing. Does the junkbuster work? Logfile written?
6. Remove the rpm. Any error messages? All files removed?

Test reports:

Please submit test reports only with the test form at sourceforge. Three simple steps:

• Select category: the distribution you test on.
• Select group: the version of Junkbuster that we are about to release.
• Fill the Summary and Detailed Description with something intelligent (keep it short and precise).

Do not mail to the mailinglist (we cannot keep track on issues there).

Last modified: Mon Sep 10 19:18:44 CEST 2001