From: swa Date: Mon, 10 Sep 2001 17:06:41 +0000 (+0000) Subject: doc and testing guidelines should be part of the developers manual. X-Git-Tag: v_2_9_9~131 X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=commitdiff_plain;h=83b852513e62f2a48ec374871fdb9e8b97aff3f1 doc and testing guidelines should be part of the developers manual. --- diff --git a/doc/webserver/developer-manual.html b/doc/webserver/developer-manual.html index 2a74cd17..ef770c17 100644 --- a/doc/webserver/developer-manual.html +++ b/doc/webserver/developer-manual.html @@ -6,7 +6,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: developer-manual.html,v 1.1 2001/06/13 14:20:37 swa Exp $ + $Id: developer-manual.html,v 1.2 2001/06/13 14:28:31 swa Exp $ Written by and Copyright (C) 2001 the SourceForge IJBSWA team. http://ijbswa.sourceforge.net @@ -33,7 +33,85 @@

How to quickly dive into Junkbuster Development:

Junkbuster Developer Manual

Quickstart to Junkbuster Development +
Documentation Guidelines +
Coding Guidelines +
Testing Guidelines +

+ +

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. +

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 +

+ +

Coding Guidelines

To be filled. +

+ +

Testing Guidelines

Testplan for releases:

Remove any existing rpm with rpm -e +
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* +
+
Install the rpm. Any error messages? +
start,stop,status junkbuster with the specific script + (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does + autostart work? +
Start browsing. Does the junkbuster work? Logfile written? +
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). +

@@ -41,7 +119,7 @@

the developers

-Last modified: Wed Jun 13 16:26:49 CEST 2001 +Last modified: Mon Sep 10 19:03:17 CEST 2001 - - -Junkbuster|Documentation Guidelines - - - - - - - -

-

-

Documentation guideline:

-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 -

- -
- -

the developers

- -Last modified: Wed Jun 13 16:26:48 CEST 2001 - - - - diff --git a/doc/webserver/testplan.html b/doc/webserver/testplan.html deleted file mode 100644 index 050a66d2..00000000 --- a/doc/webserver/testplan.html +++ /dev/null @@ -1,102 +0,0 @@ - - - - -Junkbuster|Testplan - - - - - - - -

-

-

Testplan for releases:

Remove any existing rpm with rpm -e -
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* -
-
Install the rpm. Any error messages? -
start,stop,status junkbuster with the specific script - (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does - autostart work? -
Start browsing. Does the junkbuster work? Logfile written? -
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). - -
- -

the developers

- -Last modified: Wed Jun 13 16:26:44 CEST 2001 - - - -

How to quickly dive into Junkbuster Development:

Junkbuster Developer Manual

Table of Contents

Quickstart to Junkbuster Development

Introduction

Read the developers manual

Getting an account on sourceforge.net

Subscribe to the developer's mailing list

Downloading the sources

Documentation Guidelines

Coding Guidelines

Testing Guidelines

Testplan for releases:

Test reports:

Documentation guideline:

Testplan for releases:

Test reports: