X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fdeveloper-manual.sgml;h=e5998abb57f2be7e9354b1bf279de913c870224d;hp=d7a3d8d569bd2b7d45e1c62aa27636dbd2a6ecbe;hb=1e978c46c5b5b21a8a283a9d62069cfc300ea0d1;hpb=d8024e835e3e1efcaaf2bd118172d44b2b5c17ca

diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index d7a3d8d5..e5998abb 100644
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -5,11 +5,8 @@
 <!entity p-intro SYSTEM "privoxy.sgml">
 <!entity history SYSTEM "history.sgml">
 <!entity seealso SYSTEM "seealso.sgml">
-<!entity contacting SYSTEM "contacting.sgml">
-<!entity copyright SYSTEM "copyright.sgml">
-<!entity license SYSTEM "license.sgml">
-<!entity p-version "3.0.20">
-<!entity p-status "UNRELEASED">
+<!entity p-version "3.0.25">
+<!entity p-status "beta">
 <!entity % p-not-stable "INCLUDE">
 <!entity % p-stable "IGNORE">
 <!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
@@ -24,9 +21,9 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
 
- $Id: developer-manual.sgml,v 2.42 2012/03/20 13:03:05 fabiankeil Exp $
+ $Id: developer-manual.sgml,v 2.70 2016/05/22 12:42:11 fabiankeil Exp $
 
- Copyright (C) 2001-2012 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2016 Privoxy Developers https://www.privoxy.org/
  See LICENSE.
 
  ========================================================================
@@ -45,13 +42,14 @@
      <subscript>
     <!-- Completely the wrong markup, but very little is allowed  -->
     <!-- in this part of an article. FIXME -->
-      <link linkend="copyright">Copyright</link> &my-copy; 2001-2009 by
-      <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
+      <ulink url="https://www.privoxy.org/user-manual/copyright.html">Copyright</ulink>
+      &my-copy; 2001-2016 by
+      <ulink url="https://www.privoxy.org/">Privoxy Developers</ulink>
      </subscript>
     </pubdate>
 
 
-    <pubdate>$Id: developer-manual.sgml,v 2.42 2012/03/20 13:03:05 fabiankeil Exp $</pubdate>
+    <pubdate>$Id: developer-manual.sgml,v 2.70 2016/05/22 12:42:11 fabiankeil Exp $</pubdate>
 
 <!--
 
@@ -100,13 +98,11 @@ Hal.
  Please note that this document is constantly evolving. This copy represents
  the state at the release of version &p-version;.
  You can find the latest version of the this manual at <ulink
- url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
- Please see <link linkend="contact">the Contact section</link>
- on how to contact the developers.
+ url="https://www.privoxy.org/developer-manual/">https://www.privoxy.org/developer-manual/</ulink>.
+ Please have a look at the
+ <ulink url="https://www.privoxy.org/user-manual/contact.html">contact section in the user manual</ulink>
+ if you are interested in contacting the developers.
 </para>
-<!--        <para> -->
-<!--    Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
-<!--   </para> -->
 
     </abstract>
   </artheader>
@@ -138,7 +134,7 @@ Hal.
   <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
    <para>
     The first step is to join the <ulink
-      url="mailto:ijbswa-developers@lists.sourceforge.net">developer's mailing list</ulink>.
+      url="https://lists.privoxy.org/mailman/listinfo/privoxy-devel">privoxy-devel mailing list</ulink>.
     You can submit your ideas, or even better patches. Patches are best
     submitted to the Sourceforge tracker set up for this purpose, but
     can be sent to the list for review too.
@@ -169,11 +165,8 @@ Hal.
     <sect2 id="cvsaccess"><title>Access to CVS</title>
       <para>
         The project's CVS repository is hosted on
-        <ulink url="http://sourceforge.net/">SourceForge.</ulink>
-        Please refer to the chapters 6 and 7 in
-        <ulink url="http://sourceforge.net/docman/?group_id=1">SF's site
-        documentation</ulink> for the technical access details for your
-        operating system. For historical reasons, the CVS server is
+        <ulink url="https://sourceforge.net/">SourceForge.</ulink>
+        For historical reasons, the CVS server is
         called <literal>ijbswa.cvs.sourceforge.net</literal>, the repository is
         called <literal>ijbswa</literal>, and the source tree module is called
         <literal>current</literal>.
@@ -187,7 +180,8 @@ Hal.
        mentioned, the sources are in the <literal>current</literal>
        <quote>module</quote>. Other modules are present for platform specific
        issues. There is a webview of the CVS hierarchy at <ulink
-       url="http://ijbswa.cvs.sourceforge.net/ijbswa/">http://ijbswa.cvs.sourceforge.net/ijbswa/</ulink>,
+        url="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/"
+            >http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/</ulink>,
        which might help with visualizing how these pieces fit together.
      </para>
      <!--
@@ -268,7 +262,7 @@ Hal.
            <para>
             Note that near a major public release, we get more cautious.
             There is always the possibility to submit a patch to the <ulink
-            url="http://sourceforge.net/tracker/?atid=311118&amp;group_id=11118&amp;func=browse">patch
+            url="https://sourceforge.net/tracker/?atid=311118&amp;group_id=11118&amp;func=browse">patch
             tracker</ulink> instead.
           </para>
          </listitem>
@@ -304,7 +298,7 @@ Hal.
         <para>
           Alternately, proposed changes can be submitted as patches to the patch tracker on
           Sourceforge first: <ulink
