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

diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index d7a3d8d5..fba281f1 100644
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -24,7 +24,7 @@
                 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.50 2012/05/27 15:31:24 fabiankeil Exp $
 
  Copyright (C) 2001-2012 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
@@ -51,7 +51,7 @@
     </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.50 2012/05/27 15:31:24 fabiankeil Exp $</pubdate>
 
 <!--
 
@@ -365,14 +365,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 +385,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 +583,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 +729,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 +738,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 +772,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 +819,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 +836,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 +913,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 +921,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 +975,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 +1000,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 +1025,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 +1093,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 +1116,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 +1138,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 +1146,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 +1167,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 +1197,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 +1235,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 +1284,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 +1378,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 +1401,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 +1421,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 +1441,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 +1588,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 +1643,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 +1728,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 +1764,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 +1772,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,10 +1801,10 @@ 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!)
  *
@@ -1881,10 +1855,10 @@ 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!)
  *
@@ -1955,10 +1929,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>
@@ -2755,7 +2729,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>
@@ -3066,6 +3040,34 @@ at sourceforge. Three simple steps:
   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
   $Log: developer-manual.sgml,v $
+  Revision 2.50  2012/05/27 15:31:24  fabiankeil
+  Remove a duplicated 'the'
+
+  Spotted by igor.
+
+  Revision 2.49  2012/03/20 13:05:55  fabiankeil
+  We use XXX not FIXME
+
+  Revision 2.48  2012/03/20 13:05:39  fabiankeil
+  Remove bogus section about long and short being preferable to int
+
+  Revision 2.47  2012/03/20 13:05:14  fabiankeil
+  Adjust whitespace in examples to be closer to our style
+
+  Revision 2.46  2012/03/20 13:04:54  fabiankeil
+  IJB is dead, long live Privoxy
+
+  Revision 2.45  2012/03/20 13:04:41  fabiankeil
+  The redhat-dok target no longer exists so there's no point documenting it
+
+  Revision 2.44  2012/03/20 13:04:19  fabiankeil
+  We no longer build PDFs so stop pretending
+
+  Revision 2.43  2012/03/20 13:04:03  fabiankeil
+  Comment out references to multiple branches
+
+  We currently don't use any.
+
   Revision 2.42  2012/03/20 13:03:05  fabiankeil
   Bump copyright date