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.50 2012/05/27 15:31:24 fabiankeil Exp $
Copyright (C) 2001-2012 Privoxy Developers http://www.privoxy.org/
See LICENSE.
</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.50 2012/05/27 15:31:24 fabiankeil Exp $</pubdate>
<!--
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>
<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>
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
<para><emphasis>Example for file comments:</emphasis></para>
<programlisting>
-const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
+const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
/*********************************************************************
*
- * File : $S<!-- Break CVS Substitution -->ource$
+ * File : $S<!-- Break CVS Substitution -->ource$
*
* Purpose : (Fill me in with a good description!)
*
<programlisting>
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
+#define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
/*********************************************************************
*
- * File : $S<!-- Break CVS Substitution -->ource$
+ * File : $S<!-- Break CVS Substitution -->ource$
*
* Purpose : (Fill me in with a good description!)
*
</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>
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