-          url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=311118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=311118</ulink>.
+          url="https://sourceforge.net/tracker/?group_id=11118&#38;atid=311118">https://sourceforge.net/tracker/?group_id=11118&#38;atid=311118</ulink>.
           Then ask for peer review.
         </para>
        </listitem>
@@ -365,14 +359,12 @@ Hal.
      Packagers are encouraged to include this documentation. For those without
      the ability to build the docs locally, text versions of each are kept in
      CVS. HTML versions are also being kept in CVS under
-     <filename>doc/webserver/*</filename>. And PDF version are kept in
-     <filename>doc/pdf/*</filename>.
+     <filename>doc/webserver/*</filename>.
     </para>
     <para>
      Formal documents are built with the Makefile targets of
-     <computeroutput>make dok</computeroutput>, or alternately
-     <computeroutput>make redhat-dok</computeroutput>. If you have problems,
-     try both. The build process uses the document SGML sources in
+     <computeroutput>make dok</computeroutput>.
+     The build process uses the document SGML sources in
      <computeroutput>doc/source/*/*</computeroutput> to update all text files in
      <computeroutput>doc/text/</computeroutput> and to update all HTML
      documents in <computeroutput>doc/webserver/</computeroutput>.
@@ -387,9 +379,7 @@ Hal.
      <orderedlist numeration="arabic">
       <listitem><para>
         First, build the docs by running <computeroutput>make
-        dok</computeroutput> (or alternately <computeroutput>make
-        redhat-dok</computeroutput>). For PDF docs, do <computeroutput>make
-        dok-pdf</computeroutput>.
+        dok</computeroutput>.
       </para></listitem>
       <listitem><para>
         Run <computeroutput>make webserver</computeroutput> which copies all
@@ -587,7 +577,7 @@ Hal.
   <listitem>
    <para>
     Our documents are available in differing formats. Right now, they
-    are just plain text, HTML, and PDF, but others are always a
+    are just plain text and/or HTML, but others are always a
     future possibility. Be careful with URLs (&lt;ulink&gt;), and avoid
     this mistake:
    </para>
@@ -733,7 +723,7 @@ Hal.
     understand why or what is being done. A reader may spend a lot
     more time figuring out what is going on when a simple comment
     or explanation would have prevented the extra research. Please
-    help your brother IJB'ers out!</para>
+    help your fellow Privoxy developers out!</para>
 
     <para>The comments will also help justify the intent of the code.
     If the comment describes something different than what the code
@@ -742,13 +732,13 @@ Hal.
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 /* if page size greater than 1k ... */
-if ( page_length() > 1024 )
+if (page_length() > 1024)
 {
     ... "block" the page up ...
 }
 
 /* if page size is small, send it in blocks */
-if ( page_length() > 1024 )
+if (page_length() > 1024)
 {
     ... "block" the page up ...
 }
@@ -776,20 +766,20 @@ is actually being done.
 /*********************************************************************
  * This will stand out clearly in your code!
  *********************************************************************/
-if ( this_variable == that_variable )
+if (this_variable == that_variable)
 {
    do_something_very_important();
 }
 
 
 /* unfortunately, this may not */
-if ( this_variable == that_variable )
+if (this_variable == that_variable)
 {
    do_something_very_important();
 }
 
 
-if ( this_variable == that_variable ) /* this may not either */
+if (this_variable == that_variable) /* this may not either */
 {
    do_something_very_important();
 }</programlisting>
@@ -823,12 +813,12 @@ if ( this_variable == that_variable ) /* this may not either */
  * This will stand out clearly in your code,
  * But the second example won't.
  *********************************************************************/
-if ( this_variable == this_variable )
+if (this_variable == this_variable)
 {
    do_something_very_important();
 }
 
-if ( this_variable == this_variable ) /*can you see me?*/
+if (this_variable == this_variable) /*can you see me?*/
 {
    do_something_very_important(); /*not easily*/
 }
@@ -840,7 +830,7 @@ if ( this_variable == this_variable ) /*can you see me?*/
 int urls_read     = 0;     /* # of urls read + rejected */
 int urls_rejected = 0;     /* # of urls rejected */
 
-if ( 1 == X )
+if (1 == X)
 {
    do_something_very_important();
 }
