2.9.10

[privoxy.git] / doc / text / developer-manual.txt

diff --git a/doc/text/developer-manual.txt b/doc/text/developer-manual.txt
index 06030c2..af3b1a9 100644 (file)
--- a/doc/text/developer-manual.txt
+++ b/doc/text/developer-manual.txt
@@ -3,7 +3,7 @@ Junkbuster Developer Manual
 
    By: Junkbuster Developers
    
-   $Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $
+   $Id: developer-manual.sgml,v 1.5 2001/10/31 18:16:51 swa Exp $
    
    The developer manual gives the users information on how to help the
    developer team. It provides guidance on coding, testing, documentation
@@ -57,22 +57,15 @@ Junkbuster Developer Manual
    
 3. 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
+   All docs are in SGML format and located in the doc/source directory.
+   
+   How do you update the webserver (i.e. the pages on sourceforge)?
+   
+    1. Run make dok (which uses the documents in doc/source to update all
+       text files in doc/text and to update all web documents in
+       doc/webserver.
+    2. Run make webserver which copies all files from doc/webserver to
+       the sourceforge webserver via scp.
      _________________________________________________________________
    
 4. Coding Guidelines
@@ -969,8 +962,8 @@ static void unload_re_filterfile( void *f ) { ... }
 4.8. Addendum: Template for files and function comment blocks:
 
    Example for file comments:
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:
-48 swa Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.5 2001/10/31 18:16:
+51 swa Exp $";
 /*********************************************************************
  *
  * File        :  $Source$
@@ -1027,8 +1020,8 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
    Example for file header comments:
 #ifndef _FILENAME_H
 #define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:4
-8 swa Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.5 2001/10/31 18:16:5
+1 swa Exp $"
 /*********************************************************************
  *
  * File        :  $Source$