Don't request 'uname -a' output

[privoxy.git] / doc / source / developer-manual.sgml

diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index f0e3af8..876b6d3 100644 (file)
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -9,7 +9,7 @@
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity license SYSTEM "license.sgml">
 <!entity p-version "3.0.20">
-<!entity p-status "UNRELEASED">
+<!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,7 +24,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
 
- $Id: developer-manual.sgml,v 2.46 2012/03/20 13:04:54 fabiankeil Exp $
+ $Id: developer-manual.sgml,v 2.51 2012/06/19 12:48:04 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.46 2012/03/20 13:04:54 fabiankeil Exp $</pubdate>
+    <pubdate>$Id: developer-manual.sgml,v 2.51 2012/06/19 12:48:04 fabiankeil Exp $</pubdate>
 
 <!--
 
@@ -1643,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>
 
 
@@ -1782,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>
 
@@ -1790,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
@@ -1819,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!)
  *
@@ -1873,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!)
  *
@@ -2747,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>
@@ -3058,6 +3040,23 @@ at sourceforge. Three simple steps:
   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
   $Log: developer-manual.sgml,v $
+  Revision 2.51  2012/06/19 12:48:04  fabiankeil
+  Prevent the CVS substitution in the generated example comment as well
+
+  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