@@ -917,7 +907,7 @@ short do_something_very_important(
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
-if ( 1 == X )
+if (1 == X)
 {
    do_something_very_important();
    ...some long list of commands...
@@ -925,11 +915,11 @@ if ( 1 == X )
 
 or:
 
-if ( 1 == X )
+if (1 == X)
 {
    do_something_very_important();
    ...some long list of commands...
-} /* -END- if ( 1 == X ) */
+} /* -END- if (1 == X) */
 </programlisting>
   </sect3>
 
@@ -979,14 +969,14 @@ int msiis5hack = 0; int msIis5Hack = 0;
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
-int load_some_file( struct client_state *csp )</programlisting>
+int load_some_file(struct client_state *csp)</programlisting>
 
     <para><emphasis>Instead of:</emphasis></para>
 
     <para>
 <programlisting>
-int loadsomefile( struct client_state *csp )
-int loadSomeFile( struct client_state *csp )
+int loadsomefile(struct client_state *csp)
+int loadSomeFile(struct client_state *csp)
 </programlisting>
 </para>
 
@@ -1004,14 +994,14 @@ int loadSomeFile( struct client_state *csp )
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
-(.h) extern int load_aclfile( struct client_state *csp );
-(.c) int load_aclfile( struct client_state *csp )</programlisting>
+(.h) extern int load_aclfile(struct client_state *csp);
+(.c) int load_aclfile(struct client_state *csp)</programlisting>
 
     <para><emphasis>Instead of:</emphasis>
 <programlisting>
-(.h) extern int load_aclfile( struct client_state * ); or
+(.h) extern int load_aclfile(struct client_state *); or
 (.h) extern int load_aclfile();
-(.c) int load_aclfile( struct client_state *csp )
+(.c) int load_aclfile(struct client_state *csp)
 </programlisting>
 </para>
 
@@ -1029,7 +1019,7 @@ int loadSomeFile( struct client_state *csp )
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
-(enumeration) : enum Boolean { FALSE, TRUE };
+(enumeration) : enum Boolean {FALSE, TRUE};
 (#define) : #define DEFAULT_SIZE 100;</programlisting>
 
     <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
@@ -1097,18 +1087,18 @@ int loadSomeFile( struct client_state *csp )
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
-if ( this == that )
+if (this == that)
 {
    ...
 }</programlisting>
 
     <para><emphasis>Instead of:</emphasis></para>
 
-    <para>if ( this == that ) { ... }</para>
+    <para>if (this == that) { ... }</para>
 
     <para>or</para>
 
-    <para>if ( this == that ) { ... }</para>
+    <para>if (this == that) { ... }</para>
 
     <para><emphasis>Note:</emphasis> In the special case that the if-statement is
     inside a loop, and it is trivial, i.e. it tests for a
@@ -1120,12 +1110,12 @@ if ( this == that )
 
     <para><emphasis>Example exception:</emphasis></para>
 <programlisting>
-while ( more lines are read )
+while (more lines are read)
 {
    /* Please document what is/is not a comment line here */
-   if ( it's a comment ) continue;
+   if (it's a comment) continue;
 
-   do_something( line );
+   do_something(line);
 }
 </programlisting>
   </sect3>
@@ -1142,7 +1132,7 @@ while ( more lines are read )
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
-if ( this == that )
+if (this == that)
 {
    do_something();
    do_something_else();
@@ -1150,11 +1140,11 @@ if ( this == that )
 
     <para><emphasis>Instead of:</emphasis></para>
 
-    <para>if ( this == that ) do_something(); do_something_else();</para>
+    <para>if (this == that) do_something(); do_something_else();</para>
 
     <para>or</para>
 
-    <para>if ( this == that ) do_something();</para>
+    <para>if (this == that) do_something();</para>
 
     <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
     in a manner other than that which the developer desired (per
@@ -1171,11 +1161,11 @@ if ( this == that )
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
-structure->flag = ( condition );</programlisting>
+structure->flag = (condition);</programlisting>
 
     <para><emphasis>Instead of:</emphasis></para>
 
-    <para>if ( condition ) { structure->flag = 1; } else {
+    <para>if (condition) { structure->flag = 1; } else {
     structure->flag = 0; }</para>
 
     <para><emphasis>Note:</emphasis> The former is readable and concise. The later
@@ -1201,10 +1191,6 @@ int first_value   = 0;
 int some_value    = 0;
 int another_value = 0;
 int this_variable = 0;
-
-if ( this_variable == this_variable )
-
-first_value = old_value + ( ( some_value - another_value ) - whatever )
 </programlisting>
   </sect3>
 
@@ -1243,19 +1229,19 @@ function_name();</programlisting>
 int function1( ... )
 {
    ...code...
-   return( ret_code );
+   return(ret_code);
 
-}   /* -END- function1 */
+} /* -END- function1 */
 
 
 int function2( ... )
 {
-}   /* -END- function2 */
+} /* -END- function2 */
 </programlisting>
 
     <para><emphasis>Instead of:</emphasis></para>
 
-    <para>int function1( ... ) { ...code... return( ret_code ); } int
+    <para>int function1( ... ) { ...code... return(ret_code); } int
     function2( ... ) { }</para>
 
     <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
@@ -1292,16 +1278,16 @@ static const char * const url_code_map[256] =
 
 int function1( ... )
 {
-   if ( 1 )
+   if (1)
    {
-      return( ALWAYS_TRUE );
+      return ALWAYS_TRUE;
    }
    else
    {
-      return( HOW_DID_YOU_GET_HERE );
+      return HOW_DID_YOU_GET_HERE;
    }
 
-   return( NEVER_GETS_HERE );
+   return NEVER_GETS_HERE;
 
 }
 </programlisting>
@@ -1386,7 +1372,7 @@ is_web_page_blank();
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
-for ( size_t cnt = 0; cnt &lt; block_list_length(); cnt++ )
+for (size_t cnt = 0; cnt &lt; block_list_length(); cnt++)
 {
    ....
 }</programlisting>
@@ -1409,7 +1395,7 @@ for ( size_t cnt = 0; cnt &lt; block_list_length(); cnt++ )
 <programlisting>
 size_t len = block_list_length();
 
-for ( size_t cnt = 0; cnt &lt; len; cnt++ )
+for (size_t cnt = 0; cnt &lt; len; cnt++)
 {
    ....
 }</programlisting>
@@ -1429,12 +1415,12 @@ for ( size_t cnt = 0; cnt &lt; len; cnt++ )
     <para>This allows a developer to define a const pointer and call
     your function. If your function does not have the const
     keyword, we may not be able to use your function. Consider
-    strcmp, if it were defined as: extern int strcmp( char *s1,
-    char *s2 );</para>
+    strcmp, if it were defined as: extern int strcmp(char *s1,
+    char *s2);</para>
 
-    <para>I could then not use it to compare argv's in main: int main(
-    int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
-    ); }</para>
+    <para>I could then not use it to compare argv's in main: int
+    main(int argc, const char *argv[]) { strcmp(argv[0], "privoxy");
+     }</para>
 
     <para>Both these pointers are *const*! If the c runtime library
     maintainers do it, we should too.</para>
@@ -1449,11 +1435,11 @@ for ( size_t cnt = 0; cnt &lt; len; cnt++ )
 
     <para>Most structures cannot fit onto a normal stack entry (i.e.
     they are not 4 bytes or less). Aka, a function declaration
-    like: int load_aclfile( struct client_state csp )</para>
+    like: int load_aclfile(struct client_state csp)</para>
 
     <para>would not work. So, to be consistent, we should declare all
-    prototypes with "pass by value": int load_aclfile( struct
-    client_state *csp )</para>
+    prototypes with "pass by value": int load_aclfile(struct
+    client_state *csp)</para>
 
 
   </sect3>
@@ -1596,22 +1582,22 @@ extern file_list *xyz;</programlisting>
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
-switch( hash_string( cmd ) )
+switch (hash_string(cmd))
 {
-   case hash_actions_file :
+   case hash_actions_file:
       ... code ...
       break;
 
-   case hash_confdir :
+   case hash_confdir:
       ... code ...
       break;
 
-   default :
+   default:
       log_error( ... );
       ... anomaly code goes here ...
       continue; / break; / exit( 1 ); / etc ...
 
-} /* end switch( hash_string( cmd ) ) */</programlisting>
+} /* end switch (hash_string(cmd)) */</programlisting>
 
     <para><emphasis>Note:</emphasis> If you already have a default condition, you
     are obviously exempt from this point. Of note, most of the
@@ -1651,24 +1637,6 @@ switch( hash_string( cmd ) )
     necessary.</para>
 
 
-  </sect3>
-
-
-    <sect3 id="s39"><title>Use 'long' or 'short' Instead of
-    'int'</title>
-
-    <para><emphasis>Explanation:</emphasis></para>
-
-    <para>On 32-bit platforms, int usually has the range of long. On
-    16-bit platforms, int has the range of short.</para>
-
-    <para><emphasis>Status:</emphasis> open-to-debate. In the case of most FSF
-    projects (including X/GNU-Emacs), there are typedefs to int4,
-    int8, int16, (or equivalence ... I forget the exact typedefs
-    now). Should we add these to IJB now that we have a "configure"
-    script?</para>
-
-
   </sect3>
 
 
@@ -1754,8 +1722,8 @@ list, then it should definitely be allocated via `malloc'.
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
-int load_re_filterfile( struct client_state *csp ) { ... }
-static void unload_re_filterfile( void *f ) { ... }</programlisting>
+int load_re_filterfile(struct client_state *csp) { ... }
+static void unload_re_filterfile(void *f) { ... }</programlisting>
 
     <para><emphasis>Exceptions:</emphasis></para>
 
@@ -1790,7 +1758,7 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
 
 
     <sect3 id="s45"><title>"Uncertain" new code and/or changes to
-    existing code, use FIXME or XXX</title>
+    existing code, use XXX</title>
 
     <para><emphasis>Explanation:</emphasis></para>
 
@@ -1798,18 +1766,18 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
     your changes, but are not *quite* sure of the repercussions,
     add this:</para>
 
-    <para>/* FIXME: this code has a logic error on platform XYZ, *
+    <para>/* XXX: this code has a logic error on platform XYZ, *
     attempting to fix */ #ifdef PLATFORM ...changed code here...
     #endif</para>
 
     <para>or:</para>
 
-    <para>/* FIXME: I think the original author really meant this...
+    <para>/* XXX: I think the original author really meant this...
     */ ...changed code here...</para>
 
     <para>or:</para>
 
-    <para>/* FIXME: new code that *may* break something else... */
+    <para>/* XXX: new code that *may* break something else... */
     ...new code here...</para>
 
     <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
@@ -1827,15 +1795,15 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
 
     <para><emphasis>Example for file comments:</emphasis></para>
 <programlisting>
-const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
+const char FILENAME_rcs[] = "$I&lt;!-- Break CVS Substitution -->d$";
 /*********************************************************************
  *
- * File        :  $S<!-- Break CVS Substitution -->ource$
+ * File        :  $S&lt;!-- Break CVS Substitution -->ource$
  *
  * Purpose     :  (Fill me in with a good description!)
  *
  * Copyright   :  Written by and Copyright (C) 2001-2009
- *                the Privoxy team. http://www.privoxy.org/
+ *                the Privoxy team. https://www.privoxy.org/
  *
  *                This program is free software; you can redistribute it
  *                and/or modify it under the terms of the GNU General
@@ -1881,15 +1849,15 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
 <programlisting>
 #ifndef _FILENAME_H
 #define _FILENAME_H
-#define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
+#define FILENAME_H_VERSION "$I&lt;!-- Break CVS Substitution -->d$"
 /*********************************************************************
  *
- * File        :  $S<!-- Break CVS Substitution -->ource$
+ * File        :  $S&lt;!-- Break CVS Substitution -->ource$
  *
  * Purpose     :  (Fill me in with a good description!)
  *
  * Copyright   :  Written by and Copyright (C) 2001-2009
- *                the Privoxy team. http://www.privoxy.org/
+ *                the Privoxy team. https://www.privoxy.org/
  *
  *                This program is free software; you can redistribute it
  *                and/or modify it under the terms of the GNU General
@@ -1955,10 +1923,10 @@ extern const char FILENAME_h_rcs[];
  * Returns     :  0 => Ok, everything else is an error.
  *
  *********************************************************************/
-int FUNCTION_NAME( void *param1, const char *x )
+int FUNCTION_NAME(void *param1, const char *x)
 {
    ...
-   return( 0 );
+   return 0;
 
 }
 </programlisting>
@@ -2006,24 +1974,7 @@ Install the rpm. Any error messages?
         </orderedlist>
 </para>
     </sect2>
-
-    <!--   ~~~~~       New section      ~~~~~     -->
-    <sect2 id="testing-report"><title>Test reports</title>
-      <para>
-Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&amp;group_id=11118&amp;atid=395005">test form</ulink>
-at sourceforge. Three simple steps:
-        <itemizedlist>
-
-          <listitem><para>Select category: the distribution you test on.</para></listitem>
-          <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
-          <listitem><para>Fill the Summary and Detailed Description with something
-              intelligent (keep it short and precise).</para>
-          </listitem>
-        </itemizedlist>
-        Do not mail to the mailing list (we cannot keep track on issues there).
-      </para>
-    </sect2>
-
+    <!-- XXX: Document how to write test reports and where to send them -->
   </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->
@@ -2177,7 +2128,7 @@ at sourceforge. Three simple steps:
         Finished docs should be then be committed to CVS (for those
         without the ability to build these). Some docs may require
         rather obscure processing tools. <filename>config</filename>,
-        the man page (and the html version of the man page), and the PDF docs
+        the man page (and the html version of the man page)
         fall in this category. REAMDE, the man page, AUTHORS, and config
         should all also be committed to CVS for other packagers. The
         formal docs should be uploaded to the webserver. See the
@@ -2456,7 +2407,7 @@ at sourceforge. Three simple steps:
         be reset to one if this is the first RPM for
         <replaceable class="parameter">dist</replaceable> which is built from version
         X.Y.Z. Check the
-        <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">file
+        <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">file
         list</ulink> if unsure. Else, it must be set to the highest already available RPM
         release number for that version plus one.
       </para>
@@ -2590,9 +2541,9 @@ at sourceforge. Three simple steps:
 
     <sect3 id="newrelease-windows"><title>Windows</title>
       <para>
-        You should ensure you have the latest version of Cygwin (from
-        <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>).
-        Run the following commands from within a Cygwin bash shell.
+        Use the <ulink url="http://www.fruitbat.org/Cygwin/index.html#cygwincirca">
+        Cygwin Time Machine</ulink> to install the last 1.5 version of Cygwin.
+        Run the following commands from within the Cygwin 1.5 bash shell.
       </para>
       <para>
         First, <emphasis>make sure that you have freshly exported the right
@@ -2755,7 +2706,7 @@ at sourceforge. Three simple steps:
         </para>
         <para>
           The module contains complete instructions on its usage in its
-          <filename>README</filename> file. The end result will be the the
+          <filename>README</filename> file. The end result will be the
           exported version of Privoxy installed on the build machine.
         </para>
       </sect4>
@@ -2763,115 +2714,11 @@ at sourceforge. Three simple steps:
 
     <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
       <para>
-        Login to Sourceforge's compile-farm via ssh:
-      </para>
-      <para>
-        <programlisting>
-  ssh cf.sourceforge.net
-</programlisting>
-      </para>
-      <para>
-        Choose the right operating system.
-        When logged in, <emphasis>make sure that you have freshly exported the right
-        version into an empty directory</emphasis>. (See "Building and releasing
-        packages" above). Then run:
-      </para>
-      <para>
-        <programlisting>
-  cd current
-  autoheader && autoconf && ./configure
-</programlisting>
-      </para>
-      <para>
-        Then run:
-      </para>
-      <para>
-        <programlisting>
-  gmake freebsd-dist
-</programlisting>
-      </para>
-      <para>
-        which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
-        freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
-        to manually upload the archive to Sourceforge's ftp server and release
-        the file publicly. Use the release notes and Change Log from the
-        source tarball package.
+        Update the www/privoxy port and submit a diff upstream.
+        For details see the <ulink url="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/">FreeBSD Porter's Handbook</ulink>.
       </para>
     </sect3>
 
-    <sect3 id="newrelease-hpux"><title>HP-UX 11</title>
-      <para>
-        First, <emphasis>make sure that you have freshly exported the right
-        version into an empty directory</emphasis>. (See "Building and releasing
-        packages" above). Then run:
-      </para>
-      <para>
-        <programlisting>
-  cd current
-  autoheader && autoconf && ./configure
-</programlisting>
-      </para>
-      <para>
-        Then do FIXME.
-      </para>
-    </sect3>
-
-    <sect3 id="newrelease-amiga"><title>Amiga OS</title>
-      <para>
-        First, <emphasis>make sure that you have freshly exported the right
-        version into an empty directory</emphasis>. (See "Building and releasing
-        packages" above). Then run:
-      </para>
-      <para>
-        <programlisting>
-  cd current
-  autoheader && autoconf && ./configure
-</programlisting>
-      </para>
-      <para>
-        Then do FIXME.
-      </para>
-    </sect3>
-
-    <sect3 id="newrelease-aix"><title>AIX</title>
-      <para>
-        Login to Sourceforge's compilefarm via ssh:
-      </para>
-      <para>
-        <programlisting>
-  ssh cf.sourceforge.net
-</programlisting>
-      </para>
-      <para>
-        Choose the right operating system.
-        When logged in, <emphasis>make sure that you have freshly exported the right
-        version into an empty directory</emphasis>. (See "Building and releasing
-        packages" above). Then run:
-      </para>
-      <para>
-        <programlisting>
-  cd current
-  autoheader && autoconf && ./configure
-</programlisting>
-      </para>
-      <para>
-        Then run:
-      </para>
-      <para>
-        <programlisting>
-  make aix-dist
-</programlisting>
-      </para>
-      <para>
-        which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
-        aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
-        to manually upload the archive to Sourceforge's ftp server and release
-        the file publicly. Use the release notes and Change Log from the
-        source tarball package.
-      </para>
-    </sect3>
-   </sect2>
-
    <sect2 id="releasing">
    <title>Uploading and Releasing Your Package</title>
     <para>
@@ -2934,10 +2781,10 @@ at sourceforge. Three simple steps:
     <title>After the Release</title>
      <para>
       When all (or: most of the) packages have been uploaded and made available,
-      send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
+      send an email to the <ulink url="mailto:privoxy-announce@lists.privoxy.org">announce
       mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
       include the
-      <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
+      <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">download
       location</ulink>, the release notes and the Changelog. Also, post an
       updated News item on the project page Sourceforge, and update the Home
       page and docs linked from the Home page (see below). Other news sites
@@ -2961,14 +2808,13 @@ at sourceforge. Three simple steps:
    </para>
    <para>
     <programlisting>
-  make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
+  make dok
 </programlisting>
    </para>
    <para>
     That will generate <filename>doc/webserver/user-manual</filename>,
     <filename>doc/webserver/developer-manual</filename>,
     <filename>doc/webserver/faq</filename>,
-    <filename>doc/pdf/*.pdf</filename> and
     <filename>doc/webserver/index.html</filename> automatically.
    </para>
    <para>
@@ -2993,7 +2839,7 @@ at sourceforge. Three simple steps:
 </programlisting>
    </para>
    <para>
-    This will do the upload to <ulink url="http://www.privoxy.org/">the
+    This will do the upload to <ulink url="https://www.privoxy.org/">the
     webserver</ulink> (www.privoxy.org) and ensure all files and directories
     there are group writable.
    </para>
@@ -3005,46 +2851,6 @@ at sourceforge. Three simple steps:
    </para>
   </sect1>
 
-  <!--   ~~~~~       New section      ~~~~~     -->
-  <sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
-<!-- Include contacting.sgml  -->
- &contacting;
-<!-- end contacting -->
-  </sect1>
-
-
-<!--   ~~~~~~~~       New section Header    ~~~~~~~~~     -->
-<sect1 id="copyright"><title>Privoxy Copyright, License and History</title>
-
-<!-- Include copyright.sgml -->
- &copyright;
-<!-- end -->
-
-<!--   ~~~~~       New section      ~~~~~     -->
-<sect2><title>License</title>
-<!-- Include copyright.sgml: -->
- &license;
-<!-- end copyright -->
-</sect2>
-<!--  ~  End section  ~  -->
-
-<!--   ~~~~~       New section      ~~~~~     -->
-<sect2><title>History</title>
-<!-- Include history.sgml -->
- &history;
-<!-- end -->
-</sect2>
-
-</sect1>
-
-  <!--   ~~~~~       New section      ~~~~~     -->
-  <sect1 id="seealso"><title>See also</title>
-<!-- Include seealso.sgml -->
- &seealso;
-<!-- end  -->
-
-  </sect1>
-
   <!--
 
   This program is free software; you can redistribute it
@@ -3065,342 +2871,6 @@ at sourceforge. Three simple steps:
   or write to the Free Software Foundation, Inc., 59
   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-  $Log: developer-manual.sgml,v $
-  Revision 2.42  2012/03/20 13:03:05  fabiankeil
-  Bump copyright date
-
-  Revision 2.41  2012/03/19 12:56:08  fabiankeil
-  Untabify
-
-  Revision 2.40  2012/03/18 15:41:49  fabiankeil
-  Bump entities to 3.0.20 UNRELEASED
-
-  Revision 2.39  2012/03/18 01:16:35  diem
-  Brought OS X section up to date, deprecating the osxsetup module and adding a section referring to the OSXPackageBuilder module
-
-  Revision 2.38  2011/12/26 17:05:40  fabiankeil
-  Bump entities for 3.0.19
-
-  Revision 2.37  2011/11/13 17:03:54  fabiankeil
-  Bump entities for 3.0.18 stable
-
-  Revision 2.36  2011/09/04 11:10:12  fabiankeil
-  Ditch trailing whitespace
-
-  Revision 2.35  2011/08/17 10:40:07  fabiankeil
-  Update the entities.
-
-  This commit is chronological out of order.
-
-  Revision 2.34  2010/11/06 12:55:48  fabiankeil
-  Set p-version to 3.0.17
-
-  Revision 2.33  2010/02/13 17:38:27  fabiankeil
-  Update entities for 3.0.16 stable.
-
-  Revision 2.32  2009/11/15 14:24:12  fabiankeil
-  Prepare to generate docs for 3.0.16 UNRELEASED.
-
-  Revision 2.31  2009/10/10 05:48:55  fabiankeil
-  Prepare for 3.0.15 beta.
-
-  Revision 2.30  2009/07/18 16:24:39  fabiankeil
-  Bump entities for 3.0.14 beta.
-
-  Revision 2.29  2009/06/12 14:30:58  fabiankeil
-  Update entities for 3.0.13 beta.
-
-  Revision 2.28  2009/05/16 13:27:21  fabiankeil
-  Remove CVS revision logs. TODO item #33.
-
-  Revision 2.27  2009/02/19 02:20:22  hal9
-  Make some links in seealso conditional. Man page is now privoxy only links.
-
-  Revision 2.26  2009/02/12 16:08:26  fabiankeil
-  Declare the code stable.
-
-  Revision 2.25  2009/02/12 15:37:05  fabiankeil
-  Update templates.
-
-  Revision 2.24  2009/01/13 16:50:35  fabiankeil
-  The standard.action file is gone.
-
-  Revision 2.23  2008/09/26 17:02:01  fabiankeil
-  - Break some more CVS substitutions in examples.
-  - Remove Junkbusters reference in example header
-    for new files.
-
-  Revision 2.22  2008/08/30 15:37:35  fabiankeil
-  Update entities.
-
-  Revision 2.21  2008/08/16 08:51:28  fabiankeil
-  Update version-related entities.
-
-  Revision 2.20  2008/06/14 13:21:24  fabiankeil
-  Prepare for the upcoming 3.0.9 beta release.
-
-  Revision 2.19  2008/05/12 11:13:33  fabiankeil
-  Clarify that Privoxy is licensed under GPL version 2.
-
-  Revision 2.18  2008/02/04 12:14:06  fabiankeil
-  Change "Edit Packages" URL to use https.
-
-  Revision 2.17  2008/02/03 21:37:41  hal9
-  Apply patch from Mark: s/OSX/OS X/
-
-  Revision 2.16  2008/01/19 17:52:38  hal9
-  Re-commit to fix various minor issues for new release.
-
-  Revision 2.15  2008/01/19 15:03:05  hal9
-  Doc sources tagged for 3.0.8 release.
-
-  Revision 2.14  2008/01/17 01:49:51  hal9
-  Change copyright notice for docs s/2007/2008/. All these will be rebuilt soon
-  enough.
-
-  Revision 2.13  2007/10/30 17:59:31  fabiankeil
-  - Bump p-version, p-status and copyright date.
-  - Mention that the manual is out of date.
-  - Don't use examples with HardToReadCamelCase after
-    explaining that we actually don't like that.
-  - Minor cosmetics.
-
-  Revision 2.12  2006/11/14 01:57:46  hal9
-  Dump all docs prior to 3.0.6 release. Various minor changes to faq and user
-  manual.
-
-  Revision 2.11  2006/09/26 02:36:29  hal9
-  Fix broken link per bug tracker.
-
-  Revision 2.10  2006/09/22 01:27:55  hal9
-  Final commit of probably various minor changes here and there. Unless
-  something changes this should be ready for pending release.
-
-  Revision 2.9  2006/09/14 02:30:07  hal9
-  Fix ijbswa cvs links. Update notes on release process, and which config files
-  should be overwritten and which not.
-
-  Revision 2.8  2006/08/22 23:35:01  hal9
-  Fix email address, cvs URI, address branching changes and various other
-  small updates.
-
-  Revision 2.7  2006/07/18 14:48:50  david__schmidt
-  Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
-  with what was really the latest development (the v_3_0_branch branch)
-
-  Revision 1.46.2.11  2002/12/11 13:12:15  hal9
-  Rewrite cvs write access give-away section.
-
-  Revision 1.46.2.10  2002/09/26 21:53:45  hal9
-  Changes to reflect recent change in stable branch commit policy (hopefully
-  clearer now).
-
-  Revision 1.46.2.9  2002/09/26 01:21:40  hal9
-  Porting 3.1.1 changes: more on cvs and branches, more on versions and
-  releases.
-
-  Revision 1.46.2.8  2002/08/17 00:16:10  hal9
-  Add note on updating webserver for User-manual/CGI editor, which is version
-  dependent (and different from main UM link).
-
-  Revision 1.46.2.7  2002/08/14 17:29:25  hal9
-  Add small notes on post-release steps, and uploading docs to webserver.
-
-  Revision 1.46.2.6  2002/08/10 11:40:25  oes
-  Added disclaimer about probably being out-of-date and two small hints
-
-  Revision 1.46.2.5  2002/08/09 01:15:12  hal9
-  Added some notes on pre-release steps (test builds first, update ChangeLog).
-
-  Revision 1.46.2.4  2002/05/29 00:30:59  mal0rd
-  Fixed a little formatting.  Clarified debian section.
-
-  Revision 1.46.2.3  2002/05/28 04:32:45  hal9
-  Change hints on bundling index.html to privoxy-index.html
-
-  Revision 1.46.2.2  2002/05/26 17:04:24  hal9
-  -Spellcheck, very minor edits, and sync across branches
-
-  Revision 1.48  2002/05/26 12:48:31  roro
-  Add releasing information about Debian.
-
-  Revision 1.47  2002/05/26 04:55:11  mal0rd
-  Added debian-dist and debian-upload targets.  Also documented usage.
-
-  Revision 1.46  2002/05/22 17:15:00  oes
-  Updated intro
-
-  Revision 1.45  2002/05/19 23:01:54  hal9
-  Add small section on general packaging guidelines (e.g. actions files must
-  be writable).
-
-  Revision 1.44  2002/05/15 03:55:17  hal9
-  Fix ulink -> link, and minor modification to release process section for
-  clarification.
-
-  Revision 1.43  2002/05/10 01:48:19  hal9
-  This is mostly proposed copyright/licensing additions and changes. Docs
-  are still GPL, but licensing and copyright are more visible. Also, copyright
-  changed in doc header comments (eliminate references to JB except FAQ).
-
-  Revision 1.42  2002/05/05 20:26:02  hal9
-  Sorting out license vs copyright in these docs.
-
-  Revision 1.41  2002/05/04 08:44:44  swa
-  bumped version
-
-  Revision 1.40  2002/05/04 00:43:43  hal9
-  -Remove TOC/first page kludge with proper stylesheet fix.
-  -Combined the two very brief sections: Intro and Quickstart.
-
-  Revision 1.39  2002/05/02 15:08:25  oes
-  Added explanation about version numbers and RPM package revisions
-
-  Revision 1.38  2002/04/29 02:20:31  hal9
-  Add info on steps for uploading and the release process on SF.
-
-  Revision 1.37  2002/04/26 17:23:29  swa
-  bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
-
-  Revision 1.36  2002/04/26 05:25:23  hal9
-  Mass commit to catch a few scattered fixes.
-
-  Revision 1.35  2002/04/17 15:16:15  oes
-  Added link to docbook crash course
-
-  Revision 1.34  2002/04/15 23:39:32  oes
-   - Extended & fixed the release section
-   - Added CVS guideline sections
-   - Separated webserver section from release section
-   - Commented out boilerplate inclusion (If you don't know yet what it is,
-     you shouldn't mess with its code ;-)
-   - Nits & fixes
-
-  Revision 1.33  2002/04/12 03:49:53  hal9
-  Spell checked. Clarification on where docs are kept.
-
-  Revision 1.32  2002/04/11 21:29:58  jongfoster
-  Documenting Win32 release procedure
-
-  Revision 1.31  2002/04/11 09:32:52  oes
-  more nits
-
-  Revision 1.30  2002/04/11 09:24:53  oes
-  nits
-
-  Revision 1.29  2002/04/10 18:45:14  swa
-  generated
-
-  Revision 1.28  2002/04/08 22:59:26  hal9
-  Version update. Spell chkconfig correctly :)
-
-  Revision 1.27  2002/04/08 15:31:18  hal9
-  Touch ups to documentation section.
-
-  Revision 1.26  2002/04/07 23:50:08  hal9
-  Documentation changes to reflect HTML docs now in CVS, and new generated files
-  list.
-
-  Revision 1.25  2002/04/06 05:07:28  hal9
-  -Add privoxy-man-page.sgml, for man page.
-  -Add authors.sgml for AUTHORS (and p-authors.sgml)
-  -Reworked various aspects of various docs.
-  -Added additional comments to sub-docs.
-
-  Revision 1.24  2002/04/04 21:33:37  hal9
-  More on documenting the documents.
-
-  Revision 1.23  2002/04/04 18:46:47  swa
-  consistent look. reuse of copyright, history et. al.
-
-  Revision 1.22  2002/04/04 17:27:56  swa
-  more single file to be included at multiple points. make maintaining easier
-
-  Revision 1.21  2002/04/04 06:48:37  hal9
-  Structural changes to allow for conditional inclusion/exclusion of content
-  based on entity toggles, e.g. 'entity % p-not-stable  "INCLUDE"'. And
-  definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
-  eventually be set by Makefile.
-  More boilerplate text for use across multiple docs.
-
-  Revision 1.20  2002/04/04 03:28:27  david__schmidt
-  Add Mac OS X section
-
-  Revision 1.19  2002/04/03 15:09:42  david__schmidt
-  Add OS/2 build section
-
-  Revision 1.18  2002/04/03 03:51:48  hal9
-  Touch ups.
-
-  Revision 1.17  2002/04/03 01:21:17  hal9
-  Implementing Andreas's suggestions for Release sections.
-
-  Revision 1.16  2002/03/31 23:04:40  hal9
-  Fleshed out the doc section, and added something for an intro so it was not
-  blank.
-
-  Revision 1.15  2002/03/30 22:29:47  swa
-  wrong make flavour
-
-  Revision 1.14  2002/03/30 19:04:08  swa
-  people release differently. no good.
-  I want to make parts of the docs only.
-
-  Revision 1.13  2002/03/27 01:16:41  hal9
-  ditto
-
-  Revision 1.12  2002/03/27 01:02:51  hal9
-  Touch up on name change...
-
-  Revision 1.11  2002/03/26 22:29:55  swa
-  we have a new homepage!
-
-  Revision 1.10  2002/03/24 12:33:01  swa
-  more additions.
-
-  Revision 1.9  2002/03/24 11:01:05  swa
-  name change
-
-  Revision 1.8  2002/03/23 15:13:11  swa
-  renamed every reference to the old name with foobar.
-  fixed "application foobar application" tag, fixed
-  "the foobar" with "foobar". left junkbustser in cvs
-  comments and remarks to history untouched.
-
-  Revision 1.7  2002/03/11 13:13:27  swa
-  correct feedback channels
-
-  Revision 1.6  2002/02/24 14:25:06  jongfoster
-  Formatting changes.  Now changing the doctype to DocBook XML 4.1
-  will work - no other changes are needed.
-
-  Revision 1.5  2001/10/31 18:16:51  swa
-  documentation added: howto generate docs in text and html
-  format, howto move stuff to the webserver.
-
-  Revision 1.4  2001/09/23 10:13:48  swa
-  upload process established. run make webserver and
-  the documentation is moved to the webserver. documents
-  are now linked correctly.
-
-  Revision 1.3  2001/09/13 15:27:40  swa
-  cosmetics
-
-  Revision 1.2  2001/09/13 15:20:17  swa
-  merged standards into developer manual
-
-  Revision 1.1  2001/09/12 15:36:41  swa
-  source files for junkbuster documentation
-
-  Revision 1.3  2001/09/10 17:43:59  swa
-  first proposal of a structure.
-
-  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.
-
   -->
 
 </article>