9521b097f039a50e570bf543b74a59174bdf2203
[privoxy.git] / doc / source / developer-manual.sgml
1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
2 <!entity % dummy "IGNORE"> 
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity history SYSTEM "history.sgml">
7 <!entity seealso SYSTEM "seealso.sgml">
8 <!entity contacting SYSTEM "contacting.sgml">
9 <!entity copyright SYSTEM "copyright.sgml">
10 <!entity license SYSTEM "license.sgml">
11 <!entity p-version "3.0.14">
12 <!entity p-status "BETA">
13 <!entity % p-not-stable "INCLUDE">
14 <!entity % p-stable "IGNORE">
15 <!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
16 <!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->
17 <!entity % seealso-extra "INCLUDE"> <!-- extra stuff from seealso.sgml    -->
18 <!entity  my-copy "&copy;">        <!-- kludge for docbook2man            -->
19 ]>
20 <!--
21  File        :  $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
22
23  Purpose     :  developer manual
24                 This file belongs into
25                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
26                 
27  $Id: developer-manual.sgml,v 2.29 2009/06/12 14:30:58 fabiankeil Exp $
28
29  Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
30  See LICENSE.
31
32  ========================================================================
33  NOTE: Please read developer-manual/documentation.html before touching 
34  anything in this, or other Privoxy documentation. You have been warned!
35  Failure to abide by this rule will result in the revocation of your license 
36  to live a peaceful existence!
37  ========================================================================
38
39 -->
40
41 <article id="index">
42   <artheader>
43     <title>Privoxy Developer Manual</title>
44     <pubdate>
45      <subscript>
46     <!-- Completely the wrong markup, but very little is allowed  -->
47     <!-- in this part of an article. FIXME -->
48       <link linkend="copyright">Copyright</link> &my-copy; 2001-2009 by 
49       <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
50      </subscript>
51     </pubdate>
52
53
54     <pubdate>$Id: developer-manual.sgml,v 2.29 2009/06/12 14:30:58 fabiankeil Exp $</pubdate>
55
56 <!--
57
58 Note: this should generate a separate page, and a live link to it. 
59 But it doesn't for some mysterious reason. Please leave commented
60 unless it can be fixed proper. For the time being, the copyright 
61 statement will be in copyright.smgl.
62
63 Hal.
64
65 <legalnotice id="legalnotice"> 
66  <para>
67   text goes here ........
68  </para>
69 </legalnotice>
70
71 -->
72
73     <abstract>
74
75 <![%dummy;[
76  <para>
77  <comment>
78   This is here to keep vim syntax file from breaking :/
79   If I knew enough to fix it, I would.
80   PLEASE DO NOT REMOVE! HB: hal@foobox.net
81  </comment>
82  </para>
83  ]]>
84 <para>
85  The developer manual provides guidance on coding, testing, packaging, documentation
86  and other issues of importance to those involved with
87  <application>Privoxy</application> development. It is mandatory (and helpful!) reading
88  for anyone who wants to join the team. Note that it's currently out of date
89  and may not be entirely correct. As always, patches are welcome.
90 </para>
91
92 <!-- Include privoxy.sgml boilerplate text: -->
93
94 <!--  &p-intro; Someone interested enough in the project to contribute
95                 will already know at this point what Privoxy is. -->
96
97 <!-- end boilerplate -->
98
99 <para>
100  Please note that this document is constantly evolving. This copy represents
101  the state at the release of version &p-version;.
102  You can find the latest version of the this manual at <ulink
103  url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
104  Please see <link linkend="contact">the Contact section</link> 
105  on how to contact the developers.
106 </para>
107 <!--        <para> -->
108 <!--    Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
109 <!--   </para> -->
110
111     </abstract>
112   </artheader>
113
114
115 <!--   ~~~~~       New section      ~~~~~     -->
116   <sect1 id="introduction"><title>Introduction</title>
117 <!--
118
119  I don't like seeing blank space :) So added *something* here.
120
121  --> 
122     <para>
123      <application>Privoxy</application>, as an heir to
124      <application>Junkbuster</application>, is a Free Software project 
125      and the code is licensed under the GNU General Public License version 2.
126      As such, <application>Privoxy</application> development is potentially open
127      to anyone who has the time, knowledge, and desire to contribute
128      in any capacity. Our goals are simply to continue the mission,
129      to improve <application>Privoxy</application>, and
130      to make it available to as wide an audience as possible. 
131     </para>
132     <para>
133      One does not have to be a programmer to contribute. Packaging, testing,
134      documenting and porting, are all important jobs as well.
135     </para>
136
137   <!--   ~~~~~       New section      ~~~~~     -->
138   <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
139    <para>
140     The first step is to join the <ulink
141       url="mailto:ijbswa-developers@lists.sourceforge.net">developer's mailing list</ulink>.
142     You can submit your ideas, or even better patches. Patches are best 
143     submitted to the Sourceforge tracker set up for this purpose, but 
144     can be sent to the list for review too.
145    </para>
146     <para>
147      You will also need to have a cvs package installed, which will 
148      entail having ssh installed as well (which seems to be a requirement of
149      SourceForge), in order to access the cvs repository. Having the GNU build
150      tools is also going to be important (particularly, autoconf and gmake).
151     </para>
152     <para>
153       For the time being (read, this section is under construction), you can 
154       also refer to the extensive comments in the source code. In fact, 
155       reading the code is recommended in any case.
156     </para>
157    </sect2>
158   </sect1>
159
160   <!--   ~~~~~       New section      ~~~~~     -->
161   <sect1 id="cvs"><title>The CVS Repository</title>
162     <para>
163       If you become part of the active development team, you will eventually
164       need write access to our holy grail, the CVS repository. One of the 
165       team members will need to set this up for you. Please read
166       this chapter completely before accessing via CVS.
167     </para>
168
169     <sect2 id="cvsaccess"><title>Access to CVS</title>
170       <para>
171         The project's CVS repository is hosted on
172         <ulink url="http://sourceforge.net/">SourceForge.</ulink>
173         Please refer to the chapters 6 and 7 in
174         <ulink url="http://sourceforge.net/docman/?group_id=1">SF's site
175         documentation</ulink> for the technical access details for your
176         operating system. For historical reasons, the CVS server is
177         called <literal>ijbswa.cvs.sourceforge.net</literal>, the repository is
178         called <literal>ijbswa</literal>, and the source tree module is called
179         <literal>current</literal>.
180       </para>
181     </sect2>
182
183     <sect2 id="cvsbranches">
184     <title>Branches</title>
185      <para>
186        Within the CVS repository, there are modules and branches. As
187        mentioned, the sources are in the <literal>current</literal>
188        <quote>module</quote>. Other modules are present for platform specific
189        issues. There is a webview of the CVS hierarchy at <ulink
190        url="http://ijbswa.cvs.sourceforge.net/ijbswa/">http://ijbswa.cvs.sourceforge.net/ijbswa/</ulink>,
191        which might help with visualizing how these pieces fit together.
192      </para>
193      <para>
194        Branches are used to fork a sub-development path from the main trunk.
195        Within the <literal>current</literal> module where the sources are, there
196        is always at least one <quote>branch</quote> from the main trunk
197        devoted to a stable release series. The main trunk is where active
198        development takes place for the next stable series (e.g. 3.2.x).
199        So just prior to each stable series (e.g. 3.0.x), a branch is created
200        just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
201        Once the initial stable release of any stable branch has taken place,
202        this branch is <emphasis>only used for bugfixes</emphasis>, which have
203        had prior testing before being committed to CVS. (See <link
204        linkend="versionnumbers">Version Numbers</link> below for details on
205        versioning.)
206      </para>
207      <para>
208       At one time there were two distinct branches: stable and unstable. The
209       more drastic changes were to be in the unstable branch. These branches 
210       have now been merged to minimize time and effort of maintaining two 
211       branches.
212      </para>
213     <!-- 
214      <para>
215        This will result in at least two active branches, which means there may
216        be occasions that require the same (or similar) item to be 
217        checked into to two different places (assuming its a bugfix and needs 
218        fixing in both the stable and unstable trees). This also means that in
219        order to have access to both trees, both will have to be checked out 
220        separately. Use the <literal>cvs -r</literal> flag to check out a 
221        branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
222      </para>
223     --> 
224     </sect2>
225
226     <sect2 id="cvscommit"><title>CVS Commit Guidelines</title>
227       <para>
228         The source tree is the heart of every software project. Every effort must
229         be made to ensure that it is readable, compilable and consistent at all
230         times. There are differing guidelines for the stable branch and the
231         main development trunk, and we ask anyone with CVS access to strictly
232         adhere to the following guidelines:
233       </para>
234       
235       <para>
236        Basic Guidelines, for all branches:
237       </para>
238       <para>
239         <itemizedlist>
240           <listitem><para>
241             Please don't commit even 
242             a small change without testing it thoroughly first. When we're
243             close to a public release, ask a fellow developer to review your 
244             changes.
245           </para></listitem>
246           <listitem><para>
247             Your commit message should give a concise overview of <emphasis>what you
248             changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
249             Just check previous messages for good examples.
250           </para></listitem>
251           <listitem><para>
252             Don't use the same message on multiple files, unless it equally applies to
253             all those files.
254           </para></listitem>
255           <listitem><para>
256             If your changes span multiple files, and the code won't recompile unless
257             all changes are committed (e.g. when changing the signature of a function),
258             then commit all files one after another, without long delays in between.
259             If necessary, prepare the commit messages in advance.
260           </para></listitem>
261           <listitem><para>
262             Before changing things on CVS, make sure that your changes are in line
263             with the team's general consensus on what should be done.
264           </para></listitem>
265           <listitem>
266            <para>
267             Note that near a major public release, we get more cautious.
268             There is always the possibility to submit a patch to the <ulink
269             url="http://sourceforge.net/tracker/?atid=311118&amp;group_id=11118&amp;func=browse">patch
270             tracker</ulink> instead.
271           </para>
272          </listitem> 
273         </itemizedlist>
274       </para>
275       
276 <!--
277       <para>
278        Stable branches are handled with more care, especially after the 
279        initial *.*.0 release, and we are just in bugfix mode. In addition to 
280        the above, the below applies only to the stable branch (currently the 
281        <literal>v_3_0_branch</literal> branch):
282       </para>
283       
284       <para>
285        <itemizedlist>
286         <listitem>
287          <para>
288            Do not commit <emphasis>anything</emphasis> unless your proposed
289            changes have been well tested first, preferably by other members of the
290            project, or have prior approval of the project leaders or consensus
291            of the devel list.
292          </para>
293         </listitem> 
294        <listitem>
295         <para>
296          Where possible, bugfixes and changes should be tested in the main 
297          development trunk first. There may be occasions where this is not 
298          feasible, though.
299         </para>
300        </listitem> 
301        <listitem>
302         <para>
303           Alternately, proposed changes can be submitted as patches to the patch tracker on 
304           Sourceforge first: <ulink
305           url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=311118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=311118</ulink>.
306           Then ask for peer review. 
307         </para>
308        </listitem> 
309         <listitem>
310          <para>
311           Do not even think about anything except bugfixes. No new features!
312          </para>
313         </listitem> 
314      
315        </itemizedlist>
316       </para> 
317     -->
318     </sect2>
319
320   </sect1>
321         
322   <!--   ~~~~~       New section      ~~~~~     -->
323 <sect1 id="documentation"><title>Documentation Guidelines</title>
324   <para>
325     All formal documents are maintained in Docbook SGML and located in the
326     <computeroutput>doc/source/*</computeroutput> directory. You will need
327     <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook 
328     DTD's and the Docbook modular stylesheets (or comparable alternatives),
329     and either <application>jade</application> or
330     <application>openjade</application> (recommended) installed in order to
331     build docs from source. Currently there is <ulink
332     url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
333     <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
334     course this, the <citetitle>developer-manual</citetitle> in this format.
335     The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
336     <citetitle>INSTALL</citetitle>,
337     <citetitle>privoxy.1</citetitle> (man page), and
338     <citetitle>config</citetitle> files are also now maintained as Docbook
339     SGML. These files, when built, in the top-level source directory are
340     generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a 
341     variation on this file, <filename>privoxy-index.html</filename>, 
342     meant for inclusion with doc packages), are maintained as SGML as well.
343     <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
344     contact someone involved in the documentation.
345     </para> 
346     <para>
347      <filename>config</filename> requires some special handling. The reason it
348      is maintained this way is so that the extensive comments in the file
349      mirror those in <citetitle>user-manual</citetitle>. But the conversion 
350      process requires going from SGML to HTML to text to special formatting 
351      required for the embedded comments. Some of this does not survive so
352      well. Especially some of the examples that are longer than 80 characters.
353      The build process for this file outputs to <filename>config.new</filename>, 
354      which should be reviewed for errors and mis-formatting. Once satisfied
355      that it is correct, then it should be hand copied to
356      <filename>config</filename>.
357     </para>
358     <para>
359      Other, less formal documents (e.g. <filename>LICENSE</filename>) are
360      maintained as plain text files in the top-level source directory.
361     </para>
362     <para>
363      Packagers are encouraged to include this documentation. For those without
364      the ability to build the docs locally, text versions of each are kept in
365      CVS. HTML versions are also being kept in CVS under 
366      <filename>doc/webserver/*</filename>. And PDF version are kept in 
367      <filename>doc/pdf/*</filename>.
368     </para>
369     <para>
370      Formal documents are built with the Makefile targets of
371      <computeroutput>make dok</computeroutput>, or alternately
372      <computeroutput>make redhat-dok</computeroutput>. If you have problems,
373      try both. The build process uses the document SGML sources in
374      <computeroutput>doc/source/*/*</computeroutput> to update all text files in
375      <computeroutput>doc/text/</computeroutput> and to update all HTML
376      documents in <computeroutput>doc/webserver/</computeroutput>.
377     </para>
378     <para>
379      Documentation writers should please make sure documents build
380      successfully before committing to CVS, if possible.
381     </para>
382     <para>
383      How do you update the webserver (i.e. the pages on privoxy.org)?
384      
385      <orderedlist numeration="arabic">
386       <listitem><para>
387         First, build the docs by running <computeroutput>make
388         dok</computeroutput> (or alternately <computeroutput>make
389         redhat-dok</computeroutput>). For PDF docs, do <computeroutput>make
390         dok-pdf</computeroutput>.
391       </para></listitem>
392       <listitem><para>
393         Run <computeroutput>make webserver</computeroutput> which copies all
394         files from <computeroutput>doc/webserver</computeroutput> to the
395         sourceforge webserver via scp.
396       </para></listitem>
397      </orderedlist>
398   </para>
399
400   <para>
401    Finished docs should be occasionally submitted to CVS
402    (<filename>doc/webserver/*/*.html</filename>) so that those without 
403    the ability to build them locally, have access to them if needed.
404    This is especially important just prior to a new release! Please
405    do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
406    other release specific data in <filename>configure.in</filename> has been
407    updated (this is done just prior to a new release).
408   </para>
409
410 <!--   ~~~~~       New section      ~~~~~     -->
411 <sect2 id="sgml">
412 <title>Quickstart to Docbook and SGML</title>
413 <para>
414  If you are not familiar with SGML, it is a markup language similar to HTML. 
415  Actually, not a mark up language per se, but a language used to define 
416  markup languages. In fact, HTML is an SGML application. Both will use
417  <quote>tags</quote> to format text and other content. SGML tags can be much
418  more varied, and flexible, but do much of the same kinds of things. The tags,
419  or <quote>elements</quote>, are definable in SGML. There is no set
420  <quote>standards</quote>. Since we are using
421  <application>Docbook</application>, our tags are those that are defined by 
422  <application>Docbook</application>. Much of how the finish document is
423  rendered is determined by the <quote>stylesheets</quote>.
424  The stylesheets determine how each tag gets translated to HTML, or other
425  formats.
426 </para>
427
428 <para>
429  Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
430  will likely generate errors. Example: <literal>&lt;title&gt;My
431  Title&lt;/title&gt;</literal>. They are also case-insensitive, but we
432  strongly suggest using all lower case. This keeps compatibility with
433  [Docbook] <application>XML</application>.
434 </para>
435
436 <para>
437  Our documents use <quote>sections</quote> for the most part. Sections
438  will be processed into HTML headers (e.g. <literal>h1</literal> for 
439  <literal>sect1</literal>). The <application>Docbook</application> stylesheets
440  will use these to also generate the Table of Contents for each doc. Our 
441  TOC's are set to a depth of three. Meaning <literal>sect1</literal>, 
442  <literal>sect2</literal>, and <literal>sect3</literal> will have TOC 
443  entries, but <literal>sect4</literal> will not. Each section requires 
444  a <literal>&lt;title&gt;</literal> element, and at least one 
445  <literal>&lt;para&gt;</literal>. There is a limit of five section 
446  levels in Docbook, but generally three should be sufficient for our 
447  purposes.
448 </para>
449
450 <para>
451  Some common elements that you likely will use: 
452 </para>
453
454 <para>
455   <simplelist>
456     <member>
457       <emphasis>&lt;para&gt;&lt;/para&gt;</emphasis>, paragraph delimiter. Most 
458       text needs to be within paragraph elements (there are some exceptions).
459     </member>
460     <member>
461       <emphasis>&lt;emphasis&gt;&lt;/emphasis&gt;</emphasis>, the stylesheets
462       make this italics.
463     </member>
464     <member>
465       <emphasis>&lt;filename&gt;&lt;/filename&gt;</emphasis>, files and directories.
466     </member>
467     <member>
468       <emphasis>&lt;command&gt;&lt;/command&gt;</emphasis>, command examples.
469     </member>
470     <member>
471       <emphasis>&lt;literallayout&gt;&lt;/literallayout&gt;</emphasis>, like 
472       <literal>&lt;pre&gt;</literal>, more or less.
473     </member>
474     <member>
475       <emphasis>&lt;itemizedlist&gt;&lt;/itemizedlist&gt;</emphasis>, list with bullets.
476     </member>
477     <member>
478       <emphasis>&lt;listitem&gt;&lt;/listitem&gt;</emphasis>, member of the above.
479     </member>
480     <member>
481       <emphasis>&lt;screen&gt;&lt;/screen&gt;</emphasis>, screen output, implies 
482       <literal>&lt;literallayout&gt;</literal>.
483     </member>
484     <member>
485       <emphasis>&lt;ulink url="example.com"&gt;&lt;/ulink&gt;</emphasis>, like 
486       HTML <literal>&lt;a&gt;</literal> tag.
487     </member>
488     <member>
489       <emphasis>&lt;quote&gt;&lt;/quote&gt;</emphasis>, for, doh, quoting text. 
490     </member>
491   </simplelist>
492 </para>
493
494 <para>
495  Look at any of the existing docs for examples of all these and more.
496 </para>
497
498 <para>
499  You might also find <quote><ulink
500  url="http://opensource.bureau-cornavin.com/crash-course/index.html">Writing Documentation
501  Using DocBook - A Crash Course</ulink></quote> useful.
502 </para>
503 </sect2>
504
505 <!--   ~~~~~       New section      ~~~~~     -->
506   <sect2 id="docstyle">
507   <title><application>Privoxy</application> Documentation Style</title>
508    <para>
509     It will be easier if everyone follows a similar writing style. This 
510     just makes it easier to read what someone else has written if it 
511     is all done in a similar fashion.
512    </para>
513    <para>
514     Here it is:
515    </para>
516    <para>
517     <itemizedlist>
518      <listitem>
519       <para>
520        All tags should be lower case.
521       </para>
522     </listitem> 
523     <listitem>
524      <para>
525        Tags delimiting a <emphasis>block</emphasis> of text (even small
526        blocks) should be on their own line. Like:
527        <literallayout>
528  &lt;para&gt;
529   Some text goes here.
530  &lt;/para&gt;
531        </literallayout>
532        Tags marking individual words, or few words, should be in-line:
533        <literallayout>
534   Just to &lt;emphasis&gt;emphasize&lt;/emphasis&gt;, some text goes here.
535        </literallayout>
536      </para>
537    </listitem> 
538    <listitem>
539     <para>
540       Tags should be nested and step indented for block text like: (except
541       in-line tags) 
542      <literallayout>
543  &lt;para&gt;
544   &lt;itemizedlist&gt;
545    &lt;para&gt;
546     &lt;listitem&gt;
547       Some text goes here in our list example.
548      &lt;/listitem&gt;
549    &lt;/para&gt;
550   &lt;/itemizedlist&gt;
551  &lt;/para&gt;
552        </literallayout>
553       This makes it easier to find the text amongst the tags ;-)
554     </para>
555    </listitem> 
556    <listitem>
557     <para>
558      Use white space to separate logical divisions within a document, 
559      like between sections. Running everything together consistently 
560      makes it harder to read and work on.
561     </para>
562    </listitem> 
563    <listitem>
564     <para>
565      Do not hesitate to make comments. Comments can either use the 
566      &lt;comment&gt; element, or the &lt;!--  --&gt; style comment 
567      familiar from HTML. (Note in Docbook v4.x &lt;comment&gt; is 
568      replaced by &lt;remark&gt;.)
569     </para>
570   </listitem> 
571   <listitem>
572    <para>
573      We have an international audience. Refrain from slang, or English 
574      idiosyncrasies (too many to list :). Humor also does not translate 
575      well sometimes.
576    </para>
577   </listitem> 
578   <listitem>
579    <para>
580     Try to keep overall line lengths in source files to 80 characters or less
581     for obvious reasons. This is not always possible, with lengthy URLs for
582     instance.
583    </para>
584   </listitem> 
585   <listitem>
586    <para>
587     Our documents are available in differing formats. Right now, they 
588     are just plain text, HTML, and PDF, but others are always a 
589     future possibility. Be careful with URLs (&lt;ulink&gt;), and avoid 
590     this mistake:
591    </para>
592    <para>
593      My favorite site is &lt;ulink url="http://example.com"&gt;here&lt;/ulink&gt;.
594    </para>
595    <para>
596      This will render as <quote>My favorite site is here</quote>, which is 
597      not real helpful in a text doc. Better like this:
598    </para>
599    <para>
600      My favorite site is &lt;ulink url="http://example.com"&gt;example.com&lt;/ulink&gt;.
601    </para>
602   </listitem>
603   <listitem>
604    <para>
605     All documents should be spell checked occasionally.
606     <application>aspell</application> can check SGML with the
607     <literal>-H</literal> option. (<application>ispell</application> I think
608     too.)
609    </para>
610   </listitem> 
611
612   </itemizedlist>
613  </para> 
614   
615   </sect2>
616
617   
618  <!--   ~~~~~       New section      ~~~~~     -->
619
620  <sect2><title>Privoxy Custom Entities</title>
621  <para>
622   <application>Privoxy</application> documentation is using 
623   a number of customized <quote>entities</quote> to facilitate 
624   documentation maintenance. 
625  </para>
626  <para>
627   We are using a set of <quote>boilerplate</quote> files with generic text,
628   that is used by multiple docs. This way we can write something once, and use
629   it repeatedly without having to re-write the same content over and over again.
630   If editing such a file, keep in mind that it should be
631   <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying 
632   contexts without additional modifications.
633  </para>
634  <para>
635   We are also using what <application>Docbook</application> calls 
636   <quote>internal entities</quote>. These are like variables in 
637   programming. Well, sort of. For instance, we have the
638   <literal>p-version</literal> entity that contains the current 
639   <application>Privoxy</application> version string. You are strongly 
640   encouraged to use these where possible. Some of these obviously 
641   require re-setting with each release (done by the Makefile). A sampling of
642   custom entities are listed below. See any of the main docs for examples.
643  </para>
644
645  <para>
646   <itemizedlist>
647   <listitem>
648    <para>
649     Re- <quote>boilerplate</quote> text entities are defined like:
650    </para>
651    <para>
652     <literal>&lt;!entity supported SYSTEM "supported.sgml"&gt;</literal>
653    </para>
654    <para>
655      In this example, the contents of the file,
656      <filename>supported.sgml</filename> is available for inclusion anywhere 
657      in the doc. To make this happen, just reference the now defined 
658      entity: <literal>&#38;supported;</literal> (starts with an ampersand 
659      and ends with a semi-colon), and the contents will be dumped into 
660      the finished doc at that point.
661    </para>
662   </listitem> 
663   <listitem>
664    <para>
665     Commonly used <quote>internal entities</quote>:
666   </para>
667   <simplelist>
668    <member>
669     <emphasis>p-version</emphasis>: the <application>Privoxy</application> 
670     version string, e.g. <quote>&p-version;</quote>.
671    </member>
672    <member>
673     <emphasis>p-status</emphasis>: the project status, either 
674     <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
675    </member>
676    <member>
677     <emphasis>p-not-stable</emphasis>: use to conditionally include 
678     text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
679    </member>
680    <member>
681     <emphasis>p-stable</emphasis>: just the opposite.
682    </member>
683    <member>
684     <emphasis>p-text</emphasis>: this doc is only generated as text.
685    </member>
686   </simplelist>
687  </listitem> 
688  </itemizedlist>
689  </para> 
690  <para>
691   There are others in various places that are defined for a specific 
692   purpose. Read the source!
693  </para>
694  
695  </sect2>
696   
697  </sect1>
698
699 <!--     <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
700 <!--       points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
701
702   <!--   ~~~~~       New section      ~~~~~     -->
703   <sect1 id="coding"><title>Coding Guidelines</title>
704
705     <sect2 id="s1"><title>Introduction</title>
706
707     <para>This set of standards is designed to make our lives easier.  It is
708     developed with the simple goal of helping us keep the "new and improved
709     <application>Privoxy</application>" consistent and reliable. Thus making
710     maintenance easier and increasing chances of success of the
711     project.</para>
712
713     <para>And that of course comes back to us as individuals. If we can
714     increase our development and product efficiencies then we can solve more
715     of the request for changes/improvements and in general feel good about
716     ourselves. ;-></para>
717
718   </sect2>
719
720     <sect2 id="s2"><title>Using Comments</title>
721  
722
723     <sect3 id="s3"><title>Comment, Comment, Comment</title>
724
725     <para><emphasis>Explanation:</emphasis></para>
726
727     <para>Comment as much as possible without commenting the obvious.
728     For example do not comment "variable_a is equal to variable_b".
729     Instead explain why variable_a should be equal to the variable_b.
730     Just because a person can read code does not mean they will
731     understand why or what is being done. A reader may spend a lot
732     more time figuring out what is going on when a simple comment
733     or explanation would have prevented the extra research. Please
734     help your brother IJB'ers out!</para>
735
736     <para>The comments will also help justify the intent of the code.
737     If the comment describes something different than what the code
738     is doing then maybe a programming error is occurring.</para>
739
740     <para><emphasis>Example:</emphasis></para>
741 <programlisting>
742 /* if page size greater than 1k ... */
743 if ( page_length() > 1024 )
744 {
745     ... "block" the page up ...
746 }
747
748 /* if page size is small, send it in blocks */
749 if ( page_length() > 1024 )
750 {
751     ... "block" the page up ...
752 }
753
754 This demonstrates 2 cases of "what not to do".  The first is a
755 "syntax comment".  The second is a comment that does not fit what
756 is actually being done.
757 </programlisting>
758   </sect3>
759
760     
761
762     <sect3 id="s4"><title>Use blocks for comments</title>
763
764     <para><emphasis>Explanation:</emphasis></para>
765
766     <para>Comments can help or they can clutter. They help when they
767     are differentiated from the code they describe. One line
768     comments do not offer effective separation between the comment
769     and the code. Block identifiers do, by surrounding the code
770     with a clear, definable pattern.</para>
771
772     <para><emphasis>Example:</emphasis></para>
773 <programlisting>
774 /*********************************************************************
775  * This will stand out clearly in your code!
776  *********************************************************************/
777 if ( this_variable == that_variable )
778 {
779    do_something_very_important();
780 }
781
782
783 /* unfortunately, this may not */
784 if ( this_variable == that_variable )
785 {
786    do_something_very_important();
787 }
788
789
790 if ( this_variable == that_variable ) /* this may not either */
791 {
792    do_something_very_important();
793 }</programlisting>
794
795     <para><emphasis>Exception:</emphasis></para>
796
797     <para>If you are trying to add a small logic comment and do not
798     wish to "disrupt" the flow of the code, feel free to use a 1
799     line comment which is NOT on the same line as the code.</para>
800
801     
802   </sect3>
803     
804
805     <sect3 id="s5"><title>Keep Comments on their own line</title>
806
807     <para><emphasis>Explanation:</emphasis></para>
808
809     <para>It goes back to the question of readability. If the comment
810     is on the same line as the code it will be harder to read than
811     the comment that is on its own line.</para>
812
813     <para>There are three exceptions to this rule, which should be
814     violated freely and often: during the definition of variables,
815     at the end of closing braces, when used to comment
816     parameters.</para>
817
818     <para><emphasis>Example:</emphasis></para>
819 <programlisting>
820 /*********************************************************************
821  * This will stand out clearly in your code,
822  * But the second example won't.
823  *********************************************************************/
824 if ( this_variable == this_variable )
825 {
826    do_something_very_important();
827 }
828
829 if ( this_variable == this_variable ) /*can you see me?*/
830 {
831    do_something_very_important(); /*not easily*/
832 }
833
834
835 /*********************************************************************
836  * But, the encouraged exceptions:
837  *********************************************************************/
838 int urls_read     = 0;     /* # of urls read + rejected */
839 int urls_rejected = 0;     /* # of urls rejected */
840
841 if ( 1 == X )
842 {
843    do_something_very_important();
844 }
845
846
847 short do_something_very_important(
848    short firstparam,   /* represents something */
849    short nextparam     /* represents something else */ )
850 {
851    ...code here...
852
853 }   /* -END- do_something_very_important */
854 </programlisting>
855   </sect3>
856     
857
858     <sect3 id="s6"><title>Comment each logical step</title>
859
860     <para><emphasis>Explanation:</emphasis></para>
861
862     <para>Logical steps should be commented to help others follow the
863     intent of the written code and comments will make the code more
864     readable.</para>
865
866     <para>If you have 25 lines of code without a comment, you should
867     probably go back into it to see where you forgot to put
868     one.</para>
869
870     <para>Most "for", "while", "do", etc... loops _probably_ need a
871     comment. After all, these are usually major logic
872     containers.</para>
873
874     
875   </sect3>
876     
877
878     <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
879
880     <para><emphasis>Explanation:</emphasis></para>
881
882     <para>A reader of the code should be able to look at the comments
883     just prior to the beginning of a function and discern the
884     reason for its existence and the consequences of using it. The
885     reader should not have to read through the code to determine if
886     a given function is safe for a desired use. The proper
887     information thoroughly presented at the introduction of a
888     function not only saves time for subsequent maintenance or
889     debugging, it more importantly aids in code reuse by allowing a
890     user to determine the safety and applicability of any function
891     for the problem at hand. As a result of such benefits, all
892     functions should contain the information presented in the
893     addendum section of this document.</para>
894
895     
896   </sect3>
897     
898
899     <sect3 id="s8"><title>Comment at the end of braces if the
900     content is more than one screen length</title>
901
902     <para><emphasis>Explanation:</emphasis></para>
903
904     <para>Each closing brace should be followed on the same line by a
905     comment that describes the origination of the brace if the
906     original brace is off of the screen, or otherwise far away from
907     the closing brace. This will simplify the debugging,
908     maintenance, and readability of the code.</para>
909
910     <para>As a suggestion , use the following flags to make the
911     comment and its brace more readable:</para>
912
913     <para>use following a closing brace: } /* -END- if() or while ()
914     or etc... */</para>
915
916     <para><emphasis>Example:</emphasis></para>
917 <programlisting>
918 if ( 1 == X )
919 {
920    do_something_very_important();
921    ...some long list of commands...
922 } /* -END- if x is 1 */
923
924 or:
925
926 if ( 1 == X )
927 {
928    do_something_very_important();
929    ...some long list of commands...
930 } /* -END- if ( 1 == X ) */
931 </programlisting>
932   </sect3>
933     
934   </sect2>
935
936     <sect2 id="s9"><title>Naming Conventions</title>
937
938     
939
940     <sect3 id="s10"><title>Variable Names</title>
941
942     <para><emphasis>Explanation:</emphasis></para>
943
944     <para>Use all lowercase, and separate words via an underscore
945     ('_'). Do not start an identifier with an underscore. (ANSI C
946     reserves these for use by the compiler and system headers.) Do
947     not use identifiers which are reserved in ANSI C++. (E.g.
948     template, class, true, false, ...). This is in case we ever
949     decide to port Privoxy to C++.</para>
950
951     <para><emphasis>Example:</emphasis></para>
952 <programlisting>
953 int ms_iis5_hack = 0;</programlisting>
954
955     <para><emphasis>Instead of:</emphasis></para>
956
957     <para>
958 <programlisting>
959 int msiis5hack = 0; int msIis5Hack = 0;
960 </programlisting>
961 </para>
962
963     
964
965   </sect3>    
966
967     <sect3 id="s11"><title>Function Names</title>
968
969     <para><emphasis>Explanation:</emphasis></para>
970
971     <para>Use all lowercase, and separate words via an underscore
972     ('_'). Do not start an identifier with an underscore. (ANSI C
973     reserves these for use by the compiler and system headers.) Do
974     not use identifiers which are reserved in ANSI C++. (E.g.
975     template, class, true, false, ...). This is in case we ever
976     decide to port Privoxy to C++.</para>
977
978     <para><emphasis>Example:</emphasis></para>
979 <programlisting>
980 int load_some_file( struct client_state *csp )</programlisting>
981
982     <para><emphasis>Instead of:</emphasis></para>
983
984     <para>
985 <programlisting>
986 int loadsomefile( struct client_state *csp )
987 int loadSomeFile( struct client_state *csp )
988 </programlisting>
989 </para>
990
991     
992   </sect3>
993     
994
995     <sect3 id="s12"><title>Header file prototypes</title>
996
997     <para><emphasis>Explanation:</emphasis></para>
998
999     <para>Use a descriptive parameter name in the function prototype
1000     in header files. Use the same parameter name in the header file
1001     that you use in the c file.</para>
1002
1003     <para><emphasis>Example:</emphasis></para>
1004 <programlisting>
1005 (.h) extern int load_aclfile( struct client_state *csp );
1006 (.c) int load_aclfile( struct client_state *csp )</programlisting>
1007
1008     <para><emphasis>Instead of:</emphasis>
1009 <programlisting>
1010 (.h) extern int load_aclfile( struct client_state * ); or 
1011 (.h) extern int load_aclfile(); 
1012 (.c) int load_aclfile( struct client_state *csp )
1013 </programlisting>
1014 </para>
1015
1016     
1017   </sect3>
1018     
1019
1020     <sect3 id="s13"><title>Enumerations, and #defines</title>
1021
1022     <para><emphasis>Explanation:</emphasis></para>
1023
1024     <para>Use all capital letters, with underscores between words. Do
1025     not start an identifier with an underscore. (ANSI C reserves
1026     these for use by the compiler and system headers.)</para>
1027
1028     <para><emphasis>Example:</emphasis></para>
1029 <programlisting>
1030 (enumeration) : enum Boolean { FALSE, TRUE };
1031 (#define) : #define DEFAULT_SIZE 100;</programlisting>
1032
1033     <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
1034     that toggle a feature in the preprocessor: FEATURE_>, where
1035     > is a short (preferably 1 or 2 word) description.</para>
1036
1037     <para><emphasis>Example:</emphasis></para>
1038 <programlisting>
1039 #define FEATURE_FORCE 1
1040
1041 #ifdef FEATURE_FORCE
1042 #define FORCE_PREFIX blah
1043 #endif /* def FEATURE_FORCE */
1044 </programlisting>
1045   </sect3>
1046     
1047
1048     <sect3 id="s14"><title>Constants</title>
1049
1050     <para><emphasis>Explanation:</emphasis></para>
1051
1052     <para>Spell common words out entirely (do not remove vowels).</para>
1053
1054     <para>Use only widely-known domain acronyms and abbreviations.
1055     Capitalize all letters of an acronym.</para>
1056
1057     <para>Use underscore (_) to separate adjacent acronyms and
1058     abbreviations. Never terminate a name with an underscore.</para>
1059
1060     <para><emphasis>Example:</emphasis></para>
1061 <programlisting>
1062 #define USE_IMAGE_LIST 1</programlisting>
1063
1064     <para><emphasis>Instead of:</emphasis></para>
1065
1066     <para>
1067 <programlisting>
1068 #define USE_IMG_LST 1 or 
1069 #define _USE_IMAGE_LIST 1 or
1070 #define USE_IMAGE_LIST_ 1 or 
1071 #define use_image_list 1 or
1072 #define UseImageList 1
1073 </programlisting>
1074 </para>
1075
1076     
1077   </sect3>
1078
1079   </sect2>
1080     
1081
1082     <sect2 id="s15"><title>Using Space</title>
1083
1084     
1085
1086     <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1087
1088     <para><emphasis>Explanation:</emphasis></para>
1089
1090     <para>The brace needs to be on a line all by itself, not at the
1091     end of the statement. Curly braces should line up with the
1092     construct that they're associated with. This practice makes it
1093     easier to identify the opening and closing braces for a
1094     block.</para>
1095
1096     <para><emphasis>Example:</emphasis></para>
1097 <programlisting>
1098 if ( this == that )
1099 {
1100    ...
1101 }</programlisting>
1102
1103     <para><emphasis>Instead of:</emphasis></para>
1104
1105     <para>if ( this == that ) { ... }</para>
1106
1107     <para>or</para>
1108
1109     <para>if ( this == that ) { ... }</para>
1110
1111     <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1112     inside a loop, and it is trivial, i.e. it tests for a
1113     condition that is obvious from the purpose of the block,
1114     one-liners as above may optically preserve the loop structure
1115     and make it easier to read.</para>
1116
1117     <para><emphasis>Status:</emphasis> developer-discretion.</para>
1118
1119     <para><emphasis>Example exception:</emphasis></para>
1120 <programlisting>
1121 while ( more lines are read )
1122 {
1123    /* Please document what is/is not a comment line here */
1124    if ( it's a comment ) continue;
1125
1126    do_something( line );
1127 }
1128 </programlisting>
1129   </sect3>
1130     
1131
1132     <sect3 id="s17"><title>ALL control statements should have a
1133     block</title>
1134
1135     <para><emphasis>Explanation:</emphasis></para>
1136
1137     <para>Using braces to make a block will make your code more
1138     readable and less prone to error. All control statements should
1139     have a block defined.</para>
1140
1141     <para><emphasis>Example:</emphasis></para>
1142 <programlisting>
1143 if ( this == that )
1144 {
1145    do_something();
1146    do_something_else();
1147 }</programlisting>
1148
1149     <para><emphasis>Instead of:</emphasis></para>
1150
1151     <para>if ( this == that ) do_something(); do_something_else();</para>
1152
1153     <para>or</para>
1154
1155     <para>if ( this == that ) do_something();</para>
1156
1157     <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1158     in a manner other than that which the developer desired (per
1159     indentation). Using code braces would have prevented this
1160     "feature". The "explanation" and "exception" from the point
1161     above also applies.</para>
1162
1163     
1164   </sect3>
1165     
1166
1167     <sect3 id="s18"><title>Do not belabor/blow-up boolean
1168     expressions</title>
1169
1170     <para><emphasis>Example:</emphasis></para>
1171 <programlisting>
1172 structure->flag = ( condition );</programlisting>
1173
1174     <para><emphasis>Instead of:</emphasis></para>
1175
1176     <para>if ( condition ) { structure->flag = 1; } else {
1177     structure->flag = 0; }</para>
1178
1179     <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1180     is wordy and inefficient. Please assume that any developer new
1181     to the project has at least a "good" knowledge of C/C++. (Hope
1182     I do not offend by that last comment ... 8-)</para>
1183
1184     
1185   </sect3>
1186     
1187
1188     <sect3 id="s19"><title>Use white space freely because it is
1189     free</title>
1190
1191     <para><emphasis>Explanation:</emphasis></para>
1192
1193     <para>Make it readable. The notable exception to using white space
1194     freely is listed in the next guideline.</para>
1195
1196     <para><emphasis>Example:</emphasis></para>
1197 <programlisting>
1198 int first_value   = 0;
1199 int some_value    = 0;
1200 int another_value = 0;
1201 int this_variable = 0;
1202
1203 if ( this_variable == this_variable )
1204
1205 first_value = old_value + ( ( some_value - another_value ) - whatever )
1206 </programlisting>
1207   </sect3>
1208     
1209
1210     <sect3 id="s20"><title>Don't use white space around structure
1211     operators</title>
1212
1213     <para><emphasis>Explanation:</emphasis></para>
1214
1215     <para>- structure pointer operator ( "->" ) - member operator (
1216     "." ) - functions and parentheses</para>
1217
1218     <para>It is a general coding practice to put pointers, references,
1219     and function parentheses next to names. With spaces, the
1220     connection between the object and variable/function name is not
1221     as clear.</para>
1222
1223     <para><emphasis>Example:</emphasis></para>
1224 <programlisting>
1225 a_struct->a_member;
1226 a_struct.a_member;
1227 function_name();</programlisting>
1228
1229     <para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
1230     function_name ();</para>
1231
1232     
1233   </sect3>
1234     
1235
1236     <sect3 id="s21"><title>Make the last brace of a function stand
1237     out</title>
1238
1239     <para><emphasis>Example:</emphasis></para>
1240 <programlisting>
1241 int function1( ... )
1242 {
1243    ...code...
1244    return( ret_code );
1245
1246 }   /* -END- function1 */
1247
1248
1249 int function2( ... )
1250 {
1251 }   /* -END- function2 */
1252 </programlisting>
1253
1254     <para><emphasis>Instead of:</emphasis></para>
1255
1256     <para>int function1( ... ) { ...code... return( ret_code ); } int
1257     function2( ... ) { }</para>
1258
1259     <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1260     lines afterward. This makes the end of function standout to
1261     the most casual viewer. Although function comments help
1262     separate functions, this is still a good coding practice. In
1263     fact, I follow these rules when using blocks in "for", "while",
1264     "do" loops, and long if {} statements too. After all whitespace
1265     is free!</para>
1266
1267     <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1268     lines. Enforced is the end of function comments.</para>
1269
1270     
1271   </sect3>
1272     
1273
1274     <sect3 id="s22"><title>Use 3 character indentions</title>
1275
1276     <para><emphasis>Explanation:</emphasis></para>
1277
1278     <para>If some use 8 character TABs and some use 3 character TABs,
1279     the code can look *very* ragged. So use 3 character indentions
1280     only. If you like to use TABs, pass your code through a filter
1281     such as "expand -t3" before checking in your code.</para>
1282
1283     <para><emphasis>Example:</emphasis></para>
1284 <programlisting>
1285 static const char * const url_code_map[256] =
1286 {
1287    NULL, ...
1288 };
1289
1290
1291 int function1( ... )
1292 {
1293    if ( 1 )
1294    {
1295       return( ALWAYS_TRUE );
1296    }
1297    else
1298    {
1299       return( HOW_DID_YOU_GET_HERE );
1300    }
1301
1302    return( NEVER_GETS_HERE );
1303
1304 }
1305 </programlisting>
1306   </sect3>
1307
1308   </sect2>
1309     
1310
1311     <sect2 id="s23"><title>Initializing</title>
1312
1313     
1314
1315     <sect3 id="s24"><title>Initialize all variables</title>
1316
1317     <para><emphasis>Explanation:</emphasis></para>
1318
1319     <para>Do not assume that the variables declared will not be used
1320     until after they have been assigned a value somewhere else in
1321     the code. Remove the chance of accidentally using an unassigned
1322     variable.</para>
1323
1324     <para><emphasis>Example:</emphasis></para>
1325 <programlisting>
1326 short a_short = 0;
1327 float a_float  = 0;
1328 struct *ptr = NULL;</programlisting>
1329
1330     <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1331     message says you are trying to access memory address 00000000
1332     and not 129FA012; or array_ptr[20] causes a SIGSEV vs.
1333     array_ptr[0].</para>
1334
1335     <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1336     variable is assigned a value "shortly after" declaration.</para>
1337
1338   </sect3>
1339   </sect2>
1340     
1341
1342     <sect2 id="s25"><title>Functions</title>
1343
1344     
1345
1346     <sect3 id="s26"><title>Name functions that return a boolean as a
1347     question.</title>
1348
1349     <para><emphasis>Explanation:</emphasis></para>
1350
1351     <para>Value should be phrased as a question that would logically
1352     be answered as a true or false statement</para>
1353
1354     <para><emphasis>Example:</emphasis></para>
1355 <programlisting>
1356 should_we_block_this();
1357 contains_an_image();
1358 is_web_page_blank();
1359 </programlisting>
1360   </sect3>
1361     
1362
1363     <sect3 id="s27"><title>Always specify a return type for a
1364     function.</title>
1365
1366     <para><emphasis>Explanation:</emphasis></para>
1367
1368     <para>The default return for a function is an int. To avoid
1369     ambiguity, create a return for a function when the return has a
1370     purpose, and create a void return type if the function does not
1371     need to return anything.</para>
1372
1373     
1374   </sect3>
1375     
1376
1377     <sect3 id="s28"><title>Minimize function calls when iterating by
1378     using variables</title>
1379
1380     <para><emphasis>Explanation:</emphasis></para>
1381
1382     <para>It is easy to write the following code, and a clear argument
1383     can be made that the code is easy to understand:</para>
1384
1385     <para><emphasis>Example:</emphasis></para>
1386 <programlisting>
1387 for ( size_t cnt = 0; cnt &lt; block_list_length(); cnt++ )
1388 {
1389    ....
1390 }</programlisting>
1391
1392     <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1393     each and every iteration. This increases the overhead in the
1394     program, because the compiler has to look up the function each
1395     time, call it, and return a value. Depending on what occurs in
1396     the block_list_length() call, it might even be creating and
1397     destroying structures with each iteration, even though in each
1398     case it is comparing "cnt" to the same value, over and over.
1399     Remember too - even a call to block_list_length() is a function
1400     call, with the same overhead.</para>
1401
1402     <para>Instead of using a function call during the iterations,
1403     assign the value to a variable, and evaluate using the
1404     variable.</para>
1405
1406     <para><emphasis>Example:</emphasis></para>
1407 <programlisting>
1408 size_t len = block_list_length();
1409
1410 for ( size_t cnt = 0; cnt &lt; len; cnt++ )
1411 {
1412    ....
1413 }</programlisting>
1414
1415     <para><emphasis>Exceptions:</emphasis> if the value of block_list_length()
1416     *may* change or could *potentially* change, then you must code the
1417     function call in the for/while loop.</para>
1418
1419     
1420   </sect3>
1421     
1422
1423     <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1424
1425     <para><emphasis>Explanation:</emphasis></para>
1426
1427     <para>This allows a developer to define a const pointer and call
1428     your function. If your function does not have the const
1429     keyword, we may not be able to use your function. Consider
1430     strcmp, if it were defined as: extern int strcmp( char *s1,
1431     char *s2 );</para>
1432
1433     <para>I could then not use it to compare argv's in main: int main(
1434     int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
1435     ); }</para>
1436
1437     <para>Both these pointers are *const*! If the c runtime library
1438     maintainers do it, we should too.</para>
1439
1440     
1441   </sect3>
1442     
1443
1444     <sect3 id="s30"><title>Pass and Return by Value</title>
1445
1446     <para><emphasis>Explanation:</emphasis></para>
1447
1448     <para>Most structures cannot fit onto a normal stack entry (i.e.
1449     they are not 4 bytes or less). Aka, a function declaration
1450     like: int load_aclfile( struct client_state csp )</para>
1451
1452     <para>would not work. So, to be consistent, we should declare all
1453     prototypes with "pass by value": int load_aclfile( struct
1454     client_state *csp )</para>
1455
1456     
1457   </sect3>
1458     
1459
1460     <sect3 id="s31"><title>Names of include files</title>
1461
1462     <para><emphasis>Explanation:</emphasis></para>
1463
1464     <para>Your include statements should contain the file name without
1465     a path. The path should be listed in the Makefile, using -I as
1466     processor directive to search the indicated paths. An exception
1467     to this would be for some proprietary software that utilizes a
1468     partial path to distinguish their header files from system or
1469     other header files.</para>
1470
1471     <para><emphasis>Example:</emphasis></para>
1472 <programlisting>
1473 #include &lt;iostream.h&gt;     /* This is not a local include */
1474 #include "config.h"       /* This IS a local include */
1475 </programlisting>
1476
1477     <para><emphasis>Exception:</emphasis></para>
1478
1479     <para>
1480 <programlisting>
1481 /* This is not a local include, but requires a path element. */ 
1482 #include &lt;sys/fileName.h&gt;
1483 </programlisting>
1484 </para>
1485
1486     <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1487     without a _very_ good reason. This duplicates the #include
1488     "file.h" behavior.</para>
1489
1490     
1491   </sect3>
1492     
1493
1494     <sect3 id="s32"><title>Provide multiple inclusion
1495     protection</title>
1496
1497     <para><emphasis>Explanation:</emphasis></para>
1498
1499     <para>Prevents compiler and linker errors resulting from
1500     redefinition of items.</para>
1501
1502     <para>Wrap each header file with the following syntax to prevent
1503     multiple inclusions of the file. Of course, replace PROJECT_H
1504     with your file name, with "." Changed to "_", and make it
1505     uppercase.</para>
1506
1507     <para><emphasis>Example:</emphasis></para>
1508 <programlisting>
1509 #ifndef PROJECT_H_INCLUDED
1510 #define PROJECT_H_INCLUDED
1511  ...
1512 #endif /* ndef PROJECT_H_INCLUDED */
1513 </programlisting>
1514   </sect3>
1515     
1516
1517     <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1518
1519     <para><emphasis>Explanation:</emphasis></para>
1520
1521     <para>If our headers are included from C++, they must declare our
1522     functions as `extern "C"`. This has no cost in C, but increases
1523     the potential re-usability of our code.</para>
1524
1525     <para><emphasis>Example:</emphasis></para>
1526 <programlisting>
1527 #ifdef __cplusplus
1528 extern "C"
1529 {
1530 #endif /* def __cplusplus */
1531
1532 ... function definitions here ...
1533
1534 #ifdef __cplusplus
1535 }
1536 #endif /* def __cplusplus */
1537 </programlisting>
1538   </sect3>
1539     
1540
1541     <sect3 id="s34"><title>Where Possible, Use Forward Struct
1542     Declaration Instead of Includes</title>
1543
1544     <para><emphasis>Explanation:</emphasis></para>
1545
1546     <para>Useful in headers that include pointers to other struct's.
1547     Modifications to excess header files may cause needless
1548     compiles.</para>
1549
1550     <para><emphasis>Example:</emphasis></para>
1551 <programlisting>
1552 /*********************************************************************
1553  * We're avoiding an include statement here!
1554  *********************************************************************/
1555 struct file_list;
1556 extern file_list *xyz;</programlisting>
1557
1558     <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1559     pointer), then including the proper header file is necessary.
1560     If you only want to prototype a pointer, however, the header
1561     file is unnecessary.</para>
1562
1563     <para><emphasis>Status:</emphasis> Use with discretion.</para>
1564
1565     
1566   </sect3>
1567   </sect2>
1568
1569     <sect2 id="s35"><title>General Coding Practices</title>
1570
1571     
1572
1573     <sect3 id="s36"><title>Turn on warnings</title>
1574
1575     <para><emphasis>Explanation</emphasis></para>
1576
1577     <para>Compiler warnings are meant to help you find bugs. You
1578     should turn on as many as possible. With GCC, the switch is
1579     "-Wall". Try and fix as many warnings as possible.</para>
1580
1581     
1582   </sect3>
1583     
1584
1585     <sect3 id="s37"><title>Provide a default case for all switch
1586     statements</title>
1587
1588     <para><emphasis>Explanation:</emphasis></para>
1589
1590     <para>What you think is guaranteed is never really guaranteed. The
1591     value that you don't think you need to check is the one that
1592     someday will be passed. So, to protect yourself from the
1593     unknown, always have a default step in a switch statement.</para>
1594
1595     <para><emphasis>Example:</emphasis></para>
1596 <programlisting>
1597 switch( hash_string( cmd ) )
1598 {
1599    case hash_actions_file :
1600       ... code ...
1601       break;
1602
1603    case hash_confdir :
1604       ... code ...
1605       break;
1606
1607    default :
1608       log_error( ... );
1609       ... anomaly code goes here ...
1610       continue; / break; / exit( 1 ); / etc ...
1611
1612 } /* end switch( hash_string( cmd ) ) */</programlisting>
1613
1614     <para><emphasis>Note:</emphasis> If you already have a default condition, you
1615     are obviously exempt from this point. Of note, most of the
1616     WIN32 code calls `DefWindowProc' after the switch statement.
1617     This API call *should* be included in a default statement.</para>
1618
1619     <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1620     as a robust programming issue. The "anomaly code goes here" may
1621     be no more than a print to the STDERR stream (as in
1622     load_config). Or it may really be an abort condition.</para>
1623
1624     <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1625
1626     
1627   </sect3>
1628     
1629
1630     <sect3 id="s38"><title>Try to avoid falling through cases in a
1631     switch statement.</title>
1632
1633     <para><emphasis>Explanation:</emphasis></para>
1634
1635     <para>In general, you will want to have a 'break' statement within
1636     each 'case' of a switch statement. This allows for the code to
1637     be more readable and understandable, and furthermore can
1638     prevent unwanted surprises if someone else later gets creative
1639     and moves the code around.</para>
1640
1641     <para>The language allows you to plan the fall through from one
1642     case statement to another simply by omitting the break
1643     statement within the case statement. This feature does have
1644     benefits, but should only be used in rare cases. In general,
1645     use a break statement for each case statement.</para>
1646
1647     <para>If you choose to allow fall through, you should comment both
1648     the fact of the fall through and reason why you felt it was
1649     necessary.</para>
1650
1651     
1652   </sect3>
1653     
1654
1655     <sect3 id="s39"><title>Use 'long' or 'short' Instead of
1656     'int'</title>
1657
1658     <para><emphasis>Explanation:</emphasis></para>
1659
1660     <para>On 32-bit platforms, int usually has the range of long. On
1661     16-bit platforms, int has the range of short.</para>
1662
1663     <para><emphasis>Status:</emphasis> open-to-debate. In the case of most FSF
1664     projects (including X/GNU-Emacs), there are typedefs to int4,
1665     int8, int16, (or equivalence ... I forget the exact typedefs
1666     now). Should we add these to IJB now that we have a "configure"
1667     script?</para>
1668
1669     
1670   </sect3>
1671     
1672
1673     <sect3 id="s40"><title>Don't mix size_t and other types</title>
1674
1675     <para><emphasis>Explanation:</emphasis></para>
1676
1677     <para>The type of size_t varies across platforms. Do not make
1678     assumptions about whether it is signed or unsigned, or about
1679     how long it is. Do not compare a size_t against another
1680     variable of a different type (or even against a constant)
1681     without casting one of the values.</para>
1682
1683     
1684   </sect3>
1685     
1686
1687     <sect3 id="s41"><title>Declare each variable and struct on its
1688     own line.</title>
1689
1690     <para><emphasis>Explanation:</emphasis></para>
1691
1692     <para>It can be tempting to declare a series of variables all on
1693     one line. Don't.</para>
1694
1695     <para><emphasis>Example:</emphasis></para>
1696 <programlisting>
1697 long a = 0;
1698 long b = 0;
1699 long c = 0;</programlisting>
1700
1701     <para><emphasis>Instead of:</emphasis></para>
1702
1703     <para>long a, b, c;</para>
1704
1705     <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1706     individual variables - easier to add new variables without
1707     messing up the original ones - when searching on a variable to
1708     find its type, there is less clutter to "visually"
1709     eliminate</para>
1710
1711     <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1712     variables or other trivial variables; feel free to declare them
1713     on one line. You should, although, provide a good comment on
1714     their functions.</para>
1715
1716     <para><emphasis>Status:</emphasis> developer-discretion.</para>
1717
1718     
1719   </sect3>
1720     
1721
1722     <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1723
1724     <para><emphasis>Explanation:</emphasis></para>
1725
1726     <para>Create a local struct (on the stack) if the variable will
1727     live and die within the context of one function call.</para>
1728
1729     <para>Only "malloc" a struct (on the heap) if the variable's life
1730     will extend beyond the context of one function call.</para>
1731
1732     <para><emphasis>Example:</emphasis></para>
1733 <programlisting>
1734 If a function creates a struct and stores a pointer to it in a
1735 list, then it should definitely be allocated via `malloc'.
1736 </programlisting>
1737   </sect3>
1738     
1739
1740     <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1741     Responsible for Ensuring 'free'</title>
1742
1743     <para><emphasis>Explanation:</emphasis></para>
1744
1745     <para>If you have to "malloc" an instance, you are responsible for
1746     insuring that the instance is `free'd, even if the deallocation
1747     event falls within some other programmer's code. You are also
1748     responsible for ensuring that deletion is timely (i.e. not too
1749     soon, not too late). This is known as "low-coupling" and is a
1750     "good thing (tm)". You may need to offer a
1751     free/unload/destructor type function to accommodate this.</para>
1752
1753     <para><emphasis>Example:</emphasis></para>
1754 <programlisting>
1755 int load_re_filterfile( struct client_state *csp ) { ... }
1756 static void unload_re_filterfile( void *f ) { ... }</programlisting>
1757
1758     <para><emphasis>Exceptions:</emphasis></para>
1759
1760     <para>The developer cannot be expected to provide `free'ing
1761     functions for C run-time library functions ... such as
1762     `strdup'.</para>
1763
1764     <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1765     standard is for allocating and freeing data structures (complex
1766     or nested).</para>
1767
1768     
1769   </sect3>
1770     
1771
1772     <sect3 id="s44"><title>Add loaders to the `file_list' structure
1773     and in order</title>
1774
1775     <para><emphasis>Explanation:</emphasis></para>
1776
1777     <para>I have ordered all of the "blocker" file code to be in alpha
1778     order. It is easier to add/read new blockers when you expect a
1779     certain order.</para>
1780
1781     <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1782     places by POPUP tests coming before PCRS tests. But since
1783     POPUPs can also be referred to as KILLPOPUPs, it is clear that
1784     it should come first.</para>
1785
1786     
1787   </sect3>
1788     
1789
1790     <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1791     existing code, use FIXME or XXX</title>
1792
1793     <para><emphasis>Explanation:</emphasis></para>
1794
1795     <para>If you have enough confidence in new code or confidence in
1796     your changes, but are not *quite* sure of the repercussions,
1797     add this:</para>
1798
1799     <para>/* FIXME: this code has a logic error on platform XYZ, *
1800     attempting to fix */ #ifdef PLATFORM ...changed code here...
1801     #endif</para>
1802
1803     <para>or:</para>
1804
1805     <para>/* FIXME: I think the original author really meant this...
1806     */ ...changed code here...</para>
1807
1808     <para>or:</para>
1809
1810     <para>/* FIXME: new code that *may* break something else... */
1811     ...new code here...</para>
1812
1813     <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1814     be a "good thing (tm)", it will be easier to identify and
1815     include in the project (or conversely exclude from the
1816     project).</para>
1817
1818     
1819   </sect3>
1820
1821   </sect2>
1822
1823     <sect2 id="s46"><title>Addendum: Template for files and function
1824     comment blocks:</title>
1825
1826     <para><emphasis>Example for file comments:</emphasis></para>
1827 <programlisting>
1828 const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
1829 /*********************************************************************
1830  *
1831  * File        :  $S<!-- Break CVS Substitution -->ource$
1832  *
1833  * Purpose     :  (Fill me in with a good description!)
1834  *
1835  * Copyright   :  Written by and Copyright (C) 2001-2009
1836  *                the Privoxy team. http://www.privoxy.org/
1837  *
1838  *                This program is free software; you can redistribute it
1839  *                and/or modify it under the terms of the GNU General
1840  *                Public License as published by the Free Software
1841  *                Foundation; either version 2 of the License, or (at
1842  *                your option) any later version.
1843  *
1844  *                This program is distributed in the hope that it will
1845  *                be useful, but WITHOUT ANY WARRANTY; without even the
1846  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
1847  *                PARTICULAR PURPOSE.  See the GNU General Public
1848  *                License for more details.
1849  *
1850  *                The GNU General Public License should be included with
1851  *                this file.  If not, you can view it at
1852  *                http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1853  *                or write to the Free Software Foundation, Inc., 
1854  *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1855  *                USA
1856  *
1857  *********************************************************************/
1858
1859
1860 #include "config.h"
1861
1862    ...necessary include files for us to do our work...
1863
1864 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1865 </programlisting>
1866
1867     <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1868     added to the "show-proxy-args" page. If this is a brand new
1869     creation by you, you are free to change the "Copyright" section
1870     to represent the rights you wish to maintain.</para>
1871
1872     <para><emphasis>Note:</emphasis> The formfeed character that is present right
1873     after the comment flower box is handy for (X|GNU)Emacs users to
1874     skip the verbiage and get to the heart of the code (via
1875     `forward-page' and `backward-page'). Please include it if you
1876     can.</para>
1877
1878     <para><emphasis>Example for file header comments:</emphasis></para>
1879 <programlisting>
1880 #ifndef _FILENAME_H
1881 #define _FILENAME_H
1882 #define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
1883 /*********************************************************************
1884  *
1885  * File        :  $S<!-- Break CVS Substitution -->ource$
1886  *
1887  * Purpose     :  (Fill me in with a good description!)
1888  *
1889  * Copyright   :  Written by and Copyright (C) 2001-2009
1890  *                the Privoxy team. http://www.privoxy.org/
1891  *
1892  *                This program is free software; you can redistribute it
1893  *                and/or modify it under the terms of the GNU General
1894  *                Public License as published by the Free Software
1895  *                Foundation; either version 2 of the License, or (at
1896  *                your option) any later version.
1897  *
1898  *                This program is distributed in the hope that it will
1899  *                be useful, but WITHOUT ANY WARRANTY; without even the
1900  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
1901  *                PARTICULAR PURPOSE.  See the GNU General Public
1902  *                License for more details.
1903  *
1904  *                The GNU General Public License should be included with
1905  *                this file.  If not, you can view it at
1906  *                http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1907  *                or write to the Free Software Foundation, Inc., 
1908  *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1909  *                USA
1910  *
1911  *********************************************************************/
1912
1913
1914 #include "project.h"
1915
1916 #ifdef __cplusplus
1917 extern "C" {
1918 #endif
1919
1920    ... function headers here ...
1921
1922
1923 /* Revision control strings from this header and associated .c file */
1924 extern const char FILENAME_rcs[];
1925 extern const char FILENAME_h_rcs[];
1926
1927
1928 #ifdef __cplusplus
1929 } /* extern "C" */
1930 #endif
1931
1932 #endif /* ndef _FILENAME_H */
1933
1934 /*
1935   Local Variables:
1936   tab-width: 3
1937   end:
1938 */
1939 </programlisting>
1940
1941     <para><emphasis>Example for function comments:</emphasis></para>
1942 <programlisting>
1943 /*********************************************************************
1944  *
1945  * Function    :  FUNCTION_NAME
1946  *
1947  * Description :  (Fill me in with a good description!)
1948  *
1949  * parameters  :
1950  *          1  :  param1 = pointer to an important thing
1951  *          2  :  x      = pointer to something else
1952  *
1953  * Returns     :  0 => Ok, everything else is an error.
1954  *
1955  *********************************************************************/
1956 int FUNCTION_NAME( void *param1, const char *x )
1957 {
1958    ...
1959    return( 0 );
1960
1961 }
1962 </programlisting>
1963
1964     <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1965     able to parse our code to create a "self-documenting" web
1966     page.</para>
1967
1968   </sect2>
1969
1970   </sect1>
1971
1972   <!--   ~~~~~       New section      ~~~~~     -->
1973   <sect1 id="testing"><title>Testing Guidelines</title>
1974     <para>To be filled.
1975 </para>
1976
1977     <!--   ~~~~~       New section      ~~~~~     -->
1978     <sect2 id="testing-plan"><title>Testplan for releases</title>
1979       <para>
1980        Explain release numbers. major, minor. developer releases. etc.
1981
1982 <orderedlist numeration="arabic">
1983           <listitem><para>
1984 Remove any existing rpm with rpm -e
1985 </para></listitem>
1986           <listitem><para>
1987 Remove any file that was left over. This includes (but is not limited to)
1988       <itemizedlist>
1989                 <listitem><para>/var/log/privoxy</para></listitem>
1990                 <listitem><para>/etc/privoxy</para></listitem>
1991                 <listitem><para>/usr/sbin/privoxy</para></listitem>
1992                 <listitem><para>/etc/init.d/privoxy</para></listitem>
1993                 <listitem><para>/usr/doc/privoxy*</para></listitem>
1994               </itemizedlist>
1995 </para></listitem>
1996           <listitem><para>
1997 Install the rpm. Any error messages?
1998 </para></listitem>
1999           <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
2000       (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
2001       autostart work?</para></listitem>
2002           <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
2003           <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
2004         </orderedlist>
2005 </para>
2006     </sect2>
2007
2008     <!--   ~~~~~       New section      ~~~~~     -->
2009     <sect2 id="testing-report"><title>Test reports</title>
2010       <para>
2011 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>
2012 at sourceforge. Three simple steps:
2013         <itemizedlist>
2014           
2015           <listitem><para>Select category: the distribution you test on.</para></listitem>
2016           <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
2017           <listitem><para>Fill the Summary and Detailed Description with something
2018               intelligent (keep it short and precise).</para>
2019           </listitem>
2020         </itemizedlist>
2021         Do not mail to the mailing list (we cannot keep track on issues there).
2022       </para>
2023     </sect2>
2024     
2025   </sect1>
2026
2027   <!--   ~~~~~       New section      ~~~~~     -->
2028   <sect1 id="newrelease"><title>Releasing a New Version</title>
2029     <para>
2030         When we release versions of <application>Privoxy</application>,
2031         our work leaves our cozy secret lab and has to work in the cold
2032         RealWorld[tm]. Once it is released, there is no way to call it
2033         back, so it is very important that great care is taken to ensure
2034         that everything runs fine, and not to introduce problems in the
2035         very last minute.
2036     </para>
2037     <para>
2038         So when releasing a new version, please adhere exactly to the
2039         procedure outlined in this chapter.
2040     </para>
2041
2042     <para>
2043         The following programs are required to follow this process:
2044         <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
2045         <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
2046     </para>
2047
2048     <sect2 id="versionnumbers">
2049     <title>Version numbers</title>
2050
2051     <para>
2052       First you need to determine which version number the release will have. 
2053       <application>Privoxy</application> version numbers consist of three numbers,
2054       separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
2055         <itemizedlist>
2056           <listitem>
2057             <para>
2058               X, the version major, is rarely ever changed. It is increased by one if
2059               turning a development branch into stable substantially changes the functionality,
2060               user interface or configuration syntax. Majors 1 and 2 were 
2061               <application>Junkbuster</application>, and 3 will be the first stable
2062               <application>Privoxy</application> release.
2063             </para>
2064           </listitem>
2065           <listitem>
2066             <para>
2067               Y, the version minor, represents the branch within the major version.
2068               At any point in time, there are two branches being maintained:
2069               The stable branch, with an even minor, say, 2N, in which no functionality is
2070               being added and only bug-fixes are made, and 2N+1, the development branch, in
2071               which the further development of <application>Privoxy</application> takes
2072               place.
2073               This enables us to turn the code upside down and inside out, while at the same time
2074               providing and maintaining a stable version.
2075               The minor is reset to zero (and one) when the major is incremented. When a development
2076               branch has matured to the point where it can be turned into stable, the old stable branch
2077               2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2078               new stable branch 2N+2, and a new development branch 2N+3 is opened.
2079             </para>
2080           </listitem>
2081           <listitem>
2082             <para>
2083               Z, the point or sub version, represents a release of the software within a branch.
2084               It is therefore incremented immediately before each code freeze. 
2085               In development branches, only the even point versions correspond to actual releases,
2086               while the odd ones denote the evolving state of the sources on CVS in between.
2087               It follows that Z is odd on CVS in development branches most of the time. There, it gets
2088               increased to an even number immediately before a code freeze, and is increased to an odd
2089               number again immediately thereafter.
2090               This ensures that builds from CVS snapshots are easily distinguished from released versions.
2091               The point version is reset to zero when the minor changes.
2092             </para>
2093             <para>
2094               Stable branches work a little differently, since there should be
2095               little to no development happening in such branches. Remember,
2096               only bugfixes, which presumably should have had some testing
2097               before being committed. Stable branches will then have their 
2098               version reported as <literal>0.0.0</literal>, during that period 
2099               between releases when changes are being added. This is to denote 
2100               that this code is <emphasis>not for release</emphasis>. Then 
2101               as the release nears, the version is bumped according: e.g. 
2102               <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
2103             </para>
2104           </listitem>
2105         </itemizedlist>
2106     </para>
2107     <para>
2108      In summary, the main CVS trunk is the development branch where new
2109      features are being worked on for the next stable series. This should
2110      almost always be where the most activity takes place. There is always at
2111      least one stable branch from the trunk, e.g now it is
2112      <literal>3.0</literal>, which is only used to release stable versions.
2113      Once the initial *.0 release of the stable branch has been done, then as a
2114      rule, only bugfixes that have had prior testing should be committed to
2115      the stable branch. Once there are enough bugfixes to justify a new
2116      release, the version of this branch is again incremented Example: 3.0.0
2117      -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
2118      branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
2119      taking place. If any questions, please post to the devel list
2120      <emphasis>before</emphasis> committing to a stable branch!
2121     </para>
2122     <para>
2123      Developers should remember too that if they commit a bugfix to the stable 
2124      branch, this will more than likely require a separate submission to the 
2125      main trunk, since these are separate development trees within CVS. If you 
2126      are working on both, then this would require at least two separate check
2127      outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
2128      which is <literal>v_3_0_branch</literal> at the moment).
2129     </para>
2130
2131     </sect2>
2132      
2133     <sect2 id="beforerelease">
2134     <title>Before the Release: Freeze</title>
2135      <para>
2136        The following <emphasis>must be done by one of the
2137        developers</emphasis> prior to each new release.
2138      </para>
2139      <para>
2140       <itemizedlist>
2141        <listitem>
2142         <para>
2143          Make sure that everybody who has worked on the code in the last
2144          couple of days has had a chance to yell <quote>no!</quote> in case
2145          they have pending changes/fixes in their pipelines. Announce the
2146          freeze so that nobody will interfere with last minute changes.
2147         </para>
2148       </listitem> 
2149       <listitem>
2150        <para>
2151          Increment the version number (point from odd to even in development
2152          branches!) in <filename>configure.in</filename>. (RPM spec files 
2153          will need to be incremented as well.)
2154        </para>
2155       </listitem> 
2156       <listitem>
2157        <para>
2158         If <filename>default.action</filename> has changed since last
2159         release (i.e. software release or standalone actions file release),
2160         bump up its version info to A.B in this line:
2161        </para>
2162        <para> 
2163         <programlisting>
2164   {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
2165 </programlisting>
2166        </para>
2167        <para> 
2168         Then change the version info in doc/webserver/actions/index.php,
2169         line: '$required_actions_file_version = "A.B";'
2170        </para>
2171       </listitem>
2172       <listitem>
2173        <para>
2174         All documentation should be rebuild after the version bump.
2175         Finished docs should be then be committed to CVS (for those 
2176         without the ability to build these). Some docs may require 
2177         rather obscure processing tools. <filename>config</filename>,
2178         the man page (and the html version of the man page), and the PDF docs
2179         fall in this category. REAMDE, the man page, AUTHORS, and config
2180         should all also be committed to CVS for other packagers. The 
2181         formal docs should be uploaded to the webserver. See the
2182         Section "Updating the webserver" in this manual for details.
2183        </para>
2184       </listitem> 
2185       <listitem>
2186        <para>
2187          The <citetitle>User Manual</citetitle> is also used for context 
2188          sensitive help for the CGI editor. This is version sensitive, so that
2189          the user will get appropriate help for his/her release. So with 
2190          each release a fresh version should be uploaded to the webserver
2191          (this is in addition to the main <citetitle>User Manual</citetitle>
2192          link from the main page since we need to keep manuals for various 
2193          versions available). The CGI pages will link to something like 
2194          <literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. This
2195          will need to be updated for each new release. There is no Makefile
2196          target for this at this time!!! It needs to be done manually.
2197        </para>
2198       </listitem> 
2199       <listitem>
2200        <para>
2201         All developers should look at the <filename>ChangeLog</filename> and
2202         make sure noteworthy changes are referenced.
2203        </para>
2204      </listitem> 
2205       <listitem>
2206        <para>
2207         <emphasis>Commit all files that were changed in the above steps!</emphasis>
2208        </para>
2209       </listitem>
2210       <listitem>
2211        <para>
2212         Tag all files in CVS with the version number with
2213         <quote><command>cvs tag v_X_Y_Z</command></quote>.
2214         Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2215        </para>
2216       </listitem> 
2217      <listitem>
2218        <para>
2219         If the release was in a development branch, increase the point version
2220         from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
2221         commit your change.
2222        </para>
2223       </listitem> 
2224      <listitem>
2225        <para>
2226         On the webserver, copy the user manual to a new top-level directory
2227         called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2228         pages, which have the version as a prefix, will go into the right version of the manual.
2229         If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2230         to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2231         <filename>.</filename> (i.e. dot). 
2232        </para>
2233       </listitem> 
2234       </itemizedlist>
2235      </para> 
2236     </sect2>
2237     
2238     <sect2 id="therelease">
2239     <title>Building and Releasing the Packages</title>
2240      <para>
2241       Now the individual packages can be built and released. Note that for
2242       GPL reasons the first package to be released is always the source tarball.
2243      </para>
2244  
2245      <para>
2246       For <emphasis>all</emphasis> types of packages, including the source tarball,
2247       <emphasis>you must make sure that you build from clean sources by exporting
2248       the right version from CVS into an empty directory</emphasis> (just press return when
2249       asked for a password):
2250      </para>
2251       
2252      <para>
2253       <programlisting>
2254   mkdir dist # delete or choose different name if it already exists
2255   cd dist
2256   cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
2257   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2258 </programlisting>
2259     </para>
2260   
2261     <para>
2262      <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2263      version information after export from CVS. This is to make sure that
2264      all release packages, and with them, all future bug reports, are based
2265      on exactly the same code.
2266     </para>
2267   
2268     <warning>
2269      <para>
2270       Every significant release of Privoxy has included at least one 
2271       package that either had incorrect versions of files, missing files, 
2272       or incidental leftovers from a previous build process that gave 
2273       unknown numbers of users headaches to try to figure out what was 
2274       wrong. PLEASE, make sure you are using pristene sources, and are
2275       following the prescribed process!
2276      </para>
2277     </warning>
2278
2279     <para>
2280      Please find additional instructions for the source tarball and the
2281      individual platform dependent binary packages below. And details 
2282      on the Sourceforge release process below that.
2283     </para>
2284
2285     <sect3 id="pack-guidelines">
2286     <title>Note on Privoxy Packaging</title>
2287      <para>
2288       Please keep these general guidelines in mind when putting together 
2289       your package. These apply to <emphasis>all</emphasis> platforms!
2290      </para>
2291      <para>
2292       <itemizedlist>
2293        <listitem>
2294         <para>
2295           <application>Privoxy</application> <emphasis>requires</emphasis>
2296           write access to: all <filename>*.action</filename> files, all 
2297           logfiles, and the <filename>trust</filename> file. You will 
2298           need to determine the best way to do this for your platform.
2299         </para>
2300        </listitem> 
2301        <listitem>
2302         <para>
2303           Please include up to date documentation. At a bare minimum:
2304         </para>
2305         <simplelist>
2306          <member>
2307           <filename>LICENSE</filename> (top-level directory)
2308          </member>
2309         </simplelist>
2310         <simplelist>
2311          <member>
2312           <filename>README</filename> (top-level directory)
2313          </member>
2314         </simplelist>
2315         <simplelist>
2316          <member>
2317           <filename>AUTHORS</filename> (top-level directory)
2318          </member>
2319         </simplelist>
2320         <simplelist>
2321          <member>
2322           <filename>man page</filename> (top-level directory, Unix-like
2323           platforms only)
2324          </member>
2325         </simplelist>
2326         <simplelist>
2327          <member>
2328           <filename>The User Manual</filename> (doc/webserver/user-manual/)
2329          </member>
2330         </simplelist>
2331         <simplelist>
2332          <member>
2333           <filename>FAQ</filename> (doc/webserver/faq/)
2334          </member>
2335         </simplelist>
2336         <para>
2337           Also suggested: <filename>Developer Manual</filename>
2338           (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2339           (top-level directory). <filename>FAQ</filename> and the manuals are
2340           HTML docs. There are also text versions in
2341           <filename>doc/text/</filename> which could conceivably also be
2342           included.
2343         </para>
2344         <para>
2345          The documentation has been designed such that the manuals are linked
2346          to each other from parallel directories, and should be packaged 
2347          that way. <filename>privoxy-index.html</filename> can also be
2348          included and can serve as a focal point for docs and other links of
2349          interest (and possibly renamed to <filename>index.html</filename>).
2350          This should be one level up from the manuals. There is a link also 
2351          on this page to an HTMLized version of the man page. To avoid 404 for
2352          this, it is in CVS as
2353          <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2354          and should be included along with the manuals. There is also a
2355          css stylesheets that can be included for better presentation:
2356          <filename>p_doc.css</filename>. This should be in the same directory
2357          with <filename>privoxy-index.html</filename>, (i.e. one level up from
2358          the manual directories).
2359         </para>
2360       </listitem> 
2361       <listitem>
2362        <para>
2363         <filename>user.action</filename> and <filename>user.filter</filename>
2364         are designed for local preferences. Make sure these do not get overwritten!
2365         <filename>config</filename> should not be overwritten either. This 
2366         has especially important configuration data in it.
2367         <filename>trust</filename> should be left in tact as well.
2368        </para>
2369       </listitem> 
2370       <listitem>
2371        <para>
2372         Other configuration files (<filename>default.action</filename> and
2373         <filename>default.filter</filename>) should be installed as the new
2374         defaults, but all previously installed configuration files should be
2375         preserved as backups. This is just good manners :-) These files are
2376         likely to change between releases and contain important new features
2377         and bug fixes.
2378        </para>
2379      </listitem> 
2380      <listitem>
2381       <para>
2382        Please check platform specific notes in this doc, if you haven't 
2383        done <quote>Privoxy</quote> packaging before for other platform 
2384        specific issues. Conversely, please add any notes that you know 
2385        are important for your platform (or contact one of the doc 
2386        maintainers to do this if you can't).
2387       </para>
2388     </listitem> 
2389     <listitem>
2390      <para>
2391        Packagers should do a <quote>clean</quote> install of their 
2392        package after building it. So any previous installs should be 
2393        removed first to ensure the integrity of the newly built package. 
2394        Then run the package for a while to make sure there are no 
2395        obvious problems, before uploading.
2396      </para>
2397     </listitem> 
2398
2399       </itemizedlist>
2400      </para> 
2401     
2402     </sect3>
2403
2404     <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2405         <para>
2406         First, <emphasis>make sure that you have freshly exported the right
2407         version into an empty directory</emphasis>. (See "Building and releasing
2408         packages" above). Then run:
2409         </para>
2410         <para>
2411         <programlisting>
2412   cd current
2413   autoheader && autoconf && ./configure
2414 </programlisting>
2415         </para>
2416         <para>
2417         Then do:
2418         </para>
2419         <para>
2420         <programlisting>
2421   make tarball-dist
2422 </programlisting>
2423         </para>
2424         <para>
2425         To upload the package to Sourceforge, simply issue
2426         </para>
2427         <para>
2428         <programlisting>
2429   make tarball-upload
2430 </programlisting>
2431         </para>
2432         <para>
2433         Go to the displayed URL and release the file publicly on Sourceforge.
2434         For the change log field, use the relevant section of the
2435         <filename>ChangeLog</filename> file.
2436       </para>
2437     </sect3>
2438
2439     <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2440         <para>
2441         In following text, replace <replaceable class="parameter">dist</replaceable>
2442         with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2443         </para>
2444         <para>
2445         First, <emphasis>make sure that you have freshly exported the right
2446         version into an empty directory</emphasis>. (See "Building and releasing
2447         packages" above). 
2448         </para>
2449         <para>
2450         As the only exception to not changing anything after export from CVS,
2451         now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2452         and make sure that the version information and the RPM release number are
2453         correct. The RPM release numbers for each version start at one. Hence it must
2454         be reset to one if this is the first RPM for
2455         <replaceable class="parameter">dist</replaceable> which is built from version
2456         X.Y.Z. Check the
2457         <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">file
2458         list</ulink> if unsure. Else, it must be set to the highest already available RPM
2459         release number for that version plus one.
2460         </para>
2461         <para>
2462         Then run:
2463         </para>
2464         <para>
2465         <programlisting>
2466   cd current
2467   autoheader && autoconf && ./configure
2468 </programlisting>
2469         </para>
2470         <para>
2471         Then do
2472         </para>
2473         <para>
2474         <programlisting>
2475   make <replaceable class="parameter">dist</replaceable>-dist
2476 </programlisting>
2477         </para>
2478         <para>
2479         To upload the package to Sourceforge, simply issue
2480         </para>
2481         <para>
2482         <programlisting>
2483   make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2484 </programlisting>
2485         </para>
2486         <para>
2487         where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2488         RPM release number as determined above.
2489         Go to the displayed URL and release the file publicly on Sourceforge.
2490         Use the release notes and change log from the source tarball package.
2491       </para>
2492     </sect3>
2493
2494     <sect3 id="newrelease-os2"><title>OS/2</title>
2495       <para>
2496         First, <emphasis>make sure that you have freshly exported the right
2497         version into an empty directory</emphasis>. (See "Building and releasing
2498         packages" above). Then get the OS/2 Setup module:
2499         </para>
2500         <para>
2501         <programlisting>
2502   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
2503 </programlisting>
2504         </para>
2505         <para>
2506         You will need a mix of development tools.
2507         The main compilation takes place with IBM Visual Age C++.
2508         Some ancillary work takes place with GNU tools, available from
2509         various sources like hobbes.nmsu.edu.
2510         Specificially, you will need <filename>autoheader</filename>,
2511         <filename>autoconf</filename> and <filename>sh</filename> tools.
2512         The packaging takes place with WarpIN, available from various sources, including
2513         its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2514         </para>
2515         <para>
2516         Change directory to the <filename>os2setup</filename> directory.
2517         Edit the os2build.cmd file to set the final executable filename.
2518         For example, 
2519         </para>
2520         <para>
2521         <programlisting>
2522   installExeName='privoxyos2_setup_X.Y.Z.exe'
2523 </programlisting>
2524         </para>
2525         <para>
2526         Next, edit the <filename>IJB.wis</filename> file so the release number matches
2527         in the <filename>PACKAGEID</filename> section:
2528         </para>
2529         <para>
2530         <programlisting>
2531   PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2532 </programlisting>
2533         </para>
2534         <para>
2535         You're now ready to build.  Run:
2536         </para>
2537         <para>
2538         <programlisting>
2539   os2build
2540 </programlisting>
2541         </para>
2542         <para>
2543          You will find the  WarpIN-installable executable in the
2544         <filename>./files</filename> directory. Upload this anonymously to
2545          <filename>uploads.sourceforge.net/incoming</filename>, create a release
2546          for it, and you're done. Use the release notes and Change Log from the
2547          source tarball package.
2548         </para>
2549     </sect3>
2550
2551     <sect3 id="newrelease-solaris"><title>Solaris</title>
2552       <para>
2553         Login to Sourceforge's compilefarm via ssh:
2554         </para>
2555         <para>
2556         <programlisting>
2557   ssh cf.sourceforge.net
2558 </programlisting>
2559         </para>
2560         <para>
2561         Choose the right operating system (not the Debian one).
2562         When logged in, <emphasis>make sure that you have freshly exported the right
2563         version into an empty directory</emphasis>. (See "Building and releasing
2564         packages" above). Then run:
2565         </para>
2566         <para>
2567         <programlisting>
2568   cd current
2569   autoheader && autoconf && ./configure
2570 </programlisting>
2571         </para>
2572         <para>
2573         Then run
2574         </para>
2575         <para>
2576         <programlisting>
2577   gmake solaris-dist
2578 </programlisting>
2579         </para>
2580         <para>
2581         which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2582         solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2583         to manually upload the archive to Sourceforge's ftp server and release
2584         the file publicly. Use the release notes and Change Log from the
2585         source tarball package.
2586         </para>
2587     </sect3>
2588
2589     <sect3 id="newrelease-windows"><title>Windows</title>
2590       <para>
2591         You should ensure you have the latest version of Cygwin (from
2592         <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>).
2593         Run the following commands from within a Cygwin bash shell.
2594       </para>
2595       <para>
2596         First, <emphasis>make sure that you have freshly exported the right
2597         version into an empty directory</emphasis>. (See "Building and releasing
2598         packages" above). Then get the Windows setup module:
2599       </para>
2600       <para>
2601       <programlisting>
2602   cvs -z3  -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
2603 </programlisting>
2604       </para>
2605       <para>
2606         Then you can build the package.  This is fully automated, and is
2607         controlled by <filename>winsetup/GNUmakefile</filename>.
2608         All you need to do is:
2609       </para>
2610       <para>
2611       <programlisting>
2612   cd winsetup
2613   make
2614 </programlisting>
2615       </para>
2616       <para>
2617         Now you can manually rename <filename>privoxy_setup.exe</filename> to
2618         <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
2619         SourceForge. When releasing the package on SourceForge, use the release notes
2620         and Change Log from the source tarball package.
2621       </para>
2622     </sect3>
2623
2624     <sect3 id="newrelease-debian"><title>Debian</title>
2625       <para>
2626         First, <emphasis>make sure that you have freshly exported the
2627         right version into an empty directory</emphasis>. (See
2628         "Building and releasing packages" above).  Then add a log
2629         entry to <filename>debian/changelog</filename>, if it is not
2630         already there, for example by running:
2631       </para>
2632       <para>
2633         <programlisting>
2634   debchange -v &p-version;-&p-status;-1 "New upstream version"
2635 </programlisting>
2636       </para>
2637       <para>
2638         Then, run: 
2639       </para>
2640       <para>
2641         <programlisting>
2642   dpkg-buildpackage -rfakeroot -us -uc -b
2643 </programlisting>
2644       </para>
2645       <para>
2646         This will create
2647         <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2648         which can be uploaded.  To upload the package to Sourceforge, simply
2649         issue
2650       </para>
2651       <para>
2652         <programlisting>
2653   make debian-upload
2654 </programlisting>
2655       </para>
2656     </sect3>
2657
2658     <sect3 id="newrelease-macosx"><title>Mac OS X</title>
2659       <para>
2660         First, <emphasis>make sure that you have freshly exported the right
2661         version into an empty directory</emphasis>. (See "Building and releasing
2662         packages" above). Then get the Mac OS X setup module:
2663         </para>
2664         <para>
2665         <programlisting>
2666   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
2667 </programlisting>
2668         </para>
2669         <para>
2670         Then run:
2671         </para>
2672         <para>
2673         <programlisting>
2674   cd osxsetup
2675   build
2676 </programlisting>
2677         </para>
2678         <para>
2679         This will run <filename>autoheader</filename>, <filename>autoconf</filename> and
2680         <filename>configure</filename> as well as <filename>make</filename>.
2681         Finally, it will copy over the necessary files to the ./osxsetup/files directory
2682         for further processing by <filename>PackageMaker</filename>.
2683         </para>
2684         <para>
2685         Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
2686         name to match the release, and hit the "Create package" button.
2687         If you specify ./Privoxy.pkg as the output package name, you can then create
2688         the distributable zip file with the command:
2689         </para>
2690         <para>
2691         <programlisting>
2692   zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2693 </programlisting>
2694         </para>
2695         <para>
2696         You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to 
2697         <filename>uploads.sourceforge.net/incoming</filename>,
2698         create a release for it, and you're done. Use the release notes
2699         and Change Log from the source tarball package.
2700         </para>
2701     </sect3>
2702
2703     <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2704       <para>
2705         Login to Sourceforge's compile-farm via ssh:
2706         </para>
2707         <para>
2708         <programlisting>
2709   ssh cf.sourceforge.net
2710 </programlisting>
2711         </para>
2712         <para>
2713         Choose the right operating system.
2714         When logged in, <emphasis>make sure that you have freshly exported the right
2715         version into an empty directory</emphasis>. (See "Building and releasing
2716         packages" above). Then run:
2717         </para>
2718         <para>
2719         <programlisting>
2720   cd current
2721   autoheader && autoconf && ./configure
2722 </programlisting>
2723         </para>
2724         <para>
2725         Then run:
2726         </para>
2727         <para>
2728         <programlisting>
2729   gmake freebsd-dist
2730 </programlisting>
2731         </para>
2732         <para>
2733         which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2734         freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
2735         to manually upload the archive to Sourceforge's ftp server and release
2736         the file publicly. Use the release notes and Change Log from the
2737         source tarball package.
2738         </para>
2739     </sect3>
2740
2741     <sect3 id="newrelease-hpux"><title>HP-UX 11</title>
2742       <para>
2743         First, <emphasis>make sure that you have freshly exported the right
2744         version into an empty directory</emphasis>. (See "Building and releasing
2745         packages" above). Then run:
2746         </para>
2747         <para>
2748         <programlisting>
2749   cd current
2750   autoheader && autoconf && ./configure
2751 </programlisting>
2752         </para>
2753         <para>
2754         Then do FIXME.
2755         </para>
2756     </sect3>
2757
2758     <sect3 id="newrelease-amiga"><title>Amiga OS</title>
2759       <para>
2760         First, <emphasis>make sure that you have freshly exported the right
2761         version into an empty directory</emphasis>. (See "Building and releasing
2762         packages" above). Then run:
2763         </para>
2764         <para>
2765         <programlisting>
2766   cd current
2767   autoheader && autoconf && ./configure
2768 </programlisting>
2769         </para>
2770         <para>
2771         Then do FIXME.
2772         </para>
2773     </sect3>
2774
2775     <sect3 id="newrelease-aix"><title>AIX</title>
2776       <para>
2777         Login to Sourceforge's compilefarm via ssh:
2778         </para>
2779         <para>
2780         <programlisting>
2781   ssh cf.sourceforge.net
2782 </programlisting>
2783         </para>
2784         <para>
2785         Choose the right operating system.
2786         When logged in, <emphasis>make sure that you have freshly exported the right
2787         version into an empty directory</emphasis>. (See "Building and releasing
2788         packages" above). Then run:
2789         </para>
2790         <para>
2791         <programlisting>
2792   cd current
2793   autoheader && autoconf && ./configure
2794 </programlisting>
2795         </para>
2796         <para>
2797         Then run:
2798         </para>
2799         <para>
2800         <programlisting>
2801   make aix-dist
2802 </programlisting>
2803         </para>
2804         <para>
2805         which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2806         aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
2807         to manually upload the archive to Sourceforge's ftp server and release
2808         the file publicly. Use the release notes and Change Log from the
2809         source tarball package.
2810         </para>
2811     </sect3>
2812    </sect2>
2813
2814    <sect2 id="releasing">
2815    <title>Uploading and Releasing Your Package</title>
2816     <para>
2817       After the package is ready, it is time to upload it 
2818       to SourceForge, and go through the release steps. The upload
2819       is done via FTP:
2820     </para>
2821      <para>
2822       <itemizedlist>
2823        <listitem>
2824         <para>
2825           Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2826         </para>
2827       </listitem> 
2828       <listitem>
2829        <para>
2830          user: <literal>anonymous</literal>
2831        </para>
2832       </listitem> 
2833       <listitem>
2834        <para>
2835          password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2836        </para>
2837       </listitem> 
2838      </itemizedlist>
2839     </para> 
2840     <para>
2841      Or use the <command>make</command> targets as described above.
2842     </para>
2843     <para>
2844      Once this done go to <ulink
2845       url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
2846       >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>, 
2847      making sure you are logged in. Find your target platform in the 
2848      second column, and click <literal>Add Release</literal>. You will 
2849      then need to create a new release for your package, using the format 
2850      of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2851      (beta)</emphasis>.
2852     </para>
2853     <para>
2854      Now just follow the prompts. Be sure to add any appropriate Release
2855      notes. You should see your freshly uploaded packages in 
2856      <quote>Step 2. Add Files To This Release</quote>. Check the 
2857      appropriate box(es). Remember at each step to hit the 
2858      <quote>Refresh/Submit</quote> buttons! You should now see your 
2859      file(s) listed in Step 3. Fill out the forms with the appropriate 
2860      information for your platform, being sure to hit <quote>Update</quote>
2861      for each file. If anyone is monitoring your platform, check the 
2862      <quote>email</quote> box at the very bottom to notify them of 
2863      the new package. This should do it!
2864     </para>
2865     <para>
2866      If you have made errors, or need to make changes, you can go through 
2867      essentially the same steps, but select <literal>Edit Release</literal>, 
2868      instead of <literal>Add Release</literal>.
2869     </para>
2870    </sect2>
2871
2872     <sect2 id="afterrelease">
2873     <title>After the Release</title>
2874      <para>
2875       When all (or: most of the) packages have been uploaded and made available,
2876       send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
2877       mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2878       include the
2879       <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
2880       location</ulink>, the release notes and the Changelog. Also, post an
2881       updated News item on the project page Sourceforge, and update the Home 
2882       page and docs linked from the Home page (see below). Other news sites
2883       and release oriented sites, such as Freshmeat, should also be notified.
2884      </para>
2885    </sect2>
2886
2887   </sect1>
2888   
2889   <!--   ~~~~~       New section      ~~~~~     -->
2890   <sect1 id="webserver-update"><title>Update the Webserver</title>
2891    <para>
2892     The webserver should be updated at least with each stable release. When
2893     updating, please follow these steps to make sure that no broken links,
2894     inconsistent contents or permission problems will occur (as it has many 
2895     times in the past!):
2896    </para>
2897    <para>
2898     If you have changed anything in the stable-branch documentation source
2899     SGML files, do:
2900    </para>
2901    <para>
2902     <programlisting>
2903   make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
2904 </programlisting>
2905    </para>
2906    <para>
2907     That will generate <filename>doc/webserver/user-manual</filename>,
2908     <filename>doc/webserver/developer-manual</filename>,
2909     <filename>doc/webserver/faq</filename>, 
2910     <filename>doc/pdf/*.pdf</filename> and
2911     <filename>doc/webserver/index.html</filename> automatically.
2912    </para>
2913    <para>
2914     If you changed the manual page sources, generate
2915     <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2916     by running <quote><command>make man</command></quote>. (This is
2917     a separate target due to dependencies on some obscure perl scripts
2918     [now in CVS, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
2919    </para>
2920    <para>
2921     If you want to add new files to the webserver, create them locally in
2922     the <filename>doc/webserver/*</filename> directory (or
2923     create new directories under <filename>doc/webserver</filename>).
2924    </para>
2925    <para>
2926     Next, commit any changes from the above steps to CVS. All set? 
2927     If these are docs in the stable branch, then do:
2928    </para>
2929    <para>
2930     <programlisting>
2931   make webserver
2932 </programlisting>
2933    </para>
2934    <para>
2935     This will do the upload to <ulink url="http://www.privoxy.org/">the
2936     webserver</ulink> (www.privoxy.org) and ensure all files and directories
2937     there are group writable.
2938    </para>
2939    <para>
2940     Please do <emphasis>NOT</emphasis> use any other means of transferring
2941     files to the webserver to avoid permission problems. Also, please do not
2942     upload docs from development branches or versions. The publicly posted
2943     docs should be in sync with the last official release.
2944    </para>
2945   </sect1>
2946
2947   <!--   ~~~~~       New section      ~~~~~     -->
2948   <sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
2949 <!-- Include contacting.sgml  -->
2950  &contacting;
2951 <!-- end contacting -->
2952   </sect1>
2953   
2954
2955 <!--   ~~~~~~~~       New section Header    ~~~~~~~~~     -->
2956 <sect1 id="copyright"><title>Privoxy Copyright, License and History</title>
2957
2958 <!-- Include copyright.sgml -->
2959  &copyright;
2960 <!-- end -->
2961
2962 <!--   ~~~~~       New section      ~~~~~     -->
2963 <sect2><title>License</title>
2964 <!-- Include copyright.sgml: -->
2965  &license;
2966 <!-- end copyright -->
2967 </sect2>
2968 <!--  ~  End section  ~  -->
2969
2970 <!--   ~~~~~       New section      ~~~~~     -->
2971 <sect2><title>History</title>
2972 <!-- Include history.sgml -->
2973  &history;
2974 <!-- end -->
2975 </sect2>
2976
2977 </sect1>
2978   
2979   <!--   ~~~~~       New section      ~~~~~     -->
2980   <sect1 id="seealso"><title>See also</title>
2981 <!-- Include seealso.sgml -->
2982  &seealso;
2983 <!-- end  -->
2984
2985   </sect1>
2986
2987   <!--
2988
2989   This program is free software; you can redistribute it 
2990   and/or modify it under the terms of the GNU General
2991   Public License as published by the Free Software
2992   Foundation; either version 2 of the License, or (at
2993   your option) any later version.
2994
2995   This program is distributed in the hope that it will
2996   be useful, but WITHOUT ANY WARRANTY; without even the
2997   implied warranty of MERCHANTABILITY or FITNESS FOR A
2998   PARTICULAR PURPOSE.  See the GNU General Public
2999   License for more details.
3000
3001   The GNU General Public License should be included with
3002   this file.  If not, you can view it at
3003   http://www.gnu.org/copyleft/gpl.html
3004   or write to the Free Software Foundation, Inc., 59
3005   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
3006
3007   $Log: developer-manual.sgml,v $
3008   Revision 2.29  2009/06/12 14:30:58  fabiankeil
3009   Update entities for 3.0.13 beta.
3010
3011   Revision 2.28  2009/05/16 13:27:21  fabiankeil
3012   Remove CVS revision logs. TODO item #33.
3013
3014   Revision 2.27  2009/02/19 02:20:22  hal9
3015   Make some links in seealso conditional. Man page is now privoxy only links.
3016
3017   Revision 2.26  2009/02/12 16:08:26  fabiankeil
3018   Declare the code stable.
3019
3020   Revision 2.25  2009/02/12 15:37:05  fabiankeil
3021   Update templates.
3022
3023   Revision 2.24  2009/01/13 16:50:35  fabiankeil
3024   The standard.action file is gone.
3025
3026   Revision 2.23  2008/09/26 17:02:01  fabiankeil
3027   - Break some more CVS substitutions in examples.
3028   - Remove Junkbusters reference in example header
3029     for new files.
3030
3031   Revision 2.22  2008/08/30 15:37:35  fabiankeil
3032   Update entities.
3033
3034   Revision 2.21  2008/08/16 08:51:28  fabiankeil
3035   Update version-related entities.
3036
3037   Revision 2.20  2008/06/14 13:21:24  fabiankeil
3038   Prepare for the upcoming 3.0.9 beta release.
3039
3040   Revision 2.19  2008/05/12 11:13:33  fabiankeil
3041   Clarify that Privoxy is licensed under GPL version 2.
3042
3043   Revision 2.18  2008/02/04 12:14:06  fabiankeil
3044   Change "Edit Packages" URL to use https.
3045
3046   Revision 2.17  2008/02/03 21:37:41  hal9
3047   Apply patch from Mark: s/OSX/OS X/
3048
3049   Revision 2.16  2008/01/19 17:52:38  hal9
3050   Re-commit to fix various minor issues for new release.
3051
3052   Revision 2.15  2008/01/19 15:03:05  hal9
3053   Doc sources tagged for 3.0.8 release.
3054
3055   Revision 2.14  2008/01/17 01:49:51  hal9
3056   Change copyright notice for docs s/2007/2008/. All these will be rebuilt soon
3057   enough.
3058
3059   Revision 2.13  2007/10/30 17:59:31  fabiankeil
3060   - Bump p-version, p-status and copyright date.
3061   - Mention that the manual is out of date.
3062   - Don't use examples with HardToReadCamelCase after
3063     explaining that we actually don't like that.
3064   - Minor cosmetics.
3065
3066   Revision 2.12  2006/11/14 01:57:46  hal9
3067   Dump all docs prior to 3.0.6 release. Various minor changes to faq and user
3068   manual.
3069
3070   Revision 2.11  2006/09/26 02:36:29  hal9
3071   Fix broken link per bug tracker.
3072
3073   Revision 2.10  2006/09/22 01:27:55  hal9
3074   Final commit of probably various minor changes here and there. Unless
3075   something changes this should be ready for pending release.
3076
3077   Revision 2.9  2006/09/14 02:30:07  hal9
3078   Fix ijbswa cvs links. Update notes on release process, and which config files
3079   should be overwritten and which not.
3080
3081   Revision 2.8  2006/08/22 23:35:01  hal9
3082   Fix email address, cvs URI, address branching changes and various other
3083   small updates.
3084
3085   Revision 2.7  2006/07/18 14:48:50  david__schmidt
3086   Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
3087   with what was really the latest development (the v_3_0_branch branch)
3088
3089   Revision 1.46.2.11  2002/12/11 13:12:15  hal9
3090   Rewrite cvs write access give-away section.
3091
3092   Revision 1.46.2.10  2002/09/26 21:53:45  hal9
3093   Changes to reflect recent change in stable branch commit policy (hopefully
3094   clearer now).
3095
3096   Revision 1.46.2.9  2002/09/26 01:21:40  hal9
3097   Porting 3.1.1 changes: more on cvs and branches, more on versions and
3098   releases.
3099
3100   Revision 1.46.2.8  2002/08/17 00:16:10  hal9
3101   Add note on updating webserver for User-manual/CGI editor, which is version
3102   dependent (and different from main UM link).
3103
3104   Revision 1.46.2.7  2002/08/14 17:29:25  hal9
3105   Add small notes on post-release steps, and uploading docs to webserver.
3106
3107   Revision 1.46.2.6  2002/08/10 11:40:25  oes
3108   Added disclaimer about probably being out-of-date and two small hints
3109
3110   Revision 1.46.2.5  2002/08/09 01:15:12  hal9
3111   Added some notes on pre-release steps (test builds first, update ChangeLog).
3112
3113   Revision 1.46.2.4  2002/05/29 00:30:59  mal0rd
3114   Fixed a little formatting.  Clarified debian section.
3115
3116   Revision 1.46.2.3  2002/05/28 04:32:45  hal9
3117   Change hints on bundling index.html to privoxy-index.html
3118
3119   Revision 1.46.2.2  2002/05/26 17:04:24  hal9
3120   -Spellcheck, very minor edits, and sync across branches
3121
3122   Revision 1.48  2002/05/26 12:48:31  roro
3123   Add releasing information about Debian.
3124
3125   Revision 1.47  2002/05/26 04:55:11  mal0rd
3126   Added debian-dist and debian-upload targets.  Also documented usage.
3127
3128   Revision 1.46  2002/05/22 17:15:00  oes
3129   Updated intro
3130
3131   Revision 1.45  2002/05/19 23:01:54  hal9
3132   Add small section on general packaging guidelines (e.g. actions files must
3133   be writable).
3134
3135   Revision 1.44  2002/05/15 03:55:17  hal9
3136   Fix ulink -> link, and minor modification to release process section for
3137   clarification.
3138
3139   Revision 1.43  2002/05/10 01:48:19  hal9
3140   This is mostly proposed copyright/licensing additions and changes. Docs
3141   are still GPL, but licensing and copyright are more visible. Also, copyright
3142   changed in doc header comments (eliminate references to JB except FAQ).
3143
3144   Revision 1.42  2002/05/05 20:26:02  hal9
3145   Sorting out license vs copyright in these docs.
3146
3147   Revision 1.41  2002/05/04 08:44:44  swa
3148   bumped version
3149
3150   Revision 1.40  2002/05/04 00:43:43  hal9
3151   -Remove TOC/first page kludge with proper stylesheet fix.
3152   -Combined the two very brief sections: Intro and Quickstart.
3153
3154   Revision 1.39  2002/05/02 15:08:25  oes
3155   Added explanation about version numbers and RPM package revisions
3156
3157   Revision 1.38  2002/04/29 02:20:31  hal9
3158   Add info on steps for uploading and the release process on SF.
3159
3160   Revision 1.37  2002/04/26 17:23:29  swa
3161   bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
3162
3163   Revision 1.36  2002/04/26 05:25:23  hal9
3164   Mass commit to catch a few scattered fixes.
3165
3166   Revision 1.35  2002/04/17 15:16:15  oes
3167   Added link to docbook crash course
3168
3169   Revision 1.34  2002/04/15 23:39:32  oes
3170    - Extended & fixed the release section
3171    - Added CVS guideline sections
3172    - Separated webserver section from release section
3173    - Commented out boilerplate inclusion (If you don't know yet what it is,
3174      you shouldn't mess with its code ;-)
3175    - Nits & fixes
3176
3177   Revision 1.33  2002/04/12 03:49:53  hal9
3178   Spell checked. Clarification on where docs are kept.
3179
3180   Revision 1.32  2002/04/11 21:29:58  jongfoster
3181   Documenting Win32 release procedure
3182
3183   Revision 1.31  2002/04/11 09:32:52  oes
3184   more nits
3185
3186   Revision 1.30  2002/04/11 09:24:53  oes
3187   nits
3188
3189   Revision 1.29  2002/04/10 18:45:14  swa
3190   generated
3191
3192   Revision 1.28  2002/04/08 22:59:26  hal9
3193   Version update. Spell chkconfig correctly :)
3194
3195   Revision 1.27  2002/04/08 15:31:18  hal9
3196   Touch ups to documentation section.
3197
3198   Revision 1.26  2002/04/07 23:50:08  hal9
3199   Documentation changes to reflect HTML docs now in CVS, and new generated files
3200   list.
3201
3202   Revision 1.25  2002/04/06 05:07:28  hal9
3203   -Add privoxy-man-page.sgml, for man page.
3204   -Add authors.sgml for AUTHORS (and p-authors.sgml)
3205   -Reworked various aspects of various docs.
3206   -Added additional comments to sub-docs.
3207
3208   Revision 1.24  2002/04/04 21:33:37  hal9
3209   More on documenting the documents.
3210
3211   Revision 1.23  2002/04/04 18:46:47  swa
3212   consistent look. reuse of copyright, history et. al.
3213
3214   Revision 1.22  2002/04/04 17:27:56  swa
3215   more single file to be included at multiple points. make maintaining easier
3216
3217   Revision 1.21  2002/04/04 06:48:37  hal9
3218   Structural changes to allow for conditional inclusion/exclusion of content
3219   based on entity toggles, e.g. 'entity % p-not-stable  "INCLUDE"'. And
3220   definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
3221   eventually be set by Makefile.
3222   More boilerplate text for use across multiple docs.
3223
3224   Revision 1.20  2002/04/04 03:28:27  david__schmidt
3225   Add Mac OS X section
3226
3227   Revision 1.19  2002/04/03 15:09:42  david__schmidt
3228   Add OS/2 build section
3229
3230   Revision 1.18  2002/04/03 03:51:48  hal9
3231   Touch ups.
3232
3233   Revision 1.17  2002/04/03 01:21:17  hal9
3234   Implementing Andreas's suggestions for Release sections.
3235
3236   Revision 1.16  2002/03/31 23:04:40  hal9
3237   Fleshed out the doc section, and added something for an intro so it was not
3238   blank.
3239
3240   Revision 1.15  2002/03/30 22:29:47  swa
3241   wrong make flavour
3242
3243   Revision 1.14  2002/03/30 19:04:08  swa
3244   people release differently. no good.
3245   I want to make parts of the docs only.
3246
3247   Revision 1.13  2002/03/27 01:16:41  hal9
3248   ditto
3249
3250   Revision 1.12  2002/03/27 01:02:51  hal9
3251   Touch up on name change...
3252
3253   Revision 1.11  2002/03/26 22:29:55  swa
3254   we have a new homepage!
3255
3256   Revision 1.10  2002/03/24 12:33:01  swa
3257   more additions.
3258
3259   Revision 1.9  2002/03/24 11:01:05  swa
3260   name change
3261
3262   Revision 1.8  2002/03/23 15:13:11  swa
3263   renamed every reference to the old name with foobar.
3264   fixed "application foobar application" tag, fixed
3265   "the foobar" with "foobar". left junkbustser in cvs
3266   comments and remarks to history untouched.
3267
3268   Revision 1.7  2002/03/11 13:13:27  swa
3269   correct feedback channels
3270
3271   Revision 1.6  2002/02/24 14:25:06  jongfoster
3272   Formatting changes.  Now changing the doctype to DocBook XML 4.1
3273   will work - no other changes are needed.
3274
3275   Revision 1.5  2001/10/31 18:16:51  swa
3276   documentation added: howto generate docs in text and html
3277   format, howto move stuff to the webserver.
3278
3279   Revision 1.4  2001/09/23 10:13:48  swa
3280   upload process established. run make webserver and
3281   the documentation is moved to the webserver. documents
3282   are now linked correctly.
3283
3284   Revision 1.3  2001/09/13 15:27:40  swa
3285   cosmetics
3286
3287   Revision 1.2  2001/09/13 15:20:17  swa
3288   merged standards into developer manual
3289
3290   Revision 1.1  2001/09/12 15:36:41  swa
3291   source files for junkbuster documentation
3292
3293   Revision 1.3  2001/09/10 17:43:59  swa
3294   first proposal of a structure.
3295
3296   Revision 1.2  2001/06/13 14:28:31  swa
3297   docs should have an author.
3298
3299   Revision 1.1  2001/06/13 14:20:37  swa
3300   first import of project's documentation for the webserver.
3301
3302   -->
3303
3304 </article>