1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
2 <!entity % dummy "IGNORE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity history SYSTEM "history.sgml">
7 <!entity seealso SYSTEM "seealso.sgml">
8 <!entity contacting SYSTEM "contacting.sgml">
9 <!entity copyright SYSTEM "copyright.sgml">
10 <!entity license SYSTEM "license.sgml">
11 <!entity p-version "3.0.8">
12 <!entity p-status "stable">
13 <!entity % p-not-stable "IGNORE">
14 <!entity % p-stable "INCLUDE">
15 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
16 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
17 <!entity my-copy "©"> <!-- kludge for docbook2man -->
20 File : $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
22 Purpose : developer manual
23 This file belongs into
24 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
26 $Id: developer-manual.sgml,v 2.17 2008/02/03 21:37:41 hal9 Exp $
28 Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
31 ========================================================================
32 NOTE: Please read developer-manual/documentation.html before touching
33 anything in this, or other Privoxy documentation. You have been warned!
34 Failure to abide by this rule will result in the revocation of your license
35 to live a peaceful existence!
36 ========================================================================
42 <title>Privoxy Developer Manual</title>
45 <!-- Completely the wrong markup, but very little is allowed -->
46 <!-- in this part of an article. FIXME -->
47 <link linkend="copyright">Copyright</link> &my-copy; 2001-2008 by
48 <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
53 <pubdate>$Id: developer-manual.sgml,v 2.17 2008/02/03 21:37:41 hal9 Exp $</pubdate>
57 Note: this should generate a separate page, and a live link to it.
58 But it doesn't for some mysterious reason. Please leave commented
59 unless it can be fixed proper. For the time being, the copyright
60 statement will be in copyright.smgl.
64 <legalnotice id="legalnotice">
66 text goes here ........
77 This is here to keep vim syntax file from breaking :/
78 If I knew enough to fix it, I would.
79 PLEASE DO NOT REMOVE! HB: hal@foobox.net
84 The developer manual provides guidance on coding, testing, packaging, documentation
85 and other issues of importance to those involved with
86 <application>Privoxy</application> development. It is mandatory (and helpful!) reading
87 for anyone who wants to join the team. Note that it's currently out of date
88 and may not be entirely correct. As always, patches are welcome.
91 <!-- Include privoxy.sgml boilerplate text: -->
93 <!-- &p-intro; Someone interested enough in the project to contribute
94 will already know at this point what Privoxy is. -->
96 <!-- end boilerplate -->
99 Please note that this document is constantly evolving. This copy represents
100 the state at the release of version &p-version;.
101 You can find the latest version of the this manual at <ulink
102 url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
103 Please see <link linkend="contact">the Contact section</link>
104 on how to contact the developers.
107 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
114 <!-- ~~~~~ New section ~~~~~ -->
115 <sect1 id="introduction"><title>Introduction</title>
118 I don't like seeing blank space :) So added *something* here.
122 <application>Privoxy</application>, as an heir to
123 <application>Junkbuster</application>, is a Free Software project
124 and the code is licensed under the GPL. As such,
125 <application>Privoxy</application> development is potentially open
126 to anyone who has the time, knowledge, and desire to contribute
127 in any capacity. Our goals are simply to continue the mission,
128 to improve <application>Privoxy</application>, and
129 to make it available to as wide an audience as possible.
132 One does not have to be a programmer to contribute. Packaging, testing,
133 documenting and porting, are all important jobs as well.
136 <!-- ~~~~~ New section ~~~~~ -->
137 <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
140 You'll need an account on <ulink
141 url="http://sourceforge.net/">Sourceforge</ulink> to support our
142 development. Mail your ID to <ulink
143 url="mailto:developers@privoxy.org">the list</ulink> and wait until a
144 project manager has added you.
148 The first step is to join the <ulink
149 url="mailto:ijbswa-developers@lists.sourceforge.net">developer's mailing list</ulink>.
150 You can submit your ideas, or even better patches. Patches are best
151 submitted to the Sourceforge tracker set up for this purpose, but
152 can be sent to the list for review too.
155 You will also need to have a cvs package installed, which will
156 entail having ssh installed as well (which seems to be a requirement of
157 SourceForge), in order to access the cvs repository. Having the GNU build
158 tools is also going to be important (particularly, autoconf and gmake).
161 For the time being (read, this section is under construction), you can
162 also refer to the extensive comments in the source code. In fact,
163 reading the code is recommended in any case.
168 <!-- ~~~~~ New section ~~~~~ -->
169 <sect1 id="cvs"><title>The CVS Repository</title>
171 If you become part of the active development team, you will eventually
172 need write access to our holy grail, the CVS repository. One of the
173 team members will need to set this up for you. Please read
174 this chapter completely before accessing via CVS.
177 <sect2 id="cvsaccess"><title>Access to CVS</title>
179 The project's CVS repository is hosted on
180 <ulink url="http://sourceforge.net/">SourceForge.</ulink>
181 Please refer to the chapters 6 and 7 in
182 <ulink url="http://sourceforge.net/docman/?group_id=1">SF's site
183 documentation</ulink> for the technical access details for your
184 operating system. For historical reasons, the CVS server is
185 called <literal>ijbswa.cvs.sourceforge.net</literal>, the repository is
186 called <literal>ijbswa</literal>, and the source tree module is called
187 <literal>current</literal>.
191 <sect2 id="cvsbranches">
192 <title>Branches</title>
194 Within the CVS repository, there are modules and branches. As
195 mentioned, the sources are in the <literal>current</literal>
196 <quote>module</quote>. Other modules are present for platform specific
197 issues. There is a webview of the CVS hierarchy at <ulink
198 url="http://ijbswa.cvs.sourceforge.net/ijbswa/">http://ijbswa.cvs.sourceforge.net/ijbswa/</ulink>,
199 which might help with visualizing how these pieces fit together.
202 Branches are used to fork a sub-development path from the main trunk.
203 Within the <literal>current</literal> module where the sources are, there
204 is always at least one <quote>branch</quote> from the main trunk
205 devoted to a stable release series. The main trunk is where active
206 development takes place for the next stable series (e.g. 3.2.x).
207 So just prior to each stable series (e.g. 3.0.x), a branch is created
208 just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
209 Once the initial stable release of any stable branch has taken place,
210 this branch is <emphasis>only used for bugfixes</emphasis>, which have
211 had prior testing before being committed to CVS. (See <link
212 linkend="versionnumbers">Version Numbers</link> below for details on
216 At one time there were two distinct branches: stable and unstable. The
217 more drastic changes were to be in the unstable branch. These branches
218 have now been merged to minimize time and effort of maintaining two
223 This will result in at least two active branches, which means there may
224 be occasions that require the same (or similar) item to be
225 checked into to two different places (assuming its a bugfix and needs
226 fixing in both the stable and unstable trees). This also means that in
227 order to have access to both trees, both will have to be checked out
228 separately. Use the <literal>cvs -r</literal> flag to check out a
229 branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
234 <sect2 id="cvscommit"><title>CVS Commit Guidelines</title>
236 The source tree is the heart of every software project. Every effort must
237 be made to ensure that it is readable, compilable and consistent at all
238 times. There are differing guidelines for the stable branch and the
239 main development trunk, and we ask anyone with CVS access to strictly
240 adhere to the following guidelines:
244 Basic Guidelines, for all branches:
249 Please don't commit even
250 a small change without testing it thoroughly first. When we're
251 close to a public release, ask a fellow developer to review your
255 Your commit message should give a concise overview of <emphasis>what you
256 changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
257 Just check previous messages for good examples.
260 Don't use the same message on multiple files, unless it equally applies to
264 If your changes span multiple files, and the code won't recompile unless
265 all changes are committed (e.g. when changing the signature of a function),
266 then commit all files one after another, without long delays in between.
267 If necessary, prepare the commit messages in advance.
270 Before changing things on CVS, make sure that your changes are in line
271 with the team's general consensus on what should be done.
275 Note that near a major public release, we get more cautious.
276 There is always the possibility to submit a patch to the <ulink
277 url="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patch
278 tracker</ulink> instead.
286 Stable branches are handled with more care, especially after the
287 initial *.*.0 release, and we are just in bugfix mode. In addition to
288 the above, the below applies only to the stable branch (currently the
289 <literal>v_3_0_branch</literal> branch):
296 Do not commit <emphasis>anything</emphasis> unless your proposed
297 changes have been well tested first, preferably by other members of the
298 project, or have prior approval of the project leaders or consensus
304 Where possible, bugfixes and changes should be tested in the main
305 development trunk first. There may be occasions where this is not
311 Alternately, proposed changes can be submitted as patches to the patch tracker on
312 Sourceforge first: <ulink
313 url="http://sourceforge.net/tracker/?group_id=11118&atid=311118">http://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
314 Then ask for peer review.
319 Do not even think about anything except bugfixes. No new features!
330 <!-- ~~~~~ New section ~~~~~ -->
331 <sect1 id="documentation"><title>Documentation Guidelines</title>
333 All formal documents are maintained in Docbook SGML and located in the
334 <computeroutput>doc/source/*</computeroutput> directory. You will need
335 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
336 DTD's and the Docbook modular stylesheets (or comparable alternatives),
337 and either <application>jade</application> or
338 <application>openjade</application> (recommended) installed in order to
339 build docs from source. Currently there is <ulink
340 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
341 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
342 course this, the <citetitle>developer-manual</citetitle> in this format.
343 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
344 <citetitle>INSTALL</citetitle>,
345 <citetitle>privoxy.1</citetitle> (man page), and
346 <citetitle>config</citetitle> files are also now maintained as Docbook
347 SGML. These files, when built, in the top-level source directory are
348 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
349 variation on this file, <filename>privoxy-index.html</filename>,
350 meant for inclusion with doc packages), are maintained as SGML as well.
351 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
352 contact someone involved in the documentation.
355 <filename>config</filename> requires some special handling. The reason it
356 is maintained this way is so that the extensive comments in the file
357 mirror those in <citetitle>user-manual</citetitle>. But the conversion
358 process requires going from SGML to HTML to text to special formatting
359 required for the embedded comments. Some of this does not survive so
360 well. Especially some of the examples that are longer than 80 characters.
361 The build process for this file outputs to <filename>config.new</filename>,
362 which should be reviewed for errors and mis-formatting. Once satisfied
363 that it is correct, then it should be hand copied to
364 <filename>config</filename>.
367 Other, less formal documents (e.g. <filename>LICENSE</filename>) are
368 maintained as plain text files in the top-level source directory.
371 Packagers are encouraged to include this documentation. For those without
372 the ability to build the docs locally, text versions of each are kept in
373 CVS. HTML versions are also being kept in CVS under
374 <filename>doc/webserver/*</filename>. And PDF version are kept in
375 <filename>doc/pdf/*</filename>.
378 Formal documents are built with the Makefile targets of
379 <computeroutput>make dok</computeroutput>, or alternately
380 <computeroutput>make redhat-dok</computeroutput>. If you have problems,
381 try both. The build process uses the document SGML sources in
382 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
383 <computeroutput>doc/text/</computeroutput> and to update all HTML
384 documents in <computeroutput>doc/webserver/</computeroutput>.
387 Documentation writers should please make sure documents build
388 successfully before committing to CVS, if possible.
391 How do you update the webserver (i.e. the pages on privoxy.org)?
393 <orderedlist numeration="arabic">
395 First, build the docs by running <computeroutput>make
396 dok</computeroutput> (or alternately <computeroutput>make
397 redhat-dok</computeroutput>). For PDF docs, do <computeroutput>make
398 dok-pdf</computeroutput>.
401 Run <computeroutput>make webserver</computeroutput> which copies all
402 files from <computeroutput>doc/webserver</computeroutput> to the
403 sourceforge webserver via scp.
409 Finished docs should be occasionally submitted to CVS
410 (<filename>doc/webserver/*/*.html</filename>) so that those without
411 the ability to build them locally, have access to them if needed.
412 This is especially important just prior to a new release! Please
413 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
414 other release specific data in <filename>configure.in</filename> has been
415 updated (this is done just prior to a new release).
418 <!-- ~~~~~ New section ~~~~~ -->
420 <title>Quickstart to Docbook and SGML</title>
422 If you are not familiar with SGML, it is a markup language similar to HTML.
423 Actually, not a mark up language per se, but a language used to define
424 markup languages. In fact, HTML is an SGML application. Both will use
425 <quote>tags</quote> to format text and other content. SGML tags can be much
426 more varied, and flexible, but do much of the same kinds of things. The tags,
427 or <quote>elements</quote>, are definable in SGML. There is no set
428 <quote>standards</quote>. Since we are using
429 <application>Docbook</application>, our tags are those that are defined by
430 <application>Docbook</application>. Much of how the finish document is
431 rendered is determined by the <quote>stylesheets</quote>.
432 The stylesheets determine how each tag gets translated to HTML, or other
437 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
438 will likely generate errors. Example: <literal><title>My
439 Title</title></literal>. They are also case-insensitive, but we
440 strongly suggest using all lower case. This keeps compatibility with
441 [Docbook] <application>XML</application>.
445 Our documents use <quote>sections</quote> for the most part. Sections
446 will be processed into HTML headers (e.g. <literal>h1</literal> for
447 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
448 will use these to also generate the Table of Contents for each doc. Our
449 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
450 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
451 entries, but <literal>sect4</literal> will not. Each section requires
452 a <literal><title></literal> element, and at least one
453 <literal><para></literal>. There is a limit of five section
454 levels in Docbook, but generally three should be sufficient for our
459 Some common elements that you likely will use:
465 <emphasis><para></para></emphasis>, paragraph delimiter. Most
466 text needs to be within paragraph elements (there are some exceptions).
469 <emphasis><emphasis></emphasis></emphasis>, the stylesheets
473 <emphasis><filename></filename></emphasis>, files and directories.
476 <emphasis><command></command></emphasis>, command examples.
479 <emphasis><literallayout></literallayout></emphasis>, like
480 <literal><pre></literal>, more or less.
483 <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
486 <emphasis><listitem></listitem></emphasis>, member of the above.
489 <emphasis><screen></screen></emphasis>, screen output, implies
490 <literal><literallayout></literal>.
493 <emphasis><ulink url="example.com"></ulink></emphasis>, like
494 HTML <literal><a></literal> tag.
497 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
503 Look at any of the existing docs for examples of all these and more.
507 You might also find <quote><ulink
508 url="http://opensource.bureau-cornavin.com/crash-course/index.html">Writing Documentation
509 Using DocBook - A Crash Course</ulink></quote> useful.
513 <!-- ~~~~~ New section ~~~~~ -->
514 <sect2 id="docstyle">
515 <title><application>Privoxy</application> Documentation Style</title>
517 It will be easier if everyone follows a similar writing style. This
518 just makes it easier to read what someone else has written if it
519 is all done in a similar fashion.
528 All tags should be lower case.
533 Tags delimiting a <emphasis>block</emphasis> of text (even small
534 blocks) should be on their own line. Like:
540 Tags marking individual words, or few words, should be in-line:
542 Just to <emphasis>emphasize</emphasis>, some text goes here.
548 Tags should be nested and step indented for block text like: (except
555 Some text goes here in our list example.
558 </itemizedlist>
561 This makes it easier to find the text amongst the tags ;-)
566 Use white space to separate logical divisions within a document,
567 like between sections. Running everything together consistently
568 makes it harder to read and work on.
573 Do not hesitate to make comments. Comments can either use the
574 <comment> element, or the <!-- --> style comment
575 familiar from HTML. (Note in Docbook v4.x <comment> is
576 replaced by <remark>.)
581 We have an international audience. Refrain from slang, or English
582 idiosyncrasies (too many to list :). Humor also does not translate
588 Try to keep overall line lengths in source files to 80 characters or less
589 for obvious reasons. This is not always possible, with lengthy URLs for
595 Our documents are available in differing formats. Right now, they
596 are just plain text, HTML, and PDF, but others are always a
597 future possibility. Be careful with URLs (<ulink>), and avoid
601 My favorite site is <ulink url="http://example.com">here</ulink>.
604 This will render as <quote>My favorite site is here</quote>, which is
605 not real helpful in a text doc. Better like this:
608 My favorite site is <ulink url="http://example.com">example.com</ulink>.
613 All documents should be spell checked occasionally.
614 <application>aspell</application> can check SGML with the
615 <literal>-H</literal> option. (<application>ispell</application> I think
626 <!-- ~~~~~ New section ~~~~~ -->
628 <sect2><title>Privoxy Custom Entities</title>
630 <application>Privoxy</application> documentation is using
631 a number of customized <quote>entities</quote> to facilitate
632 documentation maintenance.
635 We are using a set of <quote>boilerplate</quote> files with generic text,
636 that is used by multiple docs. This way we can write something once, and use
637 it repeatedly without having to re-write the same content over and over again.
638 If editing such a file, keep in mind that it should be
639 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
640 contexts without additional modifications.
643 We are also using what <application>Docbook</application> calls
644 <quote>internal entities</quote>. These are like variables in
645 programming. Well, sort of. For instance, we have the
646 <literal>p-version</literal> entity that contains the current
647 <application>Privoxy</application> version string. You are strongly
648 encouraged to use these where possible. Some of these obviously
649 require re-setting with each release (done by the Makefile). A sampling of
650 custom entities are listed below. See any of the main docs for examples.
657 Re- <quote>boilerplate</quote> text entities are defined like:
660 <literal><!entity supported SYSTEM "supported.sgml"></literal>
663 In this example, the contents of the file,
664 <filename>supported.sgml</filename> is available for inclusion anywhere
665 in the doc. To make this happen, just reference the now defined
666 entity: <literal>&supported;</literal> (starts with an ampersand
667 and ends with a semi-colon), and the contents will be dumped into
668 the finished doc at that point.
673 Commonly used <quote>internal entities</quote>:
677 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
678 version string, e.g. <quote>&p-version;</quote>.
681 <emphasis>p-status</emphasis>: the project status, either
682 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
685 <emphasis>p-not-stable</emphasis>: use to conditionally include
686 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
689 <emphasis>p-stable</emphasis>: just the opposite.
692 <emphasis>p-text</emphasis>: this doc is only generated as text.
699 There are others in various places that are defined for a specific
700 purpose. Read the source!
707 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
708 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
710 <!-- ~~~~~ New section ~~~~~ -->
711 <sect1 id="coding"><title>Coding Guidelines</title>
713 <sect2 id="s1"><title>Introduction</title>
715 <para>This set of standards is designed to make our lives easier. It is
716 developed with the simple goal of helping us keep the "new and improved
717 <application>Privoxy</application>" consistent and reliable. Thus making
718 maintenance easier and increasing chances of success of the
721 <para>And that of course comes back to us as individuals. If we can
722 increase our development and product efficiencies then we can solve more
723 of the request for changes/improvements and in general feel good about
724 ourselves. ;-></para>
728 <sect2 id="s2"><title>Using Comments</title>
731 <sect3 id="s3"><title>Comment, Comment, Comment</title>
733 <para><emphasis>Explanation:</emphasis></para>
735 <para>Comment as much as possible without commenting the obvious.
736 For example do not comment "variable_a is equal to variable_b".
737 Instead explain why variable_a should be equal to the variable_b.
738 Just because a person can read code does not mean they will
739 understand why or what is being done. A reader may spend a lot
740 more time figuring out what is going on when a simple comment
741 or explanation would have prevented the extra research. Please
742 help your brother IJB'ers out!</para>
744 <para>The comments will also help justify the intent of the code.
745 If the comment describes something different than what the code
746 is doing then maybe a programming error is occurring.</para>
748 <para><emphasis>Example:</emphasis></para>
750 /* if page size greater than 1k ... */
751 if ( page_length() > 1024 )
753 ... "block" the page up ...
756 /* if page size is small, send it in blocks */
757 if ( page_length() > 1024 )
759 ... "block" the page up ...
762 This demonstrates 2 cases of "what not to do". The first is a
763 "syntax comment". The second is a comment that does not fit what
764 is actually being done.
770 <sect3 id="s4"><title>Use blocks for comments</title>
772 <para><emphasis>Explanation:</emphasis></para>
774 <para>Comments can help or they can clutter. They help when they
775 are differentiated from the code they describe. One line
776 comments do not offer effective separation between the comment
777 and the code. Block identifiers do, by surrounding the code
778 with a clear, definable pattern.</para>
780 <para><emphasis>Example:</emphasis></para>
782 /*********************************************************************
783 * This will stand out clearly in your code!
784 *********************************************************************/
785 if ( this_variable == that_variable )
787 do_something_very_important();
791 /* unfortunately, this may not */
792 if ( this_variable == that_variable )
794 do_something_very_important();
798 if ( this_variable == that_variable ) /* this may not either */
800 do_something_very_important();
803 <para><emphasis>Exception:</emphasis></para>
805 <para>If you are trying to add a small logic comment and do not
806 wish to "disrupt" the flow of the code, feel free to use a 1
807 line comment which is NOT on the same line as the code.</para>
813 <sect3 id="s5"><title>Keep Comments on their own line</title>
815 <para><emphasis>Explanation:</emphasis></para>
817 <para>It goes back to the question of readability. If the comment
818 is on the same line as the code it will be harder to read than
819 the comment that is on its own line.</para>
821 <para>There are three exceptions to this rule, which should be
822 violated freely and often: during the definition of variables,
823 at the end of closing braces, when used to comment
826 <para><emphasis>Example:</emphasis></para>
828 /*********************************************************************
829 * This will stand out clearly in your code,
830 * But the second example won't.
831 *********************************************************************/
832 if ( this_variable == this_variable )
834 do_something_very_important();
837 if ( this_variable == this_variable ) /*can you see me?*/
839 do_something_very_important(); /*not easily*/
843 /*********************************************************************
844 * But, the encouraged exceptions:
845 *********************************************************************/
846 int urls_read = 0; /* # of urls read + rejected */
847 int urls_rejected = 0; /* # of urls rejected */
851 do_something_very_important();
855 short do_something_very_important(
856 short firstparam, /* represents something */
857 short nextparam /* represents something else */ )
861 } /* -END- do_something_very_important */
866 <sect3 id="s6"><title>Comment each logical step</title>
868 <para><emphasis>Explanation:</emphasis></para>
870 <para>Logical steps should be commented to help others follow the
871 intent of the written code and comments will make the code more
874 <para>If you have 25 lines of code without a comment, you should
875 probably go back into it to see where you forgot to put
878 <para>Most "for", "while", "do", etc... loops _probably_ need a
879 comment. After all, these are usually major logic
886 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
888 <para><emphasis>Explanation:</emphasis></para>
890 <para>A reader of the code should be able to look at the comments
891 just prior to the beginning of a function and discern the
892 reason for its existence and the consequences of using it. The
893 reader should not have to read through the code to determine if
894 a given function is safe for a desired use. The proper
895 information thoroughly presented at the introduction of a
896 function not only saves time for subsequent maintenance or
897 debugging, it more importantly aids in code reuse by allowing a
898 user to determine the safety and applicability of any function
899 for the problem at hand. As a result of such benefits, all
900 functions should contain the information presented in the
901 addendum section of this document.</para>
907 <sect3 id="s8"><title>Comment at the end of braces if the
908 content is more than one screen length</title>
910 <para><emphasis>Explanation:</emphasis></para>
912 <para>Each closing brace should be followed on the same line by a
913 comment that describes the origination of the brace if the
914 original brace is off of the screen, or otherwise far away from
915 the closing brace. This will simplify the debugging,
916 maintenance, and readability of the code.</para>
918 <para>As a suggestion , use the following flags to make the
919 comment and its brace more readable:</para>
921 <para>use following a closing brace: } /* -END- if() or while ()
924 <para><emphasis>Example:</emphasis></para>
928 do_something_very_important();
929 ...some long list of commands...
930 } /* -END- if x is 1 */
936 do_something_very_important();
937 ...some long list of commands...
938 } /* -END- if ( 1 == X ) */
944 <sect2 id="s9"><title>Naming Conventions</title>
948 <sect3 id="s10"><title>Variable Names</title>
950 <para><emphasis>Explanation:</emphasis></para>
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>
959 <para><emphasis>Example:</emphasis></para>
961 int ms_iis5_hack = 0;</programlisting>
963 <para><emphasis>Instead of:</emphasis></para>
967 int msiis5hack = 0; int msIis5Hack = 0;
975 <sect3 id="s11"><title>Function Names</title>
977 <para><emphasis>Explanation:</emphasis></para>
979 <para>Use all lowercase, and separate words via an underscore
980 ('_'). Do not start an identifier with an underscore. (ANSI C
981 reserves these for use by the compiler and system headers.) Do
982 not use identifiers which are reserved in ANSI C++. (E.g.
983 template, class, true, false, ...). This is in case we ever
984 decide to port Privoxy to C++.</para>
986 <para><emphasis>Example:</emphasis></para>
988 int load_some_file( struct client_state *csp )</programlisting>
990 <para><emphasis>Instead of:</emphasis></para>
994 int loadsomefile( struct client_state *csp )
995 int loadSomeFile( struct client_state *csp )
1003 <sect3 id="s12"><title>Header file prototypes</title>
1005 <para><emphasis>Explanation:</emphasis></para>
1007 <para>Use a descriptive parameter name in the function prototype
1008 in header files. Use the same parameter name in the header file
1009 that you use in the c file.</para>
1011 <para><emphasis>Example:</emphasis></para>
1013 (.h) extern int load_aclfile( struct client_state *csp );
1014 (.c) int load_aclfile( struct client_state *csp )</programlisting>
1016 <para><emphasis>Instead of:</emphasis>
1018 (.h) extern int load_aclfile( struct client_state * ); or
1019 (.h) extern int load_aclfile();
1020 (.c) int load_aclfile( struct client_state *csp )
1028 <sect3 id="s13"><title>Enumerations, and #defines</title>
1030 <para><emphasis>Explanation:</emphasis></para>
1032 <para>Use all capital letters, with underscores between words. Do
1033 not start an identifier with an underscore. (ANSI C reserves
1034 these for use by the compiler and system headers.)</para>
1036 <para><emphasis>Example:</emphasis></para>
1038 (enumeration) : enum Boolean { FALSE, TRUE };
1039 (#define) : #define DEFAULT_SIZE 100;</programlisting>
1041 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
1042 that toggle a feature in the preprocessor: FEATURE_>, where
1043 > is a short (preferably 1 or 2 word) description.</para>
1045 <para><emphasis>Example:</emphasis></para>
1047 #define FEATURE_FORCE 1
1049 #ifdef FEATURE_FORCE
1050 #define FORCE_PREFIX blah
1051 #endif /* def FEATURE_FORCE */
1056 <sect3 id="s14"><title>Constants</title>
1058 <para><emphasis>Explanation:</emphasis></para>
1060 <para>Spell common words out entirely (do not remove vowels).</para>
1062 <para>Use only widely-known domain acronyms and abbreviations.
1063 Capitalize all letters of an acronym.</para>
1065 <para>Use underscore (_) to separate adjacent acronyms and
1066 abbreviations. Never terminate a name with an underscore.</para>
1068 <para><emphasis>Example:</emphasis></para>
1070 #define USE_IMAGE_LIST 1</programlisting>
1072 <para><emphasis>Instead of:</emphasis></para>
1076 #define USE_IMG_LST 1 or
1077 #define _USE_IMAGE_LIST 1 or
1078 #define USE_IMAGE_LIST_ 1 or
1079 #define use_image_list 1 or
1080 #define UseImageList 1
1090 <sect2 id="s15"><title>Using Space</title>
1094 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1096 <para><emphasis>Explanation:</emphasis></para>
1098 <para>The brace needs to be on a line all by itself, not at the
1099 end of the statement. Curly braces should line up with the
1100 construct that they're associated with. This practice makes it
1101 easier to identify the opening and closing braces for a
1104 <para><emphasis>Example:</emphasis></para>
1111 <para><emphasis>Instead of:</emphasis></para>
1113 <para>if ( this == that ) { ... }</para>
1117 <para>if ( this == that ) { ... }</para>
1119 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1120 inside a loop, and it is trivial, i.e. it tests for a
1121 condition that is obvious from the purpose of the block,
1122 one-liners as above may optically preserve the loop structure
1123 and make it easier to read.</para>
1125 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1127 <para><emphasis>Example exception:</emphasis></para>
1129 while ( more lines are read )
1131 /* Please document what is/is not a comment line here */
1132 if ( it's a comment ) continue;
1134 do_something( line );
1140 <sect3 id="s17"><title>ALL control statements should have a
1143 <para><emphasis>Explanation:</emphasis></para>
1145 <para>Using braces to make a block will make your code more
1146 readable and less prone to error. All control statements should
1147 have a block defined.</para>
1149 <para><emphasis>Example:</emphasis></para>
1154 do_something_else();
1157 <para><emphasis>Instead of:</emphasis></para>
1159 <para>if ( this == that ) do_something(); do_something_else();</para>
1163 <para>if ( this == that ) do_something();</para>
1165 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1166 in a manner other than that which the developer desired (per
1167 indentation). Using code braces would have prevented this
1168 "feature". The "explanation" and "exception" from the point
1169 above also applies.</para>
1175 <sect3 id="s18"><title>Do not belabor/blow-up boolean
1178 <para><emphasis>Example:</emphasis></para>
1180 structure->flag = ( condition );</programlisting>
1182 <para><emphasis>Instead of:</emphasis></para>
1184 <para>if ( condition ) { structure->flag = 1; } else {
1185 structure->flag = 0; }</para>
1187 <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1188 is wordy and inefficient. Please assume that any developer new
1189 to the project has at least a "good" knowledge of C/C++. (Hope
1190 I do not offend by that last comment ... 8-)</para>
1196 <sect3 id="s19"><title>Use white space freely because it is
1199 <para><emphasis>Explanation:</emphasis></para>
1201 <para>Make it readable. The notable exception to using white space
1202 freely is listed in the next guideline.</para>
1204 <para><emphasis>Example:</emphasis></para>
1206 int first_value = 0;
1208 int another_value = 0;
1209 int this_variable = 0;
1211 if ( this_variable == this_variable )
1213 first_value = old_value + ( ( some_value - another_value ) - whatever )
1218 <sect3 id="s20"><title>Don't use white space around structure
1221 <para><emphasis>Explanation:</emphasis></para>
1223 <para>- structure pointer operator ( "->" ) - member operator (
1224 "." ) - functions and parentheses</para>
1226 <para>It is a general coding practice to put pointers, references,
1227 and function parentheses next to names. With spaces, the
1228 connection between the object and variable/function name is not
1231 <para><emphasis>Example:</emphasis></para>
1235 function_name();</programlisting>
1237 <para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
1238 function_name ();</para>
1244 <sect3 id="s21"><title>Make the last brace of a function stand
1247 <para><emphasis>Example:</emphasis></para>
1249 int function1( ... )
1254 } /* -END- function1 */
1257 int function2( ... )
1259 } /* -END- function2 */
1262 <para><emphasis>Instead of:</emphasis></para>
1264 <para>int function1( ... ) { ...code... return( ret_code ); } int
1265 function2( ... ) { }</para>
1267 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1268 lines afterward. This makes the end of function standout to
1269 the most casual viewer. Although function comments help
1270 separate functions, this is still a good coding practice. In
1271 fact, I follow these rules when using blocks in "for", "while",
1272 "do" loops, and long if {} statements too. After all whitespace
1275 <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1276 lines. Enforced is the end of function comments.</para>
1282 <sect3 id="s22"><title>Use 3 character indentions</title>
1284 <para><emphasis>Explanation:</emphasis></para>
1286 <para>If some use 8 character TABs and some use 3 character TABs,
1287 the code can look *very* ragged. So use 3 character indentions
1288 only. If you like to use TABs, pass your code through a filter
1289 such as "expand -t3" before checking in your code.</para>
1291 <para><emphasis>Example:</emphasis></para>
1293 static const char * const url_code_map[256] =
1299 int function1( ... )
1303 return( ALWAYS_TRUE );
1307 return( HOW_DID_YOU_GET_HERE );
1310 return( NEVER_GETS_HERE );
1319 <sect2 id="s23"><title>Initializing</title>
1323 <sect3 id="s24"><title>Initialize all variables</title>
1325 <para><emphasis>Explanation:</emphasis></para>
1327 <para>Do not assume that the variables declared will not be used
1328 until after they have been assigned a value somewhere else in
1329 the code. Remove the chance of accidentally using an unassigned
1332 <para><emphasis>Example:</emphasis></para>
1336 struct *ptr = NULL;</programlisting>
1338 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1339 message says you are trying to access memory address 00000000
1340 and not 129FA012; or array_ptr[20] causes a SIGSEV vs.
1341 array_ptr[0].</para>
1343 <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1344 variable is assigned a value "shortly after" declaration.</para>
1350 <sect2 id="s25"><title>Functions</title>
1354 <sect3 id="s26"><title>Name functions that return a boolean as a
1357 <para><emphasis>Explanation:</emphasis></para>
1359 <para>Value should be phrased as a question that would logically
1360 be answered as a true or false statement</para>
1362 <para><emphasis>Example:</emphasis></para>
1364 should_we_block_this();
1365 contains_an_image();
1366 is_web_page_blank();
1371 <sect3 id="s27"><title>Always specify a return type for a
1374 <para><emphasis>Explanation:</emphasis></para>
1376 <para>The default return for a function is an int. To avoid
1377 ambiguity, create a return for a function when the return has a
1378 purpose, and create a void return type if the function does not
1379 need to return anything.</para>
1385 <sect3 id="s28"><title>Minimize function calls when iterating by
1386 using variables</title>
1388 <para><emphasis>Explanation:</emphasis></para>
1390 <para>It is easy to write the following code, and a clear argument
1391 can be made that the code is easy to understand:</para>
1393 <para><emphasis>Example:</emphasis></para>
1395 for ( size_t cnt = 0; cnt < block_list_length(); cnt++ )
1400 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1401 each and every iteration. This increases the overhead in the
1402 program, because the compiler has to look up the function each
1403 time, call it, and return a value. Depending on what occurs in
1404 the block_list_length() call, it might even be creating and
1405 destroying structures with each iteration, even though in each
1406 case it is comparing "cnt" to the same value, over and over.
1407 Remember too - even a call to block_list_length() is a function
1408 call, with the same overhead.</para>
1410 <para>Instead of using a function call during the iterations,
1411 assign the value to a variable, and evaluate using the
1414 <para><emphasis>Example:</emphasis></para>
1416 size_t len = block_list_length();
1418 for ( size_t cnt = 0; cnt < len; cnt++ )
1423 <para><emphasis>Exceptions:</emphasis> if the value of block_list_length()
1424 *may* change or could *potentially* change, then you must code the
1425 function call in the for/while loop.</para>
1431 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1433 <para><emphasis>Explanation:</emphasis></para>
1435 <para>This allows a developer to define a const pointer and call
1436 your function. If your function does not have the const
1437 keyword, we may not be able to use your function. Consider
1438 strcmp, if it were defined as: extern int strcmp( char *s1,
1441 <para>I could then not use it to compare argv's in main: int main(
1442 int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
1445 <para>Both these pointers are *const*! If the c runtime library
1446 maintainers do it, we should too.</para>
1452 <sect3 id="s30"><title>Pass and Return by Value</title>
1454 <para><emphasis>Explanation:</emphasis></para>
1456 <para>Most structures cannot fit onto a normal stack entry (i.e.
1457 they are not 4 bytes or less). Aka, a function declaration
1458 like: int load_aclfile( struct client_state csp )</para>
1460 <para>would not work. So, to be consistent, we should declare all
1461 prototypes with "pass by value": int load_aclfile( struct
1462 client_state *csp )</para>
1468 <sect3 id="s31"><title>Names of include files</title>
1470 <para><emphasis>Explanation:</emphasis></para>
1472 <para>Your include statements should contain the file name without
1473 a path. The path should be listed in the Makefile, using -I as
1474 processor directive to search the indicated paths. An exception
1475 to this would be for some proprietary software that utilizes a
1476 partial path to distinguish their header files from system or
1477 other header files.</para>
1479 <para><emphasis>Example:</emphasis></para>
1481 #include <iostream.h> /* This is not a local include */
1482 #include "config.h" /* This IS a local include */
1485 <para><emphasis>Exception:</emphasis></para>
1489 /* This is not a local include, but requires a path element. */
1490 #include <sys/fileName.h>
1494 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1495 without a _very_ good reason. This duplicates the #include
1496 "file.h" behavior.</para>
1502 <sect3 id="s32"><title>Provide multiple inclusion
1505 <para><emphasis>Explanation:</emphasis></para>
1507 <para>Prevents compiler and linker errors resulting from
1508 redefinition of items.</para>
1510 <para>Wrap each header file with the following syntax to prevent
1511 multiple inclusions of the file. Of course, replace PROJECT_H
1512 with your file name, with "." Changed to "_", and make it
1515 <para><emphasis>Example:</emphasis></para>
1517 #ifndef PROJECT_H_INCLUDED
1518 #define PROJECT_H_INCLUDED
1520 #endif /* ndef PROJECT_H_INCLUDED */
1525 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1527 <para><emphasis>Explanation:</emphasis></para>
1529 <para>If our headers are included from C++, they must declare our
1530 functions as `extern "C"`. This has no cost in C, but increases
1531 the potential re-usability of our code.</para>
1533 <para><emphasis>Example:</emphasis></para>
1538 #endif /* def __cplusplus */
1540 ... function definitions here ...
1544 #endif /* def __cplusplus */
1549 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1550 Declaration Instead of Includes</title>
1552 <para><emphasis>Explanation:</emphasis></para>
1554 <para>Useful in headers that include pointers to other struct's.
1555 Modifications to excess header files may cause needless
1558 <para><emphasis>Example:</emphasis></para>
1560 /*********************************************************************
1561 * We're avoiding an include statement here!
1562 *********************************************************************/
1564 extern file_list *xyz;</programlisting>
1566 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1567 pointer), then including the proper header file is necessary.
1568 If you only want to prototype a pointer, however, the header
1569 file is unnecessary.</para>
1571 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1577 <sect2 id="s35"><title>General Coding Practices</title>
1581 <sect3 id="s36"><title>Turn on warnings</title>
1583 <para><emphasis>Explanation</emphasis></para>
1585 <para>Compiler warnings are meant to help you find bugs. You
1586 should turn on as many as possible. With GCC, the switch is
1587 "-Wall". Try and fix as many warnings as possible.</para>
1593 <sect3 id="s37"><title>Provide a default case for all switch
1596 <para><emphasis>Explanation:</emphasis></para>
1598 <para>What you think is guaranteed is never really guaranteed. The
1599 value that you don't think you need to check is the one that
1600 someday will be passed. So, to protect yourself from the
1601 unknown, always have a default step in a switch statement.</para>
1603 <para><emphasis>Example:</emphasis></para>
1605 switch( hash_string( cmd ) )
1607 case hash_actions_file :
1617 ... anomaly code goes here ...
1618 continue; / break; / exit( 1 ); / etc ...
1620 } /* end switch( hash_string( cmd ) ) */</programlisting>
1622 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1623 are obviously exempt from this point. Of note, most of the
1624 WIN32 code calls `DefWindowProc' after the switch statement.
1625 This API call *should* be included in a default statement.</para>
1627 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1628 as a robust programming issue. The "anomaly code goes here" may
1629 be no more than a print to the STDERR stream (as in
1630 load_config). Or it may really be an abort condition.</para>
1632 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1638 <sect3 id="s38"><title>Try to avoid falling through cases in a
1639 switch statement.</title>
1641 <para><emphasis>Explanation:</emphasis></para>
1643 <para>In general, you will want to have a 'break' statement within
1644 each 'case' of a switch statement. This allows for the code to
1645 be more readable and understandable, and furthermore can
1646 prevent unwanted surprises if someone else later gets creative
1647 and moves the code around.</para>
1649 <para>The language allows you to plan the fall through from one
1650 case statement to another simply by omitting the break
1651 statement within the case statement. This feature does have
1652 benefits, but should only be used in rare cases. In general,
1653 use a break statement for each case statement.</para>
1655 <para>If you choose to allow fall through, you should comment both
1656 the fact of the fall through and reason why you felt it was
1663 <sect3 id="s39"><title>Use 'long' or 'short' Instead of
1666 <para><emphasis>Explanation:</emphasis></para>
1668 <para>On 32-bit platforms, int usually has the range of long. On
1669 16-bit platforms, int has the range of short.</para>
1671 <para><emphasis>Status:</emphasis> open-to-debate. In the case of most FSF
1672 projects (including X/GNU-Emacs), there are typedefs to int4,
1673 int8, int16, (or equivalence ... I forget the exact typedefs
1674 now). Should we add these to IJB now that we have a "configure"
1681 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1683 <para><emphasis>Explanation:</emphasis></para>
1685 <para>The type of size_t varies across platforms. Do not make
1686 assumptions about whether it is signed or unsigned, or about
1687 how long it is. Do not compare a size_t against another
1688 variable of a different type (or even against a constant)
1689 without casting one of the values.</para>
1695 <sect3 id="s41"><title>Declare each variable and struct on its
1698 <para><emphasis>Explanation:</emphasis></para>
1700 <para>It can be tempting to declare a series of variables all on
1701 one line. Don't.</para>
1703 <para><emphasis>Example:</emphasis></para>
1707 long c = 0;</programlisting>
1709 <para><emphasis>Instead of:</emphasis></para>
1711 <para>long a, b, c;</para>
1713 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1714 individual variables - easier to add new variables without
1715 messing up the original ones - when searching on a variable to
1716 find its type, there is less clutter to "visually"
1719 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1720 variables or other trivial variables; feel free to declare them
1721 on one line. You should, although, provide a good comment on
1722 their functions.</para>
1724 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1730 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1732 <para><emphasis>Explanation:</emphasis></para>
1734 <para>Create a local struct (on the stack) if the variable will
1735 live and die within the context of one function call.</para>
1737 <para>Only "malloc" a struct (on the heap) if the variable's life
1738 will extend beyond the context of one function call.</para>
1740 <para><emphasis>Example:</emphasis></para>
1742 If a function creates a struct and stores a pointer to it in a
1743 list, then it should definitely be allocated via `malloc'.
1748 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1749 Responsible for Ensuring 'free'</title>
1751 <para><emphasis>Explanation:</emphasis></para>
1753 <para>If you have to "malloc" an instance, you are responsible for
1754 insuring that the instance is `free'd, even if the deallocation
1755 event falls within some other programmer's code. You are also
1756 responsible for ensuring that deletion is timely (i.e. not too
1757 soon, not too late). This is known as "low-coupling" and is a
1758 "good thing (tm)". You may need to offer a
1759 free/unload/destructor type function to accommodate this.</para>
1761 <para><emphasis>Example:</emphasis></para>
1763 int load_re_filterfile( struct client_state *csp ) { ... }
1764 static void unload_re_filterfile( void *f ) { ... }</programlisting>
1766 <para><emphasis>Exceptions:</emphasis></para>
1768 <para>The developer cannot be expected to provide `free'ing
1769 functions for C run-time library functions ... such as
1772 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1773 standard is for allocating and freeing data structures (complex
1780 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1781 and in order</title>
1783 <para><emphasis>Explanation:</emphasis></para>
1785 <para>I have ordered all of the "blocker" file code to be in alpha
1786 order. It is easier to add/read new blockers when you expect a
1787 certain order.</para>
1789 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1790 places by POPUP tests coming before PCRS tests. But since
1791 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1792 it should come first.</para>
1798 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1799 existing code, use FIXME or XXX</title>
1801 <para><emphasis>Explanation:</emphasis></para>
1803 <para>If you have enough confidence in new code or confidence in
1804 your changes, but are not *quite* sure of the repercussions,
1807 <para>/* FIXME: this code has a logic error on platform XYZ, *
1808 attempting to fix */ #ifdef PLATFORM ...changed code here...
1813 <para>/* FIXME: I think the original author really meant this...
1814 */ ...changed code here...</para>
1818 <para>/* FIXME: new code that *may* break something else... */
1819 ...new code here...</para>
1821 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1822 be a "good thing (tm)", it will be easier to identify and
1823 include in the project (or conversely exclude from the
1831 <sect2 id="s46"><title>Addendum: Template for files and function
1832 comment blocks:</title>
1834 <para><emphasis>Example for file comments:</emphasis></para>
1836 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 2.17 2008/02/03 21:37:41 hal9 Exp $";
1837 /*********************************************************************
1839 * File : $S<!-- Break CVS Substitution -->ource$
1841 * Purpose : (Fill me in with a good description!)
1843 * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge
1844 * Privoxy team. http://www.privoxy.org/
1846 * Based on the Internet Junkbuster originally written
1847 * by and Copyright (C) 1997 Anonymous Coders and
1848 * Junkbusters Corporation. http://www.junkbusters.com
1850 * This program is free software; you can redistribute it
1851 * and/or modify it under the terms of the GNU General
1852 * Public License as published by the Free Software
1853 * Foundation; either version 2 of the License, or (at
1854 * your option) any later version.
1856 * This program is distributed in the hope that it will
1857 * be useful, but WITHOUT ANY WARRANTY; without even the
1858 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1859 * PARTICULAR PURPOSE. See the GNU General Public
1860 * License for more details.
1862 * The GNU General Public License should be included with
1863 * this file. If not, you can view it at
1864 * http://www.gnu.org/copyleft/gpl.html
1865 * or write to the Free Software Foundation, Inc.,
1866 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1870 * $L<!-- Break CVS Substitution -->og$
1872 *********************************************************************/
1877 ...necessary include files for us to do our work...
1879 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1882 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1883 added to the "show-proxy-args" page. If this is a brand new
1884 creation by you, you are free to change the "Copyright" section
1885 to represent the rights you wish to maintain.</para>
1887 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1888 after the comment flower box is handy for (X|GNU)Emacs users to
1889 skip the verbiage and get to the heart of the code (via
1890 `forward-page' and `backward-page'). Please include it if you
1893 <para><emphasis>Example for file header comments:</emphasis></para>
1897 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 2.17 2008/02/03 21:37:41 hal9 Exp $"
1898 /*********************************************************************
1900 * File : $S<!-- Break CVS Substitution -->ource$
1902 * Purpose : (Fill me in with a good description!)
1904 * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge
1905 * Privoxy team. http://www.privoxy.org/
1907 * Based on the Internet Junkbuster originally written
1908 * by and Copyright (C) 1997 Anonymous Coders and
1909 * Junkbusters Corporation. http://www.junkbusters.com
1911 * This program is free software; you can redistribute it
1912 * and/or modify it under the terms of the GNU General
1913 * Public License as published by the Free Software
1914 * Foundation; either version 2 of the License, or (at
1915 * your option) any later version.
1917 * This program is distributed in the hope that it will
1918 * be useful, but WITHOUT ANY WARRANTY; without even the
1919 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1920 * PARTICULAR PURPOSE. See the GNU General Public
1921 * License for more details.
1923 * The GNU General Public License should be included with
1924 * this file. If not, you can view it at
1925 * http://www.gnu.org/copyleft/gpl.html
1926 * or write to the Free Software Foundation, Inc.,
1927 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1931 * $L<!-- Break CVS Substitution -->og$
1933 *********************************************************************/
1936 #include "project.h"
1942 ... function headers here ...
1945 /* Revision control strings from this header and associated .c file */
1946 extern const char FILENAME_rcs[];
1947 extern const char FILENAME_h_rcs[];
1954 #endif /* ndef _FILENAME_H */
1963 <para><emphasis>Example for function comments:</emphasis></para>
1965 /*********************************************************************
1967 * Function : FUNCTION_NAME
1969 * Description : (Fill me in with a good description!)
1972 * 1 : param1 = pointer to an important thing
1973 * 2 : x = pointer to something else
1975 * Returns : 0 => Ok, everything else is an error.
1977 *********************************************************************/
1978 int FUNCTION_NAME( void *param1, const char *x )
1986 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1987 able to parse our code to create a "self-documenting" web
1994 <!-- ~~~~~ New section ~~~~~ -->
1995 <sect1 id="testing"><title>Testing Guidelines</title>
1999 <!-- ~~~~~ New section ~~~~~ -->
2000 <sect2 id="testing-plan"><title>Testplan for releases</title>
2002 Explain release numbers. major, minor. developer releases. etc.
2004 <orderedlist numeration="arabic">
2006 Remove any existing rpm with rpm -e
2009 Remove any file that was left over. This includes (but is not limited to)
2011 <listitem><para>/var/log/privoxy</para></listitem>
2012 <listitem><para>/etc/privoxy</para></listitem>
2013 <listitem><para>/usr/sbin/privoxy</para></listitem>
2014 <listitem><para>/etc/init.d/privoxy</para></listitem>
2015 <listitem><para>/usr/doc/privoxy*</para></listitem>
2019 Install the rpm. Any error messages?
2021 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
2022 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
2023 autostart work?</para></listitem>
2024 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
2025 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
2030 <!-- ~~~~~ New section ~~~~~ -->
2031 <sect2 id="testing-report"><title>Test reports</title>
2033 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
2034 at sourceforge. Three simple steps:
2037 <listitem><para>Select category: the distribution you test on.</para></listitem>
2038 <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
2039 <listitem><para>Fill the Summary and Detailed Description with something
2040 intelligent (keep it short and precise).</para>
2043 Do not mail to the mailing list (we cannot keep track on issues there).
2049 <!-- ~~~~~ New section ~~~~~ -->
2050 <sect1 id="newrelease"><title>Releasing a New Version</title>
2052 When we release versions of <application>Privoxy</application>,
2053 our work leaves our cozy secret lab and has to work in the cold
2054 RealWorld[tm]. Once it is released, there is no way to call it
2055 back, so it is very important that great care is taken to ensure
2056 that everything runs fine, and not to introduce problems in the
2060 So when releasing a new version, please adhere exactly to the
2061 procedure outlined in this chapter.
2065 The following programs are required to follow this process:
2066 <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
2067 <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
2070 <sect2 id="versionnumbers">
2071 <title>Version numbers</title>
2074 First you need to determine which version number the release will have.
2075 <application>Privoxy</application> version numbers consist of three numbers,
2076 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
2080 X, the version major, is rarely ever changed. It is increased by one if
2081 turning a development branch into stable substantially changes the functionality,
2082 user interface or configuration syntax. Majors 1 and 2 were
2083 <application>Junkbuster</application>, and 3 will be the first stable
2084 <application>Privoxy</application> release.
2089 Y, the version minor, represents the branch within the major version.
2090 At any point in time, there are two branches being maintained:
2091 The stable branch, with an even minor, say, 2N, in which no functionality is
2092 being added and only bug-fixes are made, and 2N+1, the development branch, in
2093 which the further development of <application>Privoxy</application> takes
2095 This enables us to turn the code upside down and inside out, while at the same time
2096 providing and maintaining a stable version.
2097 The minor is reset to zero (and one) when the major is incremented. When a development
2098 branch has matured to the point where it can be turned into stable, the old stable branch
2099 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2100 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2105 Z, the point or sub version, represents a release of the software within a branch.
2106 It is therefore incremented immediately before each code freeze.
2107 In development branches, only the even point versions correspond to actual releases,
2108 while the odd ones denote the evolving state of the sources on CVS in between.
2109 It follows that Z is odd on CVS in development branches most of the time. There, it gets
2110 increased to an even number immediately before a code freeze, and is increased to an odd
2111 number again immediately thereafter.
2112 This ensures that builds from CVS snapshots are easily distinguished from released versions.
2113 The point version is reset to zero when the minor changes.
2116 Stable branches work a little differently, since there should be
2117 little to no development happening in such branches. Remember,
2118 only bugfixes, which presumably should have had some testing
2119 before being committed. Stable branches will then have their
2120 version reported as <literal>0.0.0</literal>, during that period
2121 between releases when changes are being added. This is to denote
2122 that this code is <emphasis>not for release</emphasis>. Then
2123 as the release nears, the version is bumped according: e.g.
2124 <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
2130 In summary, the main CVS trunk is the development branch where new
2131 features are being worked on for the next stable series. This should
2132 almost always be where the most activity takes place. There is always at
2133 least one stable branch from the trunk, e.g now it is
2134 <literal>3.0</literal>, which is only used to release stable versions.
2135 Once the initial *.0 release of the stable branch has been done, then as a
2136 rule, only bugfixes that have had prior testing should be committed to
2137 the stable branch. Once there are enough bugfixes to justify a new
2138 release, the version of this branch is again incremented Example: 3.0.0
2139 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
2140 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
2141 taking place. If any questions, please post to the devel list
2142 <emphasis>before</emphasis> committing to a stable branch!
2145 Developers should remember too that if they commit a bugfix to the stable
2146 branch, this will more than likely require a separate submission to the
2147 main trunk, since these are separate development trees within CVS. If you
2148 are working on both, then this would require at least two separate check
2149 outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
2150 which is <literal>v_3_0_branch</literal> at the moment).
2155 <sect2 id="beforerelease">
2156 <title>Before the Release: Freeze</title>
2158 The following <emphasis>must be done by one of the
2159 developers</emphasis> prior to each new release.
2165 Make sure that everybody who has worked on the code in the last
2166 couple of days has had a chance to yell <quote>no!</quote> in case
2167 they have pending changes/fixes in their pipelines. Announce the
2168 freeze so that nobody will interfere with last minute changes.
2173 Increment the version number (point from odd to even in development
2174 branches!) in <filename>configure.in</filename>. (RPM spec files
2175 will need to be incremented as well.)
2180 If <filename>default.action</filename> has changed since last
2181 release (i.e. software release or standalone actions file release),
2182 bump up its version info to A.B in this line:
2186 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
2190 Then change the version info in doc/webserver/actions/index.php,
2191 line: '$required_actions_file_version = "A.B";'
2196 All documentation should be rebuild after the version bump.
2197 Finished docs should be then be committed to CVS (for those
2198 without the ability to build these). Some docs may require
2199 rather obscure processing tools. <filename>config</filename>,
2200 the man page (and the html version of the man page), and the PDF docs
2201 fall in this category. REAMDE, the man page, AUTHORS, and config
2202 should all also be committed to CVS for other packagers. The
2203 formal docs should be uploaded to the webserver. See the
2204 Section "Updating the webserver" in this manual for details.
2209 The <citetitle>User Manual</citetitle> is also used for context
2210 sensitive help for the CGI editor. This is version sensitive, so that
2211 the user will get appropriate help for his/her release. So with
2212 each release a fresh version should be uploaded to the webserver
2213 (this is in addition to the main <citetitle>User Manual</citetitle>
2214 link from the main page since we need to keep manuals for various
2215 versions available). The CGI pages will link to something like
2216 <literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. This
2217 will need to be updated for each new release. There is no Makefile
2218 target for this at this time!!! It needs to be done manually.
2223 All developers should look at the <filename>ChangeLog</filename> and
2224 make sure noteworthy changes are referenced.
2229 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2234 Tag all files in CVS with the version number with
2235 <quote><command>cvs tag v_X_Y_Z</command></quote>.
2236 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2241 If the release was in a development branch, increase the point version
2242 from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
2248 On the webserver, copy the user manual to a new top-level directory
2249 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2250 pages, which have the version as a prefix, will go into the right version of the manual.
2251 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2252 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2253 <filename>.</filename> (i.e. dot).
2260 <sect2 id="therelease">
2261 <title>Building and Releasing the Packages</title>
2263 Now the individual packages can be built and released. Note that for
2264 GPL reasons the first package to be released is always the source tarball.
2268 For <emphasis>all</emphasis> types of packages, including the source tarball,
2269 <emphasis>you must make sure that you build from clean sources by exporting
2270 the right version from CVS into an empty directory</emphasis> (just press return when
2271 asked for a password):
2276 mkdir dist # delete or choose different name if it already exists
2278 cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
2279 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2284 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2285 version information after export from CVS. This is to make sure that
2286 all release packages, and with them, all future bug reports, are based
2287 on exactly the same code.
2292 Every significant release of Privoxy has included at least one
2293 package that either had incorrect versions of files, missing files,
2294 or incidental leftovers from a previous build process that gave
2295 unknown numbers of users headaches to try to figure out what was
2296 wrong. PLEASE, make sure you are using pristene sources, and are
2297 following the prescribed process!
2302 Please find additional instructions for the source tarball and the
2303 individual platform dependent binary packages below. And details
2304 on the Sourceforge release process below that.
2307 <sect3 id="pack-guidelines">
2308 <title>Note on Privoxy Packaging</title>
2310 Please keep these general guidelines in mind when putting together
2311 your package. These apply to <emphasis>all</emphasis> platforms!
2317 <application>Privoxy</application> <emphasis>requires</emphasis>
2318 write access to: all <filename>*.action</filename> files, all
2319 logfiles, and the <filename>trust</filename> file. You will
2320 need to determine the best way to do this for your platform.
2325 Please include up to date documentation. At a bare minimum:
2329 <filename>LICENSE</filename> (top-level directory)
2334 <filename>README</filename> (top-level directory)
2339 <filename>AUTHORS</filename> (top-level directory)
2344 <filename>man page</filename> (top-level directory, Unix-like
2350 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2355 <filename>FAQ</filename> (doc/webserver/faq/)
2359 Also suggested: <filename>Developer Manual</filename>
2360 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2361 (top-level directory). <filename>FAQ</filename> and the manuals are
2362 HTML docs. There are also text versions in
2363 <filename>doc/text/</filename> which could conceivably also be
2367 The documentation has been designed such that the manuals are linked
2368 to each other from parallel directories, and should be packaged
2369 that way. <filename>privoxy-index.html</filename> can also be
2370 included and can serve as a focal point for docs and other links of
2371 interest (and possibly renamed to <filename>index.html</filename>).
2372 This should be one level up from the manuals. There is a link also
2373 on this page to an HTMLized version of the man page. To avoid 404 for
2374 this, it is in CVS as
2375 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2376 and should be included along with the manuals. There is also a
2377 css stylesheets that can be included for better presentation:
2378 <filename>p_doc.css</filename>. This should be in the same directory
2379 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2380 the manual directories).
2385 <filename>user.action</filename> and <filename>user.filter</filename>
2386 are designed for local preferences. Make sure these do not get overwritten!
2387 <filename>config</filename> should not be overwritten either. This
2388 has especially important configuration data in it.
2389 <filename>trust</filename> should be left in tact as well.
2394 Other configuration files (<filename>default.action</filename>,
2395 <filename>default.filter</filename> and
2396 <filename>standard.action</filename>) should be installed as the new
2397 defaults, but all previously installed configuration files should be
2398 preserved as backups. This is just good manners :-) These files are
2399 likely to change between releases and contain important new features
2405 Please check platform specific notes in this doc, if you haven't
2406 done <quote>Privoxy</quote> packaging before for other platform
2407 specific issues. Conversely, please add any notes that you know
2408 are important for your platform (or contact one of the doc
2409 maintainers to do this if you can't).
2414 Packagers should do a <quote>clean</quote> install of their
2415 package after building it. So any previous installs should be
2416 removed first to ensure the integrity of the newly built package.
2417 Then run the package for a while to make sure there are no
2418 obvious problems, before uploading.
2427 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2429 First, <emphasis>make sure that you have freshly exported the right
2430 version into an empty directory</emphasis>. (See "Building and releasing
2431 packages" above). Then run:
2436 autoheader && autoconf && ./configure
2448 To upload the package to Sourceforge, simply issue
2456 Go to the displayed URL and release the file publicly on Sourceforge.
2457 For the change log field, use the relevant section of the
2458 <filename>ChangeLog</filename> file.
2462 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2464 In following text, replace <replaceable class="parameter">dist</replaceable>
2465 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2468 First, <emphasis>make sure that you have freshly exported the right
2469 version into an empty directory</emphasis>. (See "Building and releasing
2473 As the only exception to not changing anything after export from CVS,
2474 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2475 and make sure that the version information and the RPM release number are
2476 correct. The RPM release numbers for each version start at one. Hence it must
2477 be reset to one if this is the first RPM for
2478 <replaceable class="parameter">dist</replaceable> which is built from version
2480 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">file
2481 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2482 release number for that version plus one.
2490 autoheader && autoconf && ./configure
2498 make <replaceable class="parameter">dist</replaceable>-dist
2502 To upload the package to Sourceforge, simply issue
2506 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2510 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2511 RPM release number as determined above.
2512 Go to the displayed URL and release the file publicly on Sourceforge.
2513 Use the release notes and change log from the source tarball package.
2517 <sect3 id="newrelease-os2"><title>OS/2</title>
2519 First, <emphasis>make sure that you have freshly exported the right
2520 version into an empty directory</emphasis>. (See "Building and releasing
2521 packages" above). Then get the OS/2 Setup module:
2525 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
2529 You will need a mix of development tools.
2530 The main compilation takes place with IBM Visual Age C++.
2531 Some ancillary work takes place with GNU tools, available from
2532 various sources like hobbes.nmsu.edu.
2533 Specificially, you will need <filename>autoheader</filename>,
2534 <filename>autoconf</filename> and <filename>sh</filename> tools.
2535 The packaging takes place with WarpIN, available from various sources, including
2536 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2539 Change directory to the <filename>os2setup</filename> directory.
2540 Edit the os2build.cmd file to set the final executable filename.
2545 installExeName='privoxyos2_setup_X.Y.Z.exe'
2549 Next, edit the <filename>IJB.wis</filename> file so the release number matches
2550 in the <filename>PACKAGEID</filename> section:
2554 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2558 You're now ready to build. Run:
2566 You will find the WarpIN-installable executable in the
2567 <filename>./files</filename> directory. Upload this anonymously to
2568 <filename>uploads.sourceforge.net/incoming</filename>, create a release
2569 for it, and you're done. Use the release notes and Change Log from the
2570 source tarball package.
2574 <sect3 id="newrelease-solaris"><title>Solaris</title>
2576 Login to Sourceforge's compilefarm via ssh:
2580 ssh cf.sourceforge.net
2584 Choose the right operating system (not the Debian one).
2585 When logged in, <emphasis>make sure that you have freshly exported the right
2586 version into an empty directory</emphasis>. (See "Building and releasing
2587 packages" above). Then run:
2592 autoheader && autoconf && ./configure
2604 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2605 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2606 to manually upload the archive to Sourceforge's ftp server and release
2607 the file publicly. Use the release notes and Change Log from the
2608 source tarball package.
2612 <sect3 id="newrelease-windows"><title>Windows</title>
2614 You should ensure you have the latest version of Cygwin (from
2615 <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>).
2616 Run the following commands from within a Cygwin bash shell.
2619 First, <emphasis>make sure that you have freshly exported the right
2620 version into an empty directory</emphasis>. (See "Building and releasing
2621 packages" above). Then get the Windows setup module:
2625 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
2629 Then you can build the package. This is fully automated, and is
2630 controlled by <filename>winsetup/GNUmakefile</filename>.
2631 All you need to do is:
2640 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2641 <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
2642 SourceForge. When releasing the package on SourceForge, use the release notes
2643 and Change Log from the source tarball package.
2647 <sect3 id="newrelease-debian"><title>Debian</title>
2649 First, <emphasis>make sure that you have freshly exported the
2650 right version into an empty directory</emphasis>. (See
2651 "Building and releasing packages" above). Then add a log
2652 entry to <filename>debian/changelog</filename>, if it is not
2653 already there, for example by running:
2657 debchange -v &p-version;-&p-status;-1 "New upstream version"
2665 dpkg-buildpackage -rfakeroot -us -uc -b
2670 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2671 which can be uploaded. To upload the package to Sourceforge, simply
2681 <sect3 id="newrelease-macosx"><title>Mac OS X</title>
2683 First, <emphasis>make sure that you have freshly exported the right
2684 version into an empty directory</emphasis>. (See "Building and releasing
2685 packages" above). Then get the Mac OS X setup module:
2689 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
2702 This will run <filename>autoheader</filename>, <filename>autoconf</filename> and
2703 <filename>configure</filename> as well as <filename>make</filename>.
2704 Finally, it will copy over the necessary files to the ./osxsetup/files directory
2705 for further processing by <filename>PackageMaker</filename>.
2708 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
2709 name to match the release, and hit the "Create package" button.
2710 If you specify ./Privoxy.pkg as the output package name, you can then create
2711 the distributable zip file with the command:
2715 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2719 You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to
2720 <filename>uploads.sourceforge.net/incoming</filename>,
2721 create a release for it, and you're done. Use the release notes
2722 and Change Log from the source tarball package.
2726 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2728 Login to Sourceforge's compile-farm via ssh:
2732 ssh cf.sourceforge.net
2736 Choose the right operating system.
2737 When logged in, <emphasis>make sure that you have freshly exported the right
2738 version into an empty directory</emphasis>. (See "Building and releasing
2739 packages" above). Then run:
2744 autoheader && autoconf && ./configure
2756 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2757 freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
2758 to manually upload the archive to Sourceforge's ftp server and release
2759 the file publicly. Use the release notes and Change Log from the
2760 source tarball package.
2764 <sect3 id="newrelease-hpux"><title>HP-UX 11</title>
2766 First, <emphasis>make sure that you have freshly exported the right
2767 version into an empty directory</emphasis>. (See "Building and releasing
2768 packages" above). Then run:
2773 autoheader && autoconf && ./configure
2781 <sect3 id="newrelease-amiga"><title>Amiga OS</title>
2783 First, <emphasis>make sure that you have freshly exported the right
2784 version into an empty directory</emphasis>. (See "Building and releasing
2785 packages" above). Then run:
2790 autoheader && autoconf && ./configure
2798 <sect3 id="newrelease-aix"><title>AIX</title>
2800 Login to Sourceforge's compilefarm via ssh:
2804 ssh cf.sourceforge.net
2808 Choose the right operating system.
2809 When logged in, <emphasis>make sure that you have freshly exported the right
2810 version into an empty directory</emphasis>. (See "Building and releasing
2811 packages" above). Then run:
2816 autoheader && autoconf && ./configure
2828 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2829 aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
2830 to manually upload the archive to Sourceforge's ftp server and release
2831 the file publicly. Use the release notes and Change Log from the
2832 source tarball package.
2837 <sect2 id="releasing">
2838 <title>Uploading and Releasing Your Package</title>
2840 After the package is ready, it is time to upload it
2841 to SourceForge, and go through the release steps. The upload
2848 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2853 user: <literal>anonymous</literal>
2858 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2864 Or use the <command>make</command> targets as described above.
2867 Once this done go to <ulink
2868 url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
2869 >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
2870 making sure you are logged in. Find your target platform in the
2871 second column, and click <literal>Add Release</literal>. You will
2872 then need to create a new release for your package, using the format
2873 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2877 Now just follow the prompts. Be sure to add any appropriate Release
2878 notes. You should see your freshly uploaded packages in
2879 <quote>Step 2. Add Files To This Release</quote>. Check the
2880 appropriate box(es). Remember at each step to hit the
2881 <quote>Refresh/Submit</quote> buttons! You should now see your
2882 file(s) listed in Step 3. Fill out the forms with the appropriate
2883 information for your platform, being sure to hit <quote>Update</quote>
2884 for each file. If anyone is monitoring your platform, check the
2885 <quote>email</quote> box at the very bottom to notify them of
2886 the new package. This should do it!
2889 If you have made errors, or need to make changes, you can go through
2890 essentially the same steps, but select <literal>Edit Release</literal>,
2891 instead of <literal>Add Release</literal>.
2895 <sect2 id="afterrelease">
2896 <title>After the Release</title>
2898 When all (or: most of the) packages have been uploaded and made available,
2899 send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
2900 mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2902 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
2903 location</ulink>, the release notes and the Changelog. Also, post an
2904 updated News item on the project page Sourceforge, and update the Home
2905 page and docs linked from the Home page (see below). Other news sites
2906 and release oriented sites, such as Freshmeat, should also be notified.
2912 <!-- ~~~~~ New section ~~~~~ -->
2913 <sect1 id="webserver-update"><title>Update the Webserver</title>
2915 The webserver should be updated at least with each stable release. When
2916 updating, please follow these steps to make sure that no broken links,
2917 inconsistent contents or permission problems will occur (as it has many
2918 times in the past!):
2921 If you have changed anything in the stable-branch documentation source
2926 make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
2930 That will generate <filename>doc/webserver/user-manual</filename>,
2931 <filename>doc/webserver/developer-manual</filename>,
2932 <filename>doc/webserver/faq</filename>,
2933 <filename>doc/pdf/*.pdf</filename> and
2934 <filename>doc/webserver/index.html</filename> automatically.
2937 If you changed the manual page sources, generate
2938 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2939 by running <quote><command>make man</command></quote>. (This is
2940 a separate target due to dependencies on some obscure perl scripts
2941 [now in CVS, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
2944 If you want to add new files to the webserver, create them locally in
2945 the <filename>doc/webserver/*</filename> directory (or
2946 create new directories under <filename>doc/webserver</filename>).
2949 Next, commit any changes from the above steps to CVS. All set?
2950 If these are docs in the stable branch, then do:
2958 This will do the upload to <ulink url="http://www.privoxy.org/">the
2959 webserver</ulink> (www.privoxy.org) and ensure all files and directories
2960 there are group writable.
2963 Please do <emphasis>NOT</emphasis> use any other means of transferring
2964 files to the webserver to avoid permission problems. Also, please do not
2965 upload docs from development branches or versions. The publicly posted
2966 docs should be in sync with the last official release.
2970 <!-- ~~~~~ New section ~~~~~ -->
2971 <sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
2972 <!-- Include contacting.sgml -->
2974 <!-- end contacting -->
2978 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
2979 <sect1 id="copyright"><title>Privoxy Copyright, License and History</title>
2981 <!-- Include copyright.sgml -->
2985 <!-- ~~~~~ New section ~~~~~ -->
2986 <sect2><title>License</title>
2987 <!-- Include copyright.sgml: -->
2989 <!-- end copyright -->
2991 <!-- ~ End section ~ -->
2993 <!-- ~~~~~ New section ~~~~~ -->
2994 <sect2><title>History</title>
2995 <!-- Include history.sgml -->
3002 <!-- ~~~~~ New section ~~~~~ -->
3003 <sect1 id="seealso"><title>See also</title>
3004 <!-- Include seealso.sgml -->
3012 This program is free software; you can redistribute it
3013 and/or modify it under the terms of the GNU General
3014 Public License as published by the Free Software
3015 Foundation; either version 2 of the License, or (at
3016 your option) any later version.
3018 This program is distributed in the hope that it will
3019 be useful, but WITHOUT ANY WARRANTY; without even the
3020 implied warranty of MERCHANTABILITY or FITNESS FOR A
3021 PARTICULAR PURPOSE. See the GNU General Public
3022 License for more details.
3024 The GNU General Public License should be included with
3025 this file. If not, you can view it at
3026 http://www.gnu.org/copyleft/gpl.html
3027 or write to the Free Software Foundation, Inc., 59
3028 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3030 $Log: developer-manual.sgml,v $
3031 Revision 2.17 2008/02/03 21:37:41 hal9
3032 Apply patch from Mark: s/OSX/OS X/
3034 Revision 2.16 2008/01/19 17:52:38 hal9
3035 Re-commit to fix various minor issues for new release.
3037 Revision 2.15 2008/01/19 15:03:05 hal9
3038 Doc sources tagged for 3.0.8 release.
3040 Revision 2.14 2008/01/17 01:49:51 hal9
3041 Change copyright notice for docs s/2007/2008/. All these will be rebuilt soon
3044 Revision 2.13 2007/10/30 17:59:31 fabiankeil
3045 - Bump p-version, p-status and copyright date.
3046 - Mention that the manual is out of date.
3047 - Don't use examples with HardToReadCamelCase after
3048 explaining that we actually don't like that.
3051 Revision 2.12 2006/11/14 01:57:46 hal9
3052 Dump all docs prior to 3.0.6 release. Various minor changes to faq and user
3055 Revision 2.11 2006/09/26 02:36:29 hal9
3056 Fix broken link per bug tracker.
3058 Revision 2.10 2006/09/22 01:27:55 hal9
3059 Final commit of probably various minor changes here and there. Unless
3060 something changes this should be ready for pending release.
3062 Revision 2.9 2006/09/14 02:30:07 hal9
3063 Fix ijbswa cvs links. Update notes on release process, and which config files
3064 should be overwritten and which not.
3066 Revision 2.8 2006/08/22 23:35:01 hal9
3067 Fix email address, cvs URI, address branching changes and various other
3070 Revision 2.7 2006/07/18 14:48:50 david__schmidt
3071 Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
3072 with what was really the latest development (the v_3_0_branch branch)
3074 Revision 1.46.2.11 2002/12/11 13:12:15 hal9
3075 Rewrite cvs write access give-away section.
3077 Revision 1.46.2.10 2002/09/26 21:53:45 hal9
3078 Changes to reflect recent change in stable branch commit policy (hopefully
3081 Revision 1.46.2.9 2002/09/26 01:21:40 hal9
3082 Porting 3.1.1 changes: more on cvs and branches, more on versions and
3085 Revision 1.46.2.8 2002/08/17 00:16:10 hal9
3086 Add note on updating webserver for User-manual/CGI editor, which is version
3087 dependent (and different from main UM link).
3089 Revision 1.46.2.7 2002/08/14 17:29:25 hal9
3090 Add small notes on post-release steps, and uploading docs to webserver.
3092 Revision 1.46.2.6 2002/08/10 11:40:25 oes
3093 Added disclaimer about probably being out-of-date and two small hints
3095 Revision 1.46.2.5 2002/08/09 01:15:12 hal9
3096 Added some notes on pre-release steps (test builds first, update ChangeLog).
3098 Revision 1.46.2.4 2002/05/29 00:30:59 mal0rd
3099 Fixed a little formatting. Clarified debian section.
3101 Revision 1.46.2.3 2002/05/28 04:32:45 hal9
3102 Change hints on bundling index.html to privoxy-index.html
3104 Revision 1.46.2.2 2002/05/26 17:04:24 hal9
3105 -Spellcheck, very minor edits, and sync across branches
3107 Revision 1.48 2002/05/26 12:48:31 roro
3108 Add releasing information about Debian.
3110 Revision 1.47 2002/05/26 04:55:11 mal0rd
3111 Added debian-dist and debian-upload targets. Also documented usage.
3113 Revision 1.46 2002/05/22 17:15:00 oes
3116 Revision 1.45 2002/05/19 23:01:54 hal9
3117 Add small section on general packaging guidelines (e.g. actions files must
3120 Revision 1.44 2002/05/15 03:55:17 hal9
3121 Fix ulink -> link, and minor modification to release process section for
3124 Revision 1.43 2002/05/10 01:48:19 hal9
3125 This is mostly proposed copyright/licensing additions and changes. Docs
3126 are still GPL, but licensing and copyright are more visible. Also, copyright
3127 changed in doc header comments (eliminate references to JB except FAQ).
3129 Revision 1.42 2002/05/05 20:26:02 hal9
3130 Sorting out license vs copyright in these docs.
3132 Revision 1.41 2002/05/04 08:44:44 swa
3135 Revision 1.40 2002/05/04 00:43:43 hal9
3136 -Remove TOC/first page kludge with proper stylesheet fix.
3137 -Combined the two very brief sections: Intro and Quickstart.
3139 Revision 1.39 2002/05/02 15:08:25 oes
3140 Added explanation about version numbers and RPM package revisions
3142 Revision 1.38 2002/04/29 02:20:31 hal9
3143 Add info on steps for uploading and the release process on SF.
3145 Revision 1.37 2002/04/26 17:23:29 swa
3146 bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
3148 Revision 1.36 2002/04/26 05:25:23 hal9
3149 Mass commit to catch a few scattered fixes.
3151 Revision 1.35 2002/04/17 15:16:15 oes
3152 Added link to docbook crash course
3154 Revision 1.34 2002/04/15 23:39:32 oes
3155 - Extended & fixed the release section
3156 - Added CVS guideline sections
3157 - Separated webserver section from release section
3158 - Commented out boilerplate inclusion (If you don't know yet what it is,
3159 you shouldn't mess with its code ;-)
3162 Revision 1.33 2002/04/12 03:49:53 hal9
3163 Spell checked. Clarification on where docs are kept.
3165 Revision 1.32 2002/04/11 21:29:58 jongfoster
3166 Documenting Win32 release procedure
3168 Revision 1.31 2002/04/11 09:32:52 oes
3171 Revision 1.30 2002/04/11 09:24:53 oes
3174 Revision 1.29 2002/04/10 18:45:14 swa
3177 Revision 1.28 2002/04/08 22:59:26 hal9
3178 Version update. Spell chkconfig correctly :)
3180 Revision 1.27 2002/04/08 15:31:18 hal9
3181 Touch ups to documentation section.
3183 Revision 1.26 2002/04/07 23:50:08 hal9
3184 Documentation changes to reflect HTML docs now in CVS, and new generated files
3187 Revision 1.25 2002/04/06 05:07:28 hal9
3188 -Add privoxy-man-page.sgml, for man page.
3189 -Add authors.sgml for AUTHORS (and p-authors.sgml)
3190 -Reworked various aspects of various docs.
3191 -Added additional comments to sub-docs.
3193 Revision 1.24 2002/04/04 21:33:37 hal9
3194 More on documenting the documents.
3196 Revision 1.23 2002/04/04 18:46:47 swa
3197 consistent look. reuse of copyright, history et. al.
3199 Revision 1.22 2002/04/04 17:27:56 swa
3200 more single file to be included at multiple points. make maintaining easier
3202 Revision 1.21 2002/04/04 06:48:37 hal9
3203 Structural changes to allow for conditional inclusion/exclusion of content
3204 based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
3205 definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
3206 eventually be set by Makefile.
3207 More boilerplate text for use across multiple docs.
3209 Revision 1.20 2002/04/04 03:28:27 david__schmidt
3210 Add Mac OS X section
3212 Revision 1.19 2002/04/03 15:09:42 david__schmidt
3213 Add OS/2 build section
3215 Revision 1.18 2002/04/03 03:51:48 hal9
3218 Revision 1.17 2002/04/03 01:21:17 hal9
3219 Implementing Andreas's suggestions for Release sections.
3221 Revision 1.16 2002/03/31 23:04:40 hal9
3222 Fleshed out the doc section, and added something for an intro so it was not
3225 Revision 1.15 2002/03/30 22:29:47 swa
3228 Revision 1.14 2002/03/30 19:04:08 swa
3229 people release differently. no good.
3230 I want to make parts of the docs only.
3232 Revision 1.13 2002/03/27 01:16:41 hal9
3235 Revision 1.12 2002/03/27 01:02:51 hal9
3236 Touch up on name change...
3238 Revision 1.11 2002/03/26 22:29:55 swa
3239 we have a new homepage!
3241 Revision 1.10 2002/03/24 12:33:01 swa
3244 Revision 1.9 2002/03/24 11:01:05 swa
3247 Revision 1.8 2002/03/23 15:13:11 swa
3248 renamed every reference to the old name with foobar.
3249 fixed "application foobar application" tag, fixed
3250 "the foobar" with "foobar". left junkbustser in cvs
3251 comments and remarks to history untouched.
3253 Revision 1.7 2002/03/11 13:13:27 swa
3254 correct feedback channels
3256 Revision 1.6 2002/02/24 14:25:06 jongfoster
3257 Formatting changes. Now changing the doctype to DocBook XML 4.1
3258 will work - no other changes are needed.
3260 Revision 1.5 2001/10/31 18:16:51 swa
3261 documentation added: howto generate docs in text and html
3262 format, howto move stuff to the webserver.
3264 Revision 1.4 2001/09/23 10:13:48 swa
3265 upload process established. run make webserver and
3266 the documentation is moved to the webserver. documents
3267 are now linked correctly.
3269 Revision 1.3 2001/09/13 15:27:40 swa
3272 Revision 1.2 2001/09/13 15:20:17 swa
3273 merged standards into developer manual
3275 Revision 1.1 2001/09/12 15:36:41 swa
3276 source files for junkbuster documentation
3278 Revision 1.3 2001/09/10 17:43:59 swa
3279 first proposal of a structure.
3281 Revision 1.2 2001/06/13 14:28:31 swa
3282 docs should have an author.
3284 Revision 1.1 2001/06/13 14:20:37 swa
3285 first import of project's documentation for the webserver.