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