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.20">
12 <!entity p-status "UNRELEASED">
13 <!entity % p-not-stable "INCLUDE">
14 <!entity % p-stable "IGNORE">
15 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
16 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
17 <!entity % seealso-extra "INCLUDE"> <!-- extra stuff from seealso.sgml -->
18 <!entity my-copy "©"> <!-- kludge for docbook2man -->
21 File : $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
23 Purpose : developer manual
24 This file belongs into
25 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
27 $Id: developer-manual.sgml,v 2.46 2012/03/20 13:04:54 fabiankeil Exp $
29 Copyright (C) 2001-2012 Privoxy Developers http://www.privoxy.org/
32 ========================================================================
33 NOTE: Please read developer-manual/documentation.html before touching
34 anything in this, or other Privoxy documentation. You have been warned!
35 Failure to abide by this rule will result in the revocation of your license
36 to live a peaceful existence!
37 ========================================================================
43 <title>Privoxy Developer Manual</title>
46 <!-- Completely the wrong markup, but very little is allowed -->
47 <!-- in this part of an article. FIXME -->
48 <link linkend="copyright">Copyright</link> &my-copy; 2001-2009 by
49 <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
54 <pubdate>$Id: developer-manual.sgml,v 2.46 2012/03/20 13:04:54 fabiankeil Exp $</pubdate>
58 Note: this should generate a separate page, and a live link to it.
59 But it doesn't for some mysterious reason. Please leave commented
60 unless it can be fixed proper. For the time being, the copyright
61 statement will be in copyright.smgl.
65 <legalnotice id="legalnotice">
67 text goes here ........
78 This is here to keep vim syntax file from breaking :/
79 If I knew enough to fix it, I would.
80 PLEASE DO NOT REMOVE! HB: hal@foobox.net
85 The developer manual provides guidance on coding, testing, packaging, documentation
86 and other issues of importance to those involved with
87 <application>Privoxy</application> development. It is mandatory (and helpful!) reading
88 for anyone who wants to join the team. Note that it's currently out of date
89 and may not be entirely correct. As always, patches are welcome.
92 <!-- Include privoxy.sgml boilerplate text: -->
94 <!-- &p-intro; Someone interested enough in the project to contribute
95 will already know at this point what Privoxy is. -->
97 <!-- end boilerplate -->
100 Please note that this document is constantly evolving. This copy represents
101 the state at the release of version &p-version;.
102 You can find the latest version of the this manual at <ulink
103 url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
104 Please see <link linkend="contact">the Contact section</link>
105 on how to contact the developers.
108 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
115 <!-- ~~~~~ New section ~~~~~ -->
116 <sect1 id="introduction"><title>Introduction</title>
119 I don't like seeing blank space :) So added *something* here.
123 <application>Privoxy</application>, as an heir to
124 <application>Junkbuster</application>, is a Free Software project
125 and the code is licensed under the GNU General Public License version 2.
126 As such, <application>Privoxy</application> development is potentially open
127 to anyone who has the time, knowledge, and desire to contribute
128 in any capacity. Our goals are simply to continue the mission,
129 to improve <application>Privoxy</application>, and
130 to make it available to as wide an audience as possible.
133 One does not have to be a programmer to contribute. Packaging, testing,
134 documenting and porting, are all important jobs as well.
137 <!-- ~~~~~ New section ~~~~~ -->
138 <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
140 The first step is to join the <ulink
141 url="mailto:ijbswa-developers@lists.sourceforge.net">developer's mailing list</ulink>.
142 You can submit your ideas, or even better patches. Patches are best
143 submitted to the Sourceforge tracker set up for this purpose, but
144 can be sent to the list for review too.
147 You will also need to have a cvs package installed, which will
148 entail having ssh installed as well (which seems to be a requirement of
149 SourceForge), in order to access the cvs repository. Having the GNU build
150 tools is also going to be important (particularly, autoconf and gmake).
153 For the time being (read, this section is under construction), you can
154 also refer to the extensive comments in the source code. In fact,
155 reading the code is recommended in any case.
160 <!-- ~~~~~ New section ~~~~~ -->
161 <sect1 id="cvs"><title>The CVS Repository</title>
163 If you become part of the active development team, you will eventually
164 need write access to our holy grail, the CVS repository. One of the
165 team members will need to set this up for you. Please read
166 this chapter completely before accessing via CVS.
169 <sect2 id="cvsaccess"><title>Access to CVS</title>
171 The project's CVS repository is hosted on
172 <ulink url="http://sourceforge.net/">SourceForge.</ulink>
173 Please refer to the chapters 6 and 7 in
174 <ulink url="http://sourceforge.net/docman/?group_id=1">SF's site
175 documentation</ulink> for the technical access details for your
176 operating system. For historical reasons, the CVS server is
177 called <literal>ijbswa.cvs.sourceforge.net</literal>, the repository is
178 called <literal>ijbswa</literal>, and the source tree module is called
179 <literal>current</literal>.
183 <sect2 id="cvsbranches">
184 <title>Branches</title>
186 Within the CVS repository, there are modules and branches. As
187 mentioned, the sources are in the <literal>current</literal>
188 <quote>module</quote>. Other modules are present for platform specific
189 issues. There is a webview of the CVS hierarchy at <ulink
190 url="http://ijbswa.cvs.sourceforge.net/ijbswa/">http://ijbswa.cvs.sourceforge.net/ijbswa/</ulink>,
191 which might help with visualizing how these pieces fit together.
195 Branches are used to fork a sub-development path from the main trunk.
196 Within the <literal>current</literal> module where the sources are, there
197 is always at least one <quote>branch</quote> from the main trunk
198 devoted to a stable release series. The main trunk is where active
199 development takes place for the next stable series (e.g. 3.2.x).
200 So just prior to each stable series (e.g. 3.0.x), a branch is created
201 just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
202 Once the initial stable release of any stable branch has taken place,
203 this branch is <emphasis>only used for bugfixes</emphasis>, which have
204 had prior testing before being committed to CVS. (See <link
205 linkend="versionnumbers">Version Numbers</link> below for details on
210 At one time there were two distinct branches: stable and unstable. The
211 more drastic changes were to be in the unstable branch. These branches
212 have now been merged to minimize time and effort of maintaining two
217 This will result in at least two active branches, which means there may
218 be occasions that require the same (or similar) item to be
219 checked into to two different places (assuming its a bugfix and needs
220 fixing in both the stable and unstable trees). This also means that in
221 order to have access to both trees, both will have to be checked out
222 separately. Use the <literal>cvs -r</literal> flag to check out a
223 branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
228 <sect2 id="cvscommit"><title>CVS Commit Guidelines</title>
230 The source tree is the heart of every software project. Every effort must
231 be made to ensure that it is readable, compilable and consistent at all
232 times. <!-- There are differing guidelines for the stable branch and the
233 main development trunk, and --> We expect anyone with CVS access to strictly
234 adhere to the following guidelines:
238 Basic Guidelines, for all branches:
243 Please don't commit even
244 a small change without testing it thoroughly first. When we're
245 close to a public release, ask a fellow developer to review your
249 Your commit message should give a concise overview of <emphasis>what you
250 changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
251 Just check previous messages for good examples.
254 Don't use the same message on multiple files, unless it equally applies to
258 If your changes span multiple files, and the code won't recompile unless
259 all changes are committed (e.g. when changing the signature of a function),
260 then commit all files one after another, without long delays in between.
261 If necessary, prepare the commit messages in advance.
264 Before changing things on CVS, make sure that your changes are in line
265 with the team's general consensus on what should be done.
269 Note that near a major public release, we get more cautious.
270 There is always the possibility to submit a patch to the <ulink
271 url="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patch
272 tracker</ulink> instead.
280 Stable branches are handled with more care, especially after the
281 initial *.*.0 release, and we are just in bugfix mode. In addition to
282 the above, the below applies only to the stable branch (currently the
283 <literal>v_3_0_branch</literal> branch):
290 Do not commit <emphasis>anything</emphasis> unless your proposed
291 changes have been well tested first, preferably by other members of the
292 project, or have prior approval of the project leaders or consensus
298 Where possible, bugfixes and changes should be tested in the main
299 development trunk first. There may be occasions where this is not
305 Alternately, proposed changes can be submitted as patches to the patch tracker on
306 Sourceforge first: <ulink
307 url="http://sourceforge.net/tracker/?group_id=11118&atid=311118">http://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
308 Then ask for peer review.
313 Do not even think about anything except bugfixes. No new features!
324 <!-- ~~~~~ New section ~~~~~ -->
325 <sect1 id="documentation"><title>Documentation Guidelines</title>
327 All formal documents are maintained in Docbook SGML and located in the
328 <computeroutput>doc/source/*</computeroutput> directory. You will need
329 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
330 DTD's and the Docbook modular stylesheets (or comparable alternatives),
331 and either <application>jade</application> or
332 <application>openjade</application> (recommended) installed in order to
333 build docs from source. Currently there is <ulink
334 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
335 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
336 course this, the <citetitle>developer-manual</citetitle> in this format.
337 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
338 <citetitle>INSTALL</citetitle>,
339 <citetitle>privoxy.1</citetitle> (man page), and
340 <citetitle>config</citetitle> files are also now maintained as Docbook
341 SGML. These files, when built, in the top-level source directory are
342 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
343 variation on this file, <filename>privoxy-index.html</filename>,
344 meant for inclusion with doc packages), are maintained as SGML as well.
345 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
346 contact someone involved in the documentation.
349 <filename>config</filename> requires some special handling. The reason it
350 is maintained this way is so that the extensive comments in the file
351 mirror those in <citetitle>user-manual</citetitle>. But the conversion
352 process requires going from SGML to HTML to text to special formatting
353 required for the embedded comments. Some of this does not survive so
354 well. Especially some of the examples that are longer than 80 characters.
355 The build process for this file outputs to <filename>config.new</filename>,
356 which should be reviewed for errors and mis-formatting. Once satisfied
357 that it is correct, then it should be hand copied to
358 <filename>config</filename>.
361 Other, less formal documents (e.g. <filename>LICENSE</filename>) are
362 maintained as plain text files in the top-level source directory.
365 Packagers are encouraged to include this documentation. For those without
366 the ability to build the docs locally, text versions of each are kept in
367 CVS. HTML versions are also being kept in CVS under
368 <filename>doc/webserver/*</filename>.
371 Formal documents are built with the Makefile targets of
372 <computeroutput>make dok</computeroutput>.
373 The build process uses the document SGML sources in
374 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
375 <computeroutput>doc/text/</computeroutput> and to update all HTML
376 documents in <computeroutput>doc/webserver/</computeroutput>.
379 Documentation writers should please make sure documents build
380 successfully before committing to CVS, if possible.
383 How do you update the webserver (i.e. the pages on privoxy.org)?
385 <orderedlist numeration="arabic">
387 First, build the docs by running <computeroutput>make
388 dok</computeroutput>.
391 Run <computeroutput>make webserver</computeroutput> which copies all
392 files from <computeroutput>doc/webserver</computeroutput> to the
393 sourceforge webserver via scp.
399 Finished docs should be occasionally submitted to CVS
400 (<filename>doc/webserver/*/*.html</filename>) so that those without
401 the ability to build them locally, have access to them if needed.
402 This is especially important just prior to a new release! Please
403 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
404 other release specific data in <filename>configure.in</filename> has been
405 updated (this is done just prior to a new release).
408 <!-- ~~~~~ New section ~~~~~ -->
410 <title>Quickstart to Docbook and SGML</title>
412 If you are not familiar with SGML, it is a markup language similar to HTML.
413 Actually, not a mark up language per se, but a language used to define
414 markup languages. In fact, HTML is an SGML application. Both will use
415 <quote>tags</quote> to format text and other content. SGML tags can be much
416 more varied, and flexible, but do much of the same kinds of things. The tags,
417 or <quote>elements</quote>, are definable in SGML. There is no set
418 <quote>standards</quote>. Since we are using
419 <application>Docbook</application>, our tags are those that are defined by
420 <application>Docbook</application>. Much of how the finish document is
421 rendered is determined by the <quote>stylesheets</quote>.
422 The stylesheets determine how each tag gets translated to HTML, or other
427 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
428 will likely generate errors. Example: <literal><title>My
429 Title</title></literal>. They are also case-insensitive, but we
430 strongly suggest using all lower case. This keeps compatibility with
431 [Docbook] <application>XML</application>.
435 Our documents use <quote>sections</quote> for the most part. Sections
436 will be processed into HTML headers (e.g. <literal>h1</literal> for
437 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
438 will use these to also generate the Table of Contents for each doc. Our
439 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
440 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
441 entries, but <literal>sect4</literal> will not. Each section requires
442 a <literal><title></literal> element, and at least one
443 <literal><para></literal>. There is a limit of five section
444 levels in Docbook, but generally three should be sufficient for our
449 Some common elements that you likely will use:
455 <emphasis><para></para></emphasis>, paragraph delimiter. Most
456 text needs to be within paragraph elements (there are some exceptions).
459 <emphasis><emphasis></emphasis></emphasis>, the stylesheets
463 <emphasis><filename></filename></emphasis>, files and directories.
466 <emphasis><command></command></emphasis>, command examples.
469 <emphasis><literallayout></literallayout></emphasis>, like
470 <literal><pre></literal>, more or less.
473 <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
476 <emphasis><listitem></listitem></emphasis>, member of the above.
479 <emphasis><screen></screen></emphasis>, screen output, implies
480 <literal><literallayout></literal>.
483 <emphasis><ulink url="example.com"></ulink></emphasis>, like
484 HTML <literal><a></literal> tag.
487 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
493 Look at any of the existing docs for examples of all these and more.
497 You might also find <quote><ulink
498 url="http://opensource.bureau-cornavin.com/crash-course/index.html">Writing Documentation
499 Using DocBook - A Crash Course</ulink></quote> useful.
503 <!-- ~~~~~ New section ~~~~~ -->
504 <sect2 id="docstyle">
505 <title><application>Privoxy</application> Documentation Style</title>
507 It will be easier if everyone follows a similar writing style. This
508 just makes it easier to read what someone else has written if it
509 is all done in a similar fashion.
518 All tags should be lower case.
523 Tags delimiting a <emphasis>block</emphasis> of text (even small
524 blocks) should be on their own line. Like:
530 Tags marking individual words, or few words, should be in-line:
532 Just to <emphasis>emphasize</emphasis>, some text goes here.
538 Tags should be nested and step indented for block text like: (except
545 Some text goes here in our list example.
548 </itemizedlist>
551 This makes it easier to find the text amongst the tags ;-)
556 Use white space to separate logical divisions within a document,
557 like between sections. Running everything together consistently
558 makes it harder to read and work on.
563 Do not hesitate to make comments. Comments can either use the
564 <comment> element, or the <!-- --> style comment
565 familiar from HTML. (Note in Docbook v4.x <comment> is
566 replaced by <remark>.)
571 We have an international audience. Refrain from slang, or English
572 idiosyncrasies (too many to list :). Humor also does not translate
578 Try to keep overall line lengths in source files to 80 characters or less
579 for obvious reasons. This is not always possible, with lengthy URLs for
585 Our documents are available in differing formats. Right now, they
586 are just plain text and/or HTML, but others are always a
587 future possibility. Be careful with URLs (<ulink>), and avoid
591 My favorite site is <ulink url="http://example.com">here</ulink>.
594 This will render as <quote>My favorite site is here</quote>, which is
595 not real helpful in a text doc. Better like this:
598 My favorite site is <ulink url="http://example.com">example.com</ulink>.
603 All documents should be spell checked occasionally.
604 <application>aspell</application> can check SGML with the
605 <literal>-H</literal> option. (<application>ispell</application> I think
616 <!-- ~~~~~ New section ~~~~~ -->
618 <sect2><title>Privoxy Custom Entities</title>
620 <application>Privoxy</application> documentation is using
621 a number of customized <quote>entities</quote> to facilitate
622 documentation maintenance.
625 We are using a set of <quote>boilerplate</quote> files with generic text,
626 that is used by multiple docs. This way we can write something once, and use
627 it repeatedly without having to re-write the same content over and over again.
628 If editing such a file, keep in mind that it should be
629 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
630 contexts without additional modifications.
633 We are also using what <application>Docbook</application> calls
634 <quote>internal entities</quote>. These are like variables in
635 programming. Well, sort of. For instance, we have the
636 <literal>p-version</literal> entity that contains the current
637 <application>Privoxy</application> version string. You are strongly
638 encouraged to use these where possible. Some of these obviously
639 require re-setting with each release (done by the Makefile). A sampling of
640 custom entities are listed below. See any of the main docs for examples.
647 Re- <quote>boilerplate</quote> text entities are defined like:
650 <literal><!entity supported SYSTEM "supported.sgml"></literal>
653 In this example, the contents of the file,
654 <filename>supported.sgml</filename> is available for inclusion anywhere
655 in the doc. To make this happen, just reference the now defined
656 entity: <literal>&supported;</literal> (starts with an ampersand
657 and ends with a semi-colon), and the contents will be dumped into
658 the finished doc at that point.
663 Commonly used <quote>internal entities</quote>:
667 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
668 version string, e.g. <quote>&p-version;</quote>.
671 <emphasis>p-status</emphasis>: the project status, either
672 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
675 <emphasis>p-not-stable</emphasis>: use to conditionally include
676 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
679 <emphasis>p-stable</emphasis>: just the opposite.
682 <emphasis>p-text</emphasis>: this doc is only generated as text.
689 There are others in various places that are defined for a specific
690 purpose. Read the source!
697 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
698 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
700 <!-- ~~~~~ New section ~~~~~ -->
701 <sect1 id="coding"><title>Coding Guidelines</title>
703 <sect2 id="s1"><title>Introduction</title>
705 <para>This set of standards is designed to make our lives easier. It is
706 developed with the simple goal of helping us keep the "new and improved
707 <application>Privoxy</application>" consistent and reliable. Thus making
708 maintenance easier and increasing chances of success of the
711 <para>And that of course comes back to us as individuals. If we can
712 increase our development and product efficiencies then we can solve more
713 of the request for changes/improvements and in general feel good about
714 ourselves. ;-></para>
718 <sect2 id="s2"><title>Using Comments</title>
721 <sect3 id="s3"><title>Comment, Comment, Comment</title>
723 <para><emphasis>Explanation:</emphasis></para>
725 <para>Comment as much as possible without commenting the obvious.
726 For example do not comment "variable_a is equal to variable_b".
727 Instead explain why variable_a should be equal to the variable_b.
728 Just because a person can read code does not mean they will
729 understand why or what is being done. A reader may spend a lot
730 more time figuring out what is going on when a simple comment
731 or explanation would have prevented the extra research. Please
732 help your fellow Privoxy developers out!</para>
734 <para>The comments will also help justify the intent of the code.
735 If the comment describes something different than what the code
736 is doing then maybe a programming error is occurring.</para>
738 <para><emphasis>Example:</emphasis></para>
740 /* if page size greater than 1k ... */
741 if (page_length() > 1024)
743 ... "block" the page up ...
746 /* if page size is small, send it in blocks */
747 if (page_length() > 1024)
749 ... "block" the page up ...
752 This demonstrates 2 cases of "what not to do". The first is a
753 "syntax comment". The second is a comment that does not fit what
754 is actually being done.
760 <sect3 id="s4"><title>Use blocks for comments</title>
762 <para><emphasis>Explanation:</emphasis></para>
764 <para>Comments can help or they can clutter. They help when they
765 are differentiated from the code they describe. One line
766 comments do not offer effective separation between the comment
767 and the code. Block identifiers do, by surrounding the code
768 with a clear, definable pattern.</para>
770 <para><emphasis>Example:</emphasis></para>
772 /*********************************************************************
773 * This will stand out clearly in your code!
774 *********************************************************************/
775 if (this_variable == that_variable)
777 do_something_very_important();
781 /* unfortunately, this may not */
782 if (this_variable == that_variable)
784 do_something_very_important();
788 if (this_variable == that_variable) /* this may not either */
790 do_something_very_important();
793 <para><emphasis>Exception:</emphasis></para>
795 <para>If you are trying to add a small logic comment and do not
796 wish to "disrupt" the flow of the code, feel free to use a 1
797 line comment which is NOT on the same line as the code.</para>
803 <sect3 id="s5"><title>Keep Comments on their own line</title>
805 <para><emphasis>Explanation:</emphasis></para>
807 <para>It goes back to the question of readability. If the comment
808 is on the same line as the code it will be harder to read than
809 the comment that is on its own line.</para>
811 <para>There are three exceptions to this rule, which should be
812 violated freely and often: during the definition of variables,
813 at the end of closing braces, when used to comment
816 <para><emphasis>Example:</emphasis></para>
818 /*********************************************************************
819 * This will stand out clearly in your code,
820 * But the second example won't.
821 *********************************************************************/
822 if (this_variable == this_variable)
824 do_something_very_important();
827 if (this_variable == this_variable) /*can you see me?*/
829 do_something_very_important(); /*not easily*/
833 /*********************************************************************
834 * But, the encouraged exceptions:
835 *********************************************************************/
836 int urls_read = 0; /* # of urls read + rejected */
837 int urls_rejected = 0; /* # of urls rejected */
841 do_something_very_important();
845 short do_something_very_important(
846 short firstparam, /* represents something */
847 short nextparam /* represents something else */ )
851 } /* -END- do_something_very_important */
856 <sect3 id="s6"><title>Comment each logical step</title>
858 <para><emphasis>Explanation:</emphasis></para>
860 <para>Logical steps should be commented to help others follow the
861 intent of the written code and comments will make the code more
864 <para>If you have 25 lines of code without a comment, you should
865 probably go back into it to see where you forgot to put
868 <para>Most "for", "while", "do", etc... loops _probably_ need a
869 comment. After all, these are usually major logic
876 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
878 <para><emphasis>Explanation:</emphasis></para>
880 <para>A reader of the code should be able to look at the comments
881 just prior to the beginning of a function and discern the
882 reason for its existence and the consequences of using it. The
883 reader should not have to read through the code to determine if
884 a given function is safe for a desired use. The proper
885 information thoroughly presented at the introduction of a
886 function not only saves time for subsequent maintenance or
887 debugging, it more importantly aids in code reuse by allowing a
888 user to determine the safety and applicability of any function
889 for the problem at hand. As a result of such benefits, all
890 functions should contain the information presented in the
891 addendum section of this document.</para>
897 <sect3 id="s8"><title>Comment at the end of braces if the
898 content is more than one screen length</title>
900 <para><emphasis>Explanation:</emphasis></para>
902 <para>Each closing brace should be followed on the same line by a
903 comment that describes the origination of the brace if the
904 original brace is off of the screen, or otherwise far away from
905 the closing brace. This will simplify the debugging,
906 maintenance, and readability of the code.</para>
908 <para>As a suggestion , use the following flags to make the
909 comment and its brace more readable:</para>
911 <para>use following a closing brace: } /* -END- if() or while ()
914 <para><emphasis>Example:</emphasis></para>
918 do_something_very_important();
919 ...some long list of commands...
920 } /* -END- if x is 1 */
926 do_something_very_important();
927 ...some long list of commands...
928 } /* -END- if (1 == X) */
934 <sect2 id="s9"><title>Naming Conventions</title>
938 <sect3 id="s10"><title>Variable Names</title>
940 <para><emphasis>Explanation:</emphasis></para>
942 <para>Use all lowercase, and separate words via an underscore
943 ('_'). Do not start an identifier with an underscore. (ANSI C
944 reserves these for use by the compiler and system headers.) Do
945 not use identifiers which are reserved in ANSI C++. (E.g.
946 template, class, true, false, ...). This is in case we ever
947 decide to port Privoxy to C++.</para>
949 <para><emphasis>Example:</emphasis></para>
951 int ms_iis5_hack = 0;</programlisting>
953 <para><emphasis>Instead of:</emphasis></para>
957 int msiis5hack = 0; int msIis5Hack = 0;
965 <sect3 id="s11"><title>Function Names</title>
967 <para><emphasis>Explanation:</emphasis></para>
969 <para>Use all lowercase, and separate words via an underscore
970 ('_'). Do not start an identifier with an underscore. (ANSI C
971 reserves these for use by the compiler and system headers.) Do
972 not use identifiers which are reserved in ANSI C++. (E.g.
973 template, class, true, false, ...). This is in case we ever
974 decide to port Privoxy to C++.</para>
976 <para><emphasis>Example:</emphasis></para>
978 int load_some_file(struct client_state *csp)</programlisting>
980 <para><emphasis>Instead of:</emphasis></para>
984 int loadsomefile(struct client_state *csp)
985 int loadSomeFile(struct client_state *csp)
993 <sect3 id="s12"><title>Header file prototypes</title>
995 <para><emphasis>Explanation:</emphasis></para>
997 <para>Use a descriptive parameter name in the function prototype
998 in header files. Use the same parameter name in the header file
999 that you use in the c file.</para>
1001 <para><emphasis>Example:</emphasis></para>
1003 (.h) extern int load_aclfile(struct client_state *csp);
1004 (.c) int load_aclfile(struct client_state *csp)</programlisting>
1006 <para><emphasis>Instead of:</emphasis>
1008 (.h) extern int load_aclfile(struct client_state *); or
1009 (.h) extern int load_aclfile();
1010 (.c) int load_aclfile(struct client_state *csp)
1018 <sect3 id="s13"><title>Enumerations, and #defines</title>
1020 <para><emphasis>Explanation:</emphasis></para>
1022 <para>Use all capital letters, with underscores between words. Do
1023 not start an identifier with an underscore. (ANSI C reserves
1024 these for use by the compiler and system headers.)</para>
1026 <para><emphasis>Example:</emphasis></para>
1028 (enumeration) : enum Boolean {FALSE, TRUE};
1029 (#define) : #define DEFAULT_SIZE 100;</programlisting>
1031 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
1032 that toggle a feature in the preprocessor: FEATURE_>, where
1033 > is a short (preferably 1 or 2 word) description.</para>
1035 <para><emphasis>Example:</emphasis></para>
1037 #define FEATURE_FORCE 1
1039 #ifdef FEATURE_FORCE
1040 #define FORCE_PREFIX blah
1041 #endif /* def FEATURE_FORCE */
1046 <sect3 id="s14"><title>Constants</title>
1048 <para><emphasis>Explanation:</emphasis></para>
1050 <para>Spell common words out entirely (do not remove vowels).</para>
1052 <para>Use only widely-known domain acronyms and abbreviations.
1053 Capitalize all letters of an acronym.</para>
1055 <para>Use underscore (_) to separate adjacent acronyms and
1056 abbreviations. Never terminate a name with an underscore.</para>
1058 <para><emphasis>Example:</emphasis></para>
1060 #define USE_IMAGE_LIST 1</programlisting>
1062 <para><emphasis>Instead of:</emphasis></para>
1066 #define USE_IMG_LST 1 or
1067 #define _USE_IMAGE_LIST 1 or
1068 #define USE_IMAGE_LIST_ 1 or
1069 #define use_image_list 1 or
1070 #define UseImageList 1
1080 <sect2 id="s15"><title>Using Space</title>
1084 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1086 <para><emphasis>Explanation:</emphasis></para>
1088 <para>The brace needs to be on a line all by itself, not at the
1089 end of the statement. Curly braces should line up with the
1090 construct that they're associated with. This practice makes it
1091 easier to identify the opening and closing braces for a
1094 <para><emphasis>Example:</emphasis></para>
1101 <para><emphasis>Instead of:</emphasis></para>
1103 <para>if (this == that) { ... }</para>
1107 <para>if (this == that) { ... }</para>
1109 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1110 inside a loop, and it is trivial, i.e. it tests for a
1111 condition that is obvious from the purpose of the block,
1112 one-liners as above may optically preserve the loop structure
1113 and make it easier to read.</para>
1115 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1117 <para><emphasis>Example exception:</emphasis></para>
1119 while (more lines are read)
1121 /* Please document what is/is not a comment line here */
1122 if (it's a comment) continue;
1130 <sect3 id="s17"><title>ALL control statements should have a
1133 <para><emphasis>Explanation:</emphasis></para>
1135 <para>Using braces to make a block will make your code more
1136 readable and less prone to error. All control statements should
1137 have a block defined.</para>
1139 <para><emphasis>Example:</emphasis></para>
1144 do_something_else();
1147 <para><emphasis>Instead of:</emphasis></para>
1149 <para>if (this == that) do_something(); do_something_else();</para>
1153 <para>if (this == that) do_something();</para>
1155 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1156 in a manner other than that which the developer desired (per
1157 indentation). Using code braces would have prevented this
1158 "feature". The "explanation" and "exception" from the point
1159 above also applies.</para>
1165 <sect3 id="s18"><title>Do not belabor/blow-up boolean
1168 <para><emphasis>Example:</emphasis></para>
1170 structure->flag = (condition);</programlisting>
1172 <para><emphasis>Instead of:</emphasis></para>
1174 <para>if (condition) { structure->flag = 1; } else {
1175 structure->flag = 0; }</para>
1177 <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1178 is wordy and inefficient. Please assume that any developer new
1179 to the project has at least a "good" knowledge of C/C++. (Hope
1180 I do not offend by that last comment ... 8-)</para>
1186 <sect3 id="s19"><title>Use white space freely because it is
1189 <para><emphasis>Explanation:</emphasis></para>
1191 <para>Make it readable. The notable exception to using white space
1192 freely is listed in the next guideline.</para>
1194 <para><emphasis>Example:</emphasis></para>
1196 int first_value = 0;
1198 int another_value = 0;
1199 int this_variable = 0;
1204 <sect3 id="s20"><title>Don't use white space around structure
1207 <para><emphasis>Explanation:</emphasis></para>
1209 <para>- structure pointer operator ( "->" ) - member operator (
1210 "." ) - functions and parentheses</para>
1212 <para>It is a general coding practice to put pointers, references,
1213 and function parentheses next to names. With spaces, the
1214 connection between the object and variable/function name is not
1217 <para><emphasis>Example:</emphasis></para>
1221 function_name();</programlisting>
1223 <para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
1224 function_name ();</para>
1230 <sect3 id="s21"><title>Make the last brace of a function stand
1233 <para><emphasis>Example:</emphasis></para>
1235 int function1( ... )
1240 } /* -END- function1 */
1243 int function2( ... )
1245 } /* -END- function2 */
1248 <para><emphasis>Instead of:</emphasis></para>
1250 <para>int function1( ... ) { ...code... return(ret_code); } int
1251 function2( ... ) { }</para>
1253 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1254 lines afterward. This makes the end of function standout to
1255 the most casual viewer. Although function comments help
1256 separate functions, this is still a good coding practice. In
1257 fact, I follow these rules when using blocks in "for", "while",
1258 "do" loops, and long if {} statements too. After all whitespace
1261 <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1262 lines. Enforced is the end of function comments.</para>
1268 <sect3 id="s22"><title>Use 3 character indentions</title>
1270 <para><emphasis>Explanation:</emphasis></para>
1272 <para>If some use 8 character TABs and some use 3 character TABs,
1273 the code can look *very* ragged. So use 3 character indentions
1274 only. If you like to use TABs, pass your code through a filter
1275 such as "expand -t3" before checking in your code.</para>
1277 <para><emphasis>Example:</emphasis></para>
1279 static const char * const url_code_map[256] =
1285 int function1( ... )
1293 return HOW_DID_YOU_GET_HERE;
1296 return NEVER_GETS_HERE;
1305 <sect2 id="s23"><title>Initializing</title>
1309 <sect3 id="s24"><title>Initialize all variables</title>
1311 <para><emphasis>Explanation:</emphasis></para>
1313 <para>Do not assume that the variables declared will not be used
1314 until after they have been assigned a value somewhere else in
1315 the code. Remove the chance of accidentally using an unassigned
1318 <para><emphasis>Example:</emphasis></para>
1322 struct *ptr = NULL;</programlisting>
1324 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1325 message says you are trying to access memory address 00000000
1326 and not 129FA012; or array_ptr[20] causes a SIGSEV vs.
1327 array_ptr[0].</para>
1329 <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1330 variable is assigned a value "shortly after" declaration.</para>
1336 <sect2 id="s25"><title>Functions</title>
1340 <sect3 id="s26"><title>Name functions that return a boolean as a
1343 <para><emphasis>Explanation:</emphasis></para>
1345 <para>Value should be phrased as a question that would logically
1346 be answered as a true or false statement</para>
1348 <para><emphasis>Example:</emphasis></para>
1350 should_we_block_this();
1351 contains_an_image();
1352 is_web_page_blank();
1357 <sect3 id="s27"><title>Always specify a return type for a
1360 <para><emphasis>Explanation:</emphasis></para>
1362 <para>The default return for a function is an int. To avoid
1363 ambiguity, create a return for a function when the return has a
1364 purpose, and create a void return type if the function does not
1365 need to return anything.</para>
1371 <sect3 id="s28"><title>Minimize function calls when iterating by
1372 using variables</title>
1374 <para><emphasis>Explanation:</emphasis></para>
1376 <para>It is easy to write the following code, and a clear argument
1377 can be made that the code is easy to understand:</para>
1379 <para><emphasis>Example:</emphasis></para>
1381 for (size_t cnt = 0; cnt < block_list_length(); cnt++)
1386 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1387 each and every iteration. This increases the overhead in the
1388 program, because the compiler has to look up the function each
1389 time, call it, and return a value. Depending on what occurs in
1390 the block_list_length() call, it might even be creating and
1391 destroying structures with each iteration, even though in each
1392 case it is comparing "cnt" to the same value, over and over.
1393 Remember too - even a call to block_list_length() is a function
1394 call, with the same overhead.</para>
1396 <para>Instead of using a function call during the iterations,
1397 assign the value to a variable, and evaluate using the
1400 <para><emphasis>Example:</emphasis></para>
1402 size_t len = block_list_length();
1404 for (size_t cnt = 0; cnt < len; cnt++)
1409 <para><emphasis>Exceptions:</emphasis> if the value of block_list_length()
1410 *may* change or could *potentially* change, then you must code the
1411 function call in the for/while loop.</para>
1417 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1419 <para><emphasis>Explanation:</emphasis></para>
1421 <para>This allows a developer to define a const pointer and call
1422 your function. If your function does not have the const
1423 keyword, we may not be able to use your function. Consider
1424 strcmp, if it were defined as: extern int strcmp(char *s1,
1427 <para>I could then not use it to compare argv's in main: int
1428 main(int argc, const char *argv[]) { strcmp(argv[0], "privoxy");
1431 <para>Both these pointers are *const*! If the c runtime library
1432 maintainers do it, we should too.</para>
1438 <sect3 id="s30"><title>Pass and Return by Value</title>
1440 <para><emphasis>Explanation:</emphasis></para>
1442 <para>Most structures cannot fit onto a normal stack entry (i.e.
1443 they are not 4 bytes or less). Aka, a function declaration
1444 like: int load_aclfile(struct client_state csp)</para>
1446 <para>would not work. So, to be consistent, we should declare all
1447 prototypes with "pass by value": int load_aclfile(struct
1448 client_state *csp)</para>
1454 <sect3 id="s31"><title>Names of include files</title>
1456 <para><emphasis>Explanation:</emphasis></para>
1458 <para>Your include statements should contain the file name without
1459 a path. The path should be listed in the Makefile, using -I as
1460 processor directive to search the indicated paths. An exception
1461 to this would be for some proprietary software that utilizes a
1462 partial path to distinguish their header files from system or
1463 other header files.</para>
1465 <para><emphasis>Example:</emphasis></para>
1467 #include <iostream.h> /* This is not a local include */
1468 #include "config.h" /* This IS a local include */
1471 <para><emphasis>Exception:</emphasis></para>
1475 /* This is not a local include, but requires a path element. */
1476 #include <sys/fileName.h>
1480 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1481 without a _very_ good reason. This duplicates the #include
1482 "file.h" behavior.</para>
1488 <sect3 id="s32"><title>Provide multiple inclusion
1491 <para><emphasis>Explanation:</emphasis></para>
1493 <para>Prevents compiler and linker errors resulting from
1494 redefinition of items.</para>
1496 <para>Wrap each header file with the following syntax to prevent
1497 multiple inclusions of the file. Of course, replace PROJECT_H
1498 with your file name, with "." Changed to "_", and make it
1501 <para><emphasis>Example:</emphasis></para>
1503 #ifndef PROJECT_H_INCLUDED
1504 #define PROJECT_H_INCLUDED
1506 #endif /* ndef PROJECT_H_INCLUDED */
1511 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1513 <para><emphasis>Explanation:</emphasis></para>
1515 <para>If our headers are included from C++, they must declare our
1516 functions as `extern "C"`. This has no cost in C, but increases
1517 the potential re-usability of our code.</para>
1519 <para><emphasis>Example:</emphasis></para>
1524 #endif /* def __cplusplus */
1526 ... function definitions here ...
1530 #endif /* def __cplusplus */
1535 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1536 Declaration Instead of Includes</title>
1538 <para><emphasis>Explanation:</emphasis></para>
1540 <para>Useful in headers that include pointers to other struct's.
1541 Modifications to excess header files may cause needless
1544 <para><emphasis>Example:</emphasis></para>
1546 /*********************************************************************
1547 * We're avoiding an include statement here!
1548 *********************************************************************/
1550 extern file_list *xyz;</programlisting>
1552 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1553 pointer), then including the proper header file is necessary.
1554 If you only want to prototype a pointer, however, the header
1555 file is unnecessary.</para>
1557 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1563 <sect2 id="s35"><title>General Coding Practices</title>
1567 <sect3 id="s36"><title>Turn on warnings</title>
1569 <para><emphasis>Explanation</emphasis></para>
1571 <para>Compiler warnings are meant to help you find bugs. You
1572 should turn on as many as possible. With GCC, the switch is
1573 "-Wall". Try and fix as many warnings as possible.</para>
1579 <sect3 id="s37"><title>Provide a default case for all switch
1582 <para><emphasis>Explanation:</emphasis></para>
1584 <para>What you think is guaranteed is never really guaranteed. The
1585 value that you don't think you need to check is the one that
1586 someday will be passed. So, to protect yourself from the
1587 unknown, always have a default step in a switch statement.</para>
1589 <para><emphasis>Example:</emphasis></para>
1591 switch (hash_string(cmd))
1593 case hash_actions_file:
1603 ... anomaly code goes here ...
1604 continue; / break; / exit( 1 ); / etc ...
1606 } /* end switch (hash_string(cmd)) */</programlisting>
1608 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1609 are obviously exempt from this point. Of note, most of the
1610 WIN32 code calls `DefWindowProc' after the switch statement.
1611 This API call *should* be included in a default statement.</para>
1613 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1614 as a robust programming issue. The "anomaly code goes here" may
1615 be no more than a print to the STDERR stream (as in
1616 load_config). Or it may really be an abort condition.</para>
1618 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1624 <sect3 id="s38"><title>Try to avoid falling through cases in a
1625 switch statement.</title>
1627 <para><emphasis>Explanation:</emphasis></para>
1629 <para>In general, you will want to have a 'break' statement within
1630 each 'case' of a switch statement. This allows for the code to
1631 be more readable and understandable, and furthermore can
1632 prevent unwanted surprises if someone else later gets creative
1633 and moves the code around.</para>
1635 <para>The language allows you to plan the fall through from one
1636 case statement to another simply by omitting the break
1637 statement within the case statement. This feature does have
1638 benefits, but should only be used in rare cases. In general,
1639 use a break statement for each case statement.</para>
1641 <para>If you choose to allow fall through, you should comment both
1642 the fact of the fall through and reason why you felt it was
1649 <sect3 id="s39"><title>Use 'long' or 'short' Instead of
1652 <para><emphasis>Explanation:</emphasis></para>
1654 <para>On 32-bit platforms, int usually has the range of long. On
1655 16-bit platforms, int has the range of short.</para>
1657 <para><emphasis>Status:</emphasis> open-to-debate. In the case of most FSF
1658 projects (including X/GNU-Emacs), there are typedefs to int4,
1659 int8, int16, (or equivalence ... I forget the exact typedefs
1660 now). Should we add these to IJB now that we have a "configure"
1667 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1669 <para><emphasis>Explanation:</emphasis></para>
1671 <para>The type of size_t varies across platforms. Do not make
1672 assumptions about whether it is signed or unsigned, or about
1673 how long it is. Do not compare a size_t against another
1674 variable of a different type (or even against a constant)
1675 without casting one of the values.</para>
1681 <sect3 id="s41"><title>Declare each variable and struct on its
1684 <para><emphasis>Explanation:</emphasis></para>
1686 <para>It can be tempting to declare a series of variables all on
1687 one line. Don't.</para>
1689 <para><emphasis>Example:</emphasis></para>
1693 long c = 0;</programlisting>
1695 <para><emphasis>Instead of:</emphasis></para>
1697 <para>long a, b, c;</para>
1699 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1700 individual variables - easier to add new variables without
1701 messing up the original ones - when searching on a variable to
1702 find its type, there is less clutter to "visually"
1705 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1706 variables or other trivial variables; feel free to declare them
1707 on one line. You should, although, provide a good comment on
1708 their functions.</para>
1710 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1716 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1718 <para><emphasis>Explanation:</emphasis></para>
1720 <para>Create a local struct (on the stack) if the variable will
1721 live and die within the context of one function call.</para>
1723 <para>Only "malloc" a struct (on the heap) if the variable's life
1724 will extend beyond the context of one function call.</para>
1726 <para><emphasis>Example:</emphasis></para>
1728 If a function creates a struct and stores a pointer to it in a
1729 list, then it should definitely be allocated via `malloc'.
1734 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1735 Responsible for Ensuring 'free'</title>
1737 <para><emphasis>Explanation:</emphasis></para>
1739 <para>If you have to "malloc" an instance, you are responsible for
1740 insuring that the instance is `free'd, even if the deallocation
1741 event falls within some other programmer's code. You are also
1742 responsible for ensuring that deletion is timely (i.e. not too
1743 soon, not too late). This is known as "low-coupling" and is a
1744 "good thing (tm)". You may need to offer a
1745 free/unload/destructor type function to accommodate this.</para>
1747 <para><emphasis>Example:</emphasis></para>
1749 int load_re_filterfile(struct client_state *csp) { ... }
1750 static void unload_re_filterfile(void *f) { ... }</programlisting>
1752 <para><emphasis>Exceptions:</emphasis></para>
1754 <para>The developer cannot be expected to provide `free'ing
1755 functions for C run-time library functions ... such as
1758 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1759 standard is for allocating and freeing data structures (complex
1766 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1767 and in order</title>
1769 <para><emphasis>Explanation:</emphasis></para>
1771 <para>I have ordered all of the "blocker" file code to be in alpha
1772 order. It is easier to add/read new blockers when you expect a
1773 certain order.</para>
1775 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1776 places by POPUP tests coming before PCRS tests. But since
1777 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1778 it should come first.</para>
1784 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1785 existing code, use FIXME or XXX</title>
1787 <para><emphasis>Explanation:</emphasis></para>
1789 <para>If you have enough confidence in new code or confidence in
1790 your changes, but are not *quite* sure of the repercussions,
1793 <para>/* FIXME: this code has a logic error on platform XYZ, *
1794 attempting to fix */ #ifdef PLATFORM ...changed code here...
1799 <para>/* FIXME: I think the original author really meant this...
1800 */ ...changed code here...</para>
1804 <para>/* FIXME: new code that *may* break something else... */
1805 ...new code here...</para>
1807 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1808 be a "good thing (tm)", it will be easier to identify and
1809 include in the project (or conversely exclude from the
1817 <sect2 id="s46"><title>Addendum: Template for files and function
1818 comment blocks:</title>
1820 <para><emphasis>Example for file comments:</emphasis></para>
1822 const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
1823 /*********************************************************************
1825 * File : $S<!-- Break CVS Substitution -->ource$
1827 * Purpose : (Fill me in with a good description!)
1829 * Copyright : Written by and Copyright (C) 2001-2009
1830 * the Privoxy team. http://www.privoxy.org/
1832 * This program is free software; you can redistribute it
1833 * and/or modify it under the terms of the GNU General
1834 * Public License as published by the Free Software
1835 * Foundation; either version 2 of the License, or (at
1836 * your option) any later version.
1838 * This program is distributed in the hope that it will
1839 * be useful, but WITHOUT ANY WARRANTY; without even the
1840 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1841 * PARTICULAR PURPOSE. See the GNU General Public
1842 * License for more details.
1844 * The GNU General Public License should be included with
1845 * this file. If not, you can view it at
1846 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1847 * or write to the Free Software Foundation, Inc.,
1848 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1851 *********************************************************************/
1856 ...necessary include files for us to do our work...
1858 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1861 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1862 added to the "show-proxy-args" page. If this is a brand new
1863 creation by you, you are free to change the "Copyright" section
1864 to represent the rights you wish to maintain.</para>
1866 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1867 after the comment flower box is handy for (X|GNU)Emacs users to
1868 skip the verbiage and get to the heart of the code (via
1869 `forward-page' and `backward-page'). Please include it if you
1872 <para><emphasis>Example for file header comments:</emphasis></para>
1876 #define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
1877 /*********************************************************************
1879 * File : $S<!-- Break CVS Substitution -->ource$
1881 * Purpose : (Fill me in with a good description!)
1883 * Copyright : Written by and Copyright (C) 2001-2009
1884 * the Privoxy team. http://www.privoxy.org/
1886 * This program is free software; you can redistribute it
1887 * and/or modify it under the terms of the GNU General
1888 * Public License as published by the Free Software
1889 * Foundation; either version 2 of the License, or (at
1890 * your option) any later version.
1892 * This program is distributed in the hope that it will
1893 * be useful, but WITHOUT ANY WARRANTY; without even the
1894 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1895 * PARTICULAR PURPOSE. See the GNU General Public
1896 * License for more details.
1898 * The GNU General Public License should be included with
1899 * this file. If not, you can view it at
1900 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1901 * or write to the Free Software Foundation, Inc.,
1902 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1905 *********************************************************************/
1908 #include "project.h"
1914 ... function headers here ...
1917 /* Revision control strings from this header and associated .c file */
1918 extern const char FILENAME_rcs[];
1919 extern const char FILENAME_h_rcs[];
1926 #endif /* ndef _FILENAME_H */
1935 <para><emphasis>Example for function comments:</emphasis></para>
1937 /*********************************************************************
1939 * Function : FUNCTION_NAME
1941 * Description : (Fill me in with a good description!)
1944 * 1 : param1 = pointer to an important thing
1945 * 2 : x = pointer to something else
1947 * Returns : 0 => Ok, everything else is an error.
1949 *********************************************************************/
1950 int FUNCTION_NAME(void *param1, const char *x)
1958 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1959 able to parse our code to create a "self-documenting" web
1966 <!-- ~~~~~ New section ~~~~~ -->
1967 <sect1 id="testing"><title>Testing Guidelines</title>
1971 <!-- ~~~~~ New section ~~~~~ -->
1972 <sect2 id="testing-plan"><title>Testplan for releases</title>
1974 Explain release numbers. major, minor. developer releases. etc.
1976 <orderedlist numeration="arabic">
1978 Remove any existing rpm with rpm -e
1981 Remove any file that was left over. This includes (but is not limited to)
1983 <listitem><para>/var/log/privoxy</para></listitem>
1984 <listitem><para>/etc/privoxy</para></listitem>
1985 <listitem><para>/usr/sbin/privoxy</para></listitem>
1986 <listitem><para>/etc/init.d/privoxy</para></listitem>
1987 <listitem><para>/usr/doc/privoxy*</para></listitem>
1991 Install the rpm. Any error messages?
1993 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1994 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1995 autostart work?</para></listitem>
1996 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1997 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
2002 <!-- ~~~~~ New section ~~~~~ -->
2003 <sect2 id="testing-report"><title>Test reports</title>
2005 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
2006 at sourceforge. Three simple steps:
2009 <listitem><para>Select category: the distribution you test on.</para></listitem>
2010 <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
2011 <listitem><para>Fill the Summary and Detailed Description with something
2012 intelligent (keep it short and precise).</para>
2015 Do not mail to the mailing list (we cannot keep track on issues there).
2021 <!-- ~~~~~ New section ~~~~~ -->
2022 <sect1 id="newrelease"><title>Releasing a New Version</title>
2024 When we release versions of <application>Privoxy</application>,
2025 our work leaves our cozy secret lab and has to work in the cold
2026 RealWorld[tm]. Once it is released, there is no way to call it
2027 back, so it is very important that great care is taken to ensure
2028 that everything runs fine, and not to introduce problems in the
2032 So when releasing a new version, please adhere exactly to the
2033 procedure outlined in this chapter.
2037 The following programs are required to follow this process:
2038 <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
2039 <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
2042 <sect2 id="versionnumbers">
2043 <title>Version numbers</title>
2046 First you need to determine which version number the release will have.
2047 <application>Privoxy</application> version numbers consist of three numbers,
2048 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
2052 X, the version major, is rarely ever changed. It is increased by one if
2053 turning a development branch into stable substantially changes the functionality,
2054 user interface or configuration syntax. Majors 1 and 2 were
2055 <application>Junkbuster</application>, and 3 will be the first stable
2056 <application>Privoxy</application> release.
2061 Y, the version minor, represents the branch within the major version.
2062 At any point in time, there are two branches being maintained:
2063 The stable branch, with an even minor, say, 2N, in which no functionality is
2064 being added and only bug-fixes are made, and 2N+1, the development branch, in
2065 which the further development of <application>Privoxy</application> takes
2067 This enables us to turn the code upside down and inside out, while at the same time
2068 providing and maintaining a stable version.
2069 The minor is reset to zero (and one) when the major is incremented. When a development
2070 branch has matured to the point where it can be turned into stable, the old stable branch
2071 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2072 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2077 Z, the point or sub version, represents a release of the software within a branch.
2078 It is therefore incremented immediately before each code freeze.
2079 In development branches, only the even point versions correspond to actual releases,
2080 while the odd ones denote the evolving state of the sources on CVS in between.
2081 It follows that Z is odd on CVS in development branches most of the time. There, it gets
2082 increased to an even number immediately before a code freeze, and is increased to an odd
2083 number again immediately thereafter.
2084 This ensures that builds from CVS snapshots are easily distinguished from released versions.
2085 The point version is reset to zero when the minor changes.
2088 Stable branches work a little differently, since there should be
2089 little to no development happening in such branches. Remember,
2090 only bugfixes, which presumably should have had some testing
2091 before being committed. Stable branches will then have their
2092 version reported as <literal>0.0.0</literal>, during that period
2093 between releases when changes are being added. This is to denote
2094 that this code is <emphasis>not for release</emphasis>. Then
2095 as the release nears, the version is bumped according: e.g.
2096 <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
2102 In summary, the main CVS trunk is the development branch where new
2103 features are being worked on for the next stable series. This should
2104 almost always be where the most activity takes place. There is always at
2105 least one stable branch from the trunk, e.g now it is
2106 <literal>3.0</literal>, which is only used to release stable versions.
2107 Once the initial *.0 release of the stable branch has been done, then as a
2108 rule, only bugfixes that have had prior testing should be committed to
2109 the stable branch. Once there are enough bugfixes to justify a new
2110 release, the version of this branch is again incremented Example: 3.0.0
2111 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
2112 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
2113 taking place. If any questions, please post to the devel list
2114 <emphasis>before</emphasis> committing to a stable branch!
2117 Developers should remember too that if they commit a bugfix to the stable
2118 branch, this will more than likely require a separate submission to the
2119 main trunk, since these are separate development trees within CVS. If you
2120 are working on both, then this would require at least two separate check
2121 outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
2122 which is <literal>v_3_0_branch</literal> at the moment).
2127 <sect2 id="beforerelease">
2128 <title>Before the Release: Freeze</title>
2130 The following <emphasis>must be done by one of the
2131 developers</emphasis> prior to each new release.
2137 Make sure that everybody who has worked on the code in the last
2138 couple of days has had a chance to yell <quote>no!</quote> in case
2139 they have pending changes/fixes in their pipelines. Announce the
2140 freeze so that nobody will interfere with last minute changes.
2145 Increment the version number (point from odd to even in development
2146 branches!) in <filename>configure.in</filename>. (RPM spec files
2147 will need to be incremented as well.)
2152 If <filename>default.action</filename> has changed since last
2153 release (i.e. software release or standalone actions file release),
2154 bump up its version info to A.B in this line:
2158 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
2162 Then change the version info in doc/webserver/actions/index.php,
2163 line: '$required_actions_file_version = "A.B";'
2168 All documentation should be rebuild after the version bump.
2169 Finished docs should be then be committed to CVS (for those
2170 without the ability to build these). Some docs may require
2171 rather obscure processing tools. <filename>config</filename>,
2172 the man page (and the html version of the man page), and the PDF docs
2173 fall in this category. REAMDE, the man page, AUTHORS, and config
2174 should all also be committed to CVS for other packagers. The
2175 formal docs should be uploaded to the webserver. See the
2176 Section "Updating the webserver" in this manual for details.
2181 The <citetitle>User Manual</citetitle> is also used for context
2182 sensitive help for the CGI editor. This is version sensitive, so that
2183 the user will get appropriate help for his/her release. So with
2184 each release a fresh version should be uploaded to the webserver
2185 (this is in addition to the main <citetitle>User Manual</citetitle>
2186 link from the main page since we need to keep manuals for various
2187 versions available). The CGI pages will link to something like
2188 <literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. This
2189 will need to be updated for each new release. There is no Makefile
2190 target for this at this time!!! It needs to be done manually.
2195 All developers should look at the <filename>ChangeLog</filename> and
2196 make sure noteworthy changes are referenced.
2201 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2206 Tag all files in CVS with the version number with
2207 <quote><command>cvs tag v_X_Y_Z</command></quote>.
2208 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2213 If the release was in a development branch, increase the point version
2214 from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
2220 On the webserver, copy the user manual to a new top-level directory
2221 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2222 pages, which have the version as a prefix, will go into the right version of the manual.
2223 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2224 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2225 <filename>.</filename> (i.e. dot).
2232 <sect2 id="therelease">
2233 <title>Building and Releasing the Packages</title>
2235 Now the individual packages can be built and released. Note that for
2236 GPL reasons the first package to be released is always the source tarball.
2240 For <emphasis>all</emphasis> types of packages, including the source tarball,
2241 <emphasis>you must make sure that you build from clean sources by exporting
2242 the right version from CVS into an empty directory</emphasis> (just press return when
2243 asked for a password):
2248 mkdir dist # delete or choose different name if it already exists
2250 cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
2251 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2256 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2257 version information after export from CVS. This is to make sure that
2258 all release packages, and with them, all future bug reports, are based
2259 on exactly the same code.
2264 Every significant release of Privoxy has included at least one
2265 package that either had incorrect versions of files, missing files,
2266 or incidental leftovers from a previous build process that gave
2267 unknown numbers of users headaches to try to figure out what was
2268 wrong. PLEASE, make sure you are using pristene sources, and are
2269 following the prescribed process!
2274 Please find additional instructions for the source tarball and the
2275 individual platform dependent binary packages below. And details
2276 on the Sourceforge release process below that.
2279 <sect3 id="pack-guidelines">
2280 <title>Note on Privoxy Packaging</title>
2282 Please keep these general guidelines in mind when putting together
2283 your package. These apply to <emphasis>all</emphasis> platforms!
2289 <application>Privoxy</application> <emphasis>requires</emphasis>
2290 write access to: all <filename>*.action</filename> files, all
2291 logfiles, and the <filename>trust</filename> file. You will
2292 need to determine the best way to do this for your platform.
2297 Please include up to date documentation. At a bare minimum:
2301 <filename>LICENSE</filename> (top-level directory)
2306 <filename>README</filename> (top-level directory)
2311 <filename>AUTHORS</filename> (top-level directory)
2316 <filename>man page</filename> (top-level directory, Unix-like
2322 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2327 <filename>FAQ</filename> (doc/webserver/faq/)
2331 Also suggested: <filename>Developer Manual</filename>
2332 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2333 (top-level directory). <filename>FAQ</filename> and the manuals are
2334 HTML docs. There are also text versions in
2335 <filename>doc/text/</filename> which could conceivably also be
2339 The documentation has been designed such that the manuals are linked
2340 to each other from parallel directories, and should be packaged
2341 that way. <filename>privoxy-index.html</filename> can also be
2342 included and can serve as a focal point for docs and other links of
2343 interest (and possibly renamed to <filename>index.html</filename>).
2344 This should be one level up from the manuals. There is a link also
2345 on this page to an HTMLized version of the man page. To avoid 404 for
2346 this, it is in CVS as
2347 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2348 and should be included along with the manuals. There is also a
2349 css stylesheets that can be included for better presentation:
2350 <filename>p_doc.css</filename>. This should be in the same directory
2351 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2352 the manual directories).
2357 <filename>user.action</filename> and <filename>user.filter</filename>
2358 are designed for local preferences. Make sure these do not get overwritten!
2359 <filename>config</filename> should not be overwritten either. This
2360 has especially important configuration data in it.
2361 <filename>trust</filename> should be left in tact as well.
2366 Other configuration files (<filename>default.action</filename> and
2367 <filename>default.filter</filename>) should be installed as the new
2368 defaults, but all previously installed configuration files should be
2369 preserved as backups. This is just good manners :-) These files are
2370 likely to change between releases and contain important new features
2376 Please check platform specific notes in this doc, if you haven't
2377 done <quote>Privoxy</quote> packaging before for other platform
2378 specific issues. Conversely, please add any notes that you know
2379 are important for your platform (or contact one of the doc
2380 maintainers to do this if you can't).
2385 Packagers should do a <quote>clean</quote> install of their
2386 package after building it. So any previous installs should be
2387 removed first to ensure the integrity of the newly built package.
2388 Then run the package for a while to make sure there are no
2389 obvious problems, before uploading.
2398 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2400 First, <emphasis>make sure that you have freshly exported the right
2401 version into an empty directory</emphasis>. (See "Building and releasing
2402 packages" above). Then run:
2407 autoheader && autoconf && ./configure
2419 To upload the package to Sourceforge, simply issue
2427 Go to the displayed URL and release the file publicly on Sourceforge.
2428 For the change log field, use the relevant section of the
2429 <filename>ChangeLog</filename> file.
2433 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2435 In following text, replace <replaceable class="parameter">dist</replaceable>
2436 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2439 First, <emphasis>make sure that you have freshly exported the right
2440 version into an empty directory</emphasis>. (See "Building and releasing
2444 As the only exception to not changing anything after export from CVS,
2445 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2446 and make sure that the version information and the RPM release number are
2447 correct. The RPM release numbers for each version start at one. Hence it must
2448 be reset to one if this is the first RPM for
2449 <replaceable class="parameter">dist</replaceable> which is built from version
2451 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">file
2452 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2453 release number for that version plus one.
2461 autoheader && autoconf && ./configure
2469 make <replaceable class="parameter">dist</replaceable>-dist
2473 To upload the package to Sourceforge, simply issue
2477 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2481 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2482 RPM release number as determined above.
2483 Go to the displayed URL and release the file publicly on Sourceforge.
2484 Use the release notes and change log from the source tarball package.
2488 <sect3 id="newrelease-os2"><title>OS/2</title>
2490 First, <emphasis>make sure that you have freshly exported the right
2491 version into an empty directory</emphasis>. (See "Building and releasing
2492 packages" above). Then get the OS/2 Setup module:
2496 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
2500 You will need a mix of development tools.
2501 The main compilation takes place with IBM Visual Age C++.
2502 Some ancillary work takes place with GNU tools, available from
2503 various sources like hobbes.nmsu.edu.
2504 Specificially, you will need <filename>autoheader</filename>,
2505 <filename>autoconf</filename> and <filename>sh</filename> tools.
2506 The packaging takes place with WarpIN, available from various sources, including
2507 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2510 Change directory to the <filename>os2setup</filename> directory.
2511 Edit the os2build.cmd file to set the final executable filename.
2516 installExeName='privoxyos2_setup_X.Y.Z.exe'
2520 Next, edit the <filename>IJB.wis</filename> file so the release number matches
2521 in the <filename>PACKAGEID</filename> section:
2525 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2529 You're now ready to build. Run:
2537 You will find the WarpIN-installable executable in the
2538 <filename>./files</filename> directory. Upload this anonymously to
2539 <filename>uploads.sourceforge.net/incoming</filename>, create a release
2540 for it, and you're done. Use the release notes and Change Log from the
2541 source tarball package.
2545 <sect3 id="newrelease-solaris"><title>Solaris</title>
2547 Login to Sourceforge's compilefarm via ssh:
2551 ssh cf.sourceforge.net
2555 Choose the right operating system (not the Debian one).
2556 When logged in, <emphasis>make sure that you have freshly exported the right
2557 version into an empty directory</emphasis>. (See "Building and releasing
2558 packages" above). Then run:
2563 autoheader && autoconf && ./configure
2575 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2576 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2577 to manually upload the archive to Sourceforge's ftp server and release
2578 the file publicly. Use the release notes and Change Log from the
2579 source tarball package.
2583 <sect3 id="newrelease-windows"><title>Windows</title>
2585 You should ensure you have the latest version of Cygwin (from
2586 <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>).
2587 Run the following commands from within a Cygwin bash shell.
2590 First, <emphasis>make sure that you have freshly exported the right
2591 version into an empty directory</emphasis>. (See "Building and releasing
2592 packages" above). Then get the Windows setup module:
2596 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
2600 Then you can build the package. This is fully automated, and is
2601 controlled by <filename>winsetup/GNUmakefile</filename>.
2602 All you need to do is:
2611 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2612 <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
2613 SourceForge. When releasing the package on SourceForge, use the release notes
2614 and Change Log from the source tarball package.
2618 <sect3 id="newrelease-debian"><title>Debian</title>
2620 First, <emphasis>make sure that you have freshly exported the
2621 right version into an empty directory</emphasis>. (See
2622 "Building and releasing packages" above). Then add a log
2623 entry to <filename>debian/changelog</filename>, if it is not
2624 already there, for example by running:
2628 debchange -v &p-version;-&p-status;-1 "New upstream version"
2636 dpkg-buildpackage -rfakeroot -us -uc -b
2641 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2642 which can be uploaded. To upload the package to Sourceforge, simply
2652 <sect3 id="newrelease-macosx"><title>Mac OS X</title>
2654 First, <emphasis>make sure that you have freshly exported the right
2655 version into an empty directory</emphasis>. (See "Building and releasing
2659 There are three modules available in the CVS repository for use on Mac
2660 OS X, though technically only two of them generate a release (the other
2661 can be used to install from source).
2663 <sect4 id="OS-X-OSXPackageBuilder-module">
2664 <title>OSXPackageBuilder module</title>
2666 The OSXPackageBuilder module generates OS X installer packages
2667 supporting all Macs running OS X 10.4 and above. Obtain it from CVS as
2668 follows into a folder parallel to the exported privoxy source:
2670 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
2674 The module contains complete instructions on its usage in the file
2675 <filename>OS X Package Builder HOWTO.txt</filename>.
2678 Once the package(s) have been generated, you can then upload them
2679 directly to the Files section of the Sourceforge project in the
2680 Macintosh (OS X) folder. Each new version release of Privoxy should
2681 have a new subfolder created in which to store its files. Please
2682 ensure that the folder contains a readme file that makes it clear
2683 which package is for whichversion of OS X.
2686 <sect4 id="OS-X-osxsetup-module">
2687 <title>osxsetup module (DEPRECATED)</title>
2689 <emphasis>This module is deprecated since the installer it generates
2690 places all Privoxy files in one folder in a non-standard location, and
2691 supports only Intel Macs running OS X 10.6 or higher.</emphasis>
2694 Check out the module from CVS as follows into a folder parallel to the
2695 exported privoxy source:
2697 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
2710 This will run <filename>autoheader</filename>, <filename>autoconf</filename>
2711 and <filename>configure</filename> as well as <filename>make</filename>.
2712 Finally, it will copy over the necessary files to the ./osxsetup/files
2713 directory for further processing by <filename>PackageMaker</filename>.
2716 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
2717 modify the package name to match the release, and hit the "Create
2718 package" button. If you specify ./Privoxy.pkg as the output package
2719 name, you can then create the distributable zip file with the command:
2723 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2727 You can then upload this file directly to the Files section of the
2728 Sourceforge project in the Macintosh (OS X) folder. Each new version
2729 release of Privoxy should have a new subfolder created in which to
2731 Please ensure that the folder contains a readme file that makes it
2732 clear which version(s) of OS X the package supports.
2735 <sect4 id="OS-X-macsetup-module">
2736 <title>macsetup module</title>
2738 The macsetup module is ideal if you wish to build and install Privoxy
2739 from source on a single machine.
2742 Check out the module from CVS as follows into a folder parallel to the
2743 exported privoxy source:
2745 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
2749 The module contains complete instructions on its usage in its
2750 <filename>README</filename> file. The end result will be the the
2751 exported version of Privoxy installed on the build machine.
2756 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2758 Login to Sourceforge's compile-farm via ssh:
2762 ssh cf.sourceforge.net
2766 Choose the right operating system.
2767 When logged in, <emphasis>make sure that you have freshly exported the right
2768 version into an empty directory</emphasis>. (See "Building and releasing
2769 packages" above). Then run:
2774 autoheader && autoconf && ./configure
2786 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2787 freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
2788 to manually upload the archive to Sourceforge's ftp server and release
2789 the file publicly. Use the release notes and Change Log from the
2790 source tarball package.
2794 <sect3 id="newrelease-hpux"><title>HP-UX 11</title>
2796 First, <emphasis>make sure that you have freshly exported the right
2797 version into an empty directory</emphasis>. (See "Building and releasing
2798 packages" above). Then run:
2803 autoheader && autoconf && ./configure
2811 <sect3 id="newrelease-amiga"><title>Amiga OS</title>
2813 First, <emphasis>make sure that you have freshly exported the right
2814 version into an empty directory</emphasis>. (See "Building and releasing
2815 packages" above). Then run:
2820 autoheader && autoconf && ./configure
2828 <sect3 id="newrelease-aix"><title>AIX</title>
2830 Login to Sourceforge's compilefarm via ssh:
2834 ssh cf.sourceforge.net
2838 Choose the right operating system.
2839 When logged in, <emphasis>make sure that you have freshly exported the right
2840 version into an empty directory</emphasis>. (See "Building and releasing
2841 packages" above). Then run:
2846 autoheader && autoconf && ./configure
2858 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2859 aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
2860 to manually upload the archive to Sourceforge's ftp server and release
2861 the file publicly. Use the release notes and Change Log from the
2862 source tarball package.
2867 <sect2 id="releasing">
2868 <title>Uploading and Releasing Your Package</title>
2870 After the package is ready, it is time to upload it
2871 to SourceForge, and go through the release steps. The upload
2878 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2883 user: <literal>anonymous</literal>
2888 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2894 Or use the <command>make</command> targets as described above.
2897 Once this done go to <ulink
2898 url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
2899 >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
2900 making sure you are logged in. Find your target platform in the
2901 second column, and click <literal>Add Release</literal>. You will
2902 then need to create a new release for your package, using the format
2903 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2907 Now just follow the prompts. Be sure to add any appropriate Release
2908 notes. You should see your freshly uploaded packages in
2909 <quote>Step 2. Add Files To This Release</quote>. Check the
2910 appropriate box(es). Remember at each step to hit the
2911 <quote>Refresh/Submit</quote> buttons! You should now see your
2912 file(s) listed in Step 3. Fill out the forms with the appropriate
2913 information for your platform, being sure to hit <quote>Update</quote>
2914 for each file. If anyone is monitoring your platform, check the
2915 <quote>email</quote> box at the very bottom to notify them of
2916 the new package. This should do it!
2919 If you have made errors, or need to make changes, you can go through
2920 essentially the same steps, but select <literal>Edit Release</literal>,
2921 instead of <literal>Add Release</literal>.
2925 <sect2 id="afterrelease">
2926 <title>After the Release</title>
2928 When all (or: most of the) packages have been uploaded and made available,
2929 send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
2930 mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2932 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
2933 location</ulink>, the release notes and the Changelog. Also, post an
2934 updated News item on the project page Sourceforge, and update the Home
2935 page and docs linked from the Home page (see below). Other news sites
2936 and release oriented sites, such as Freshmeat, should also be notified.
2942 <!-- ~~~~~ New section ~~~~~ -->
2943 <sect1 id="webserver-update"><title>Update the Webserver</title>
2945 The webserver should be updated at least with each stable release. When
2946 updating, please follow these steps to make sure that no broken links,
2947 inconsistent contents or permission problems will occur (as it has many
2948 times in the past!):
2951 If you have changed anything in the stable-branch documentation source
2956 make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
2960 That will generate <filename>doc/webserver/user-manual</filename>,
2961 <filename>doc/webserver/developer-manual</filename>,
2962 <filename>doc/webserver/faq</filename>,
2963 <filename>doc/pdf/*.pdf</filename> and
2964 <filename>doc/webserver/index.html</filename> automatically.
2967 If you changed the manual page sources, generate
2968 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2969 by running <quote><command>make man</command></quote>. (This is
2970 a separate target due to dependencies on some obscure perl scripts
2971 [now in CVS, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
2974 If you want to add new files to the webserver, create them locally in
2975 the <filename>doc/webserver/*</filename> directory (or
2976 create new directories under <filename>doc/webserver</filename>).
2979 Next, commit any changes from the above steps to CVS. All set?
2980 If these are docs in the stable branch, then do:
2988 This will do the upload to <ulink url="http://www.privoxy.org/">the
2989 webserver</ulink> (www.privoxy.org) and ensure all files and directories
2990 there are group writable.
2993 Please do <emphasis>NOT</emphasis> use any other means of transferring
2994 files to the webserver to avoid permission problems. Also, please do not
2995 upload docs from development branches or versions. The publicly posted
2996 docs should be in sync with the last official release.
3000 <!-- ~~~~~ New section ~~~~~ -->
3001 <sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
3002 <!-- Include contacting.sgml -->
3004 <!-- end contacting -->
3008 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
3009 <sect1 id="copyright"><title>Privoxy Copyright, License and History</title>
3011 <!-- Include copyright.sgml -->
3015 <!-- ~~~~~ New section ~~~~~ -->
3016 <sect2><title>License</title>
3017 <!-- Include copyright.sgml: -->
3019 <!-- end copyright -->
3021 <!-- ~ End section ~ -->
3023 <!-- ~~~~~ New section ~~~~~ -->
3024 <sect2><title>History</title>
3025 <!-- Include history.sgml -->
3032 <!-- ~~~~~ New section ~~~~~ -->
3033 <sect1 id="seealso"><title>See also</title>
3034 <!-- Include seealso.sgml -->
3042 This program is free software; you can redistribute it
3043 and/or modify it under the terms of the GNU General
3044 Public License as published by the Free Software
3045 Foundation; either version 2 of the License, or (at
3046 your option) any later version.
3048 This program is distributed in the hope that it will
3049 be useful, but WITHOUT ANY WARRANTY; without even the
3050 implied warranty of MERCHANTABILITY or FITNESS FOR A
3051 PARTICULAR PURPOSE. See the GNU General Public
3052 License for more details.
3054 The GNU General Public License should be included with
3055 this file. If not, you can view it at
3056 http://www.gnu.org/copyleft/gpl.html
3057 or write to the Free Software Foundation, Inc., 59
3058 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3060 $Log: developer-manual.sgml,v $
3061 Revision 2.46 2012/03/20 13:04:54 fabiankeil
3062 IJB is dead, long live Privoxy
3064 Revision 2.45 2012/03/20 13:04:41 fabiankeil
3065 The redhat-dok target no longer exists so there's no point documenting it
3067 Revision 2.44 2012/03/20 13:04:19 fabiankeil
3068 We no longer build PDFs so stop pretending
3070 Revision 2.43 2012/03/20 13:04:03 fabiankeil
3071 Comment out references to multiple branches
3073 We currently don't use any.
3075 Revision 2.42 2012/03/20 13:03:05 fabiankeil
3078 Revision 2.41 2012/03/19 12:56:08 fabiankeil
3081 Revision 2.40 2012/03/18 15:41:49 fabiankeil
3082 Bump entities to 3.0.20 UNRELEASED
3084 Revision 2.39 2012/03/18 01:16:35 diem
3085 Brought OS X section up to date, deprecating the osxsetup module and adding a section referring to the OSXPackageBuilder module
3087 Revision 2.38 2011/12/26 17:05:40 fabiankeil
3088 Bump entities for 3.0.19
3090 Revision 2.37 2011/11/13 17:03:54 fabiankeil
3091 Bump entities for 3.0.18 stable
3093 Revision 2.36 2011/09/04 11:10:12 fabiankeil
3094 Ditch trailing whitespace
3096 Revision 2.35 2011/08/17 10:40:07 fabiankeil
3097 Update the entities.
3099 This commit is chronological out of order.
3101 Revision 2.34 2010/11/06 12:55:48 fabiankeil
3102 Set p-version to 3.0.17
3104 Revision 2.33 2010/02/13 17:38:27 fabiankeil
3105 Update entities for 3.0.16 stable.
3107 Revision 2.32 2009/11/15 14:24:12 fabiankeil
3108 Prepare to generate docs for 3.0.16 UNRELEASED.
3110 Revision 2.31 2009/10/10 05:48:55 fabiankeil
3111 Prepare for 3.0.15 beta.
3113 Revision 2.30 2009/07/18 16:24:39 fabiankeil
3114 Bump entities for 3.0.14 beta.
3116 Revision 2.29 2009/06/12 14:30:58 fabiankeil
3117 Update entities for 3.0.13 beta.
3119 Revision 2.28 2009/05/16 13:27:21 fabiankeil
3120 Remove CVS revision logs. TODO item #33.
3122 Revision 2.27 2009/02/19 02:20:22 hal9
3123 Make some links in seealso conditional. Man page is now privoxy only links.
3125 Revision 2.26 2009/02/12 16:08:26 fabiankeil
3126 Declare the code stable.
3128 Revision 2.25 2009/02/12 15:37:05 fabiankeil
3131 Revision 2.24 2009/01/13 16:50:35 fabiankeil
3132 The standard.action file is gone.
3134 Revision 2.23 2008/09/26 17:02:01 fabiankeil
3135 - Break some more CVS substitutions in examples.
3136 - Remove Junkbusters reference in example header
3139 Revision 2.22 2008/08/30 15:37:35 fabiankeil
3142 Revision 2.21 2008/08/16 08:51:28 fabiankeil
3143 Update version-related entities.
3145 Revision 2.20 2008/06/14 13:21:24 fabiankeil
3146 Prepare for the upcoming 3.0.9 beta release.
3148 Revision 2.19 2008/05/12 11:13:33 fabiankeil
3149 Clarify that Privoxy is licensed under GPL version 2.
3151 Revision 2.18 2008/02/04 12:14:06 fabiankeil
3152 Change "Edit Packages" URL to use https.
3154 Revision 2.17 2008/02/03 21:37:41 hal9
3155 Apply patch from Mark: s/OSX/OS X/
3157 Revision 2.16 2008/01/19 17:52:38 hal9
3158 Re-commit to fix various minor issues for new release.
3160 Revision 2.15 2008/01/19 15:03:05 hal9
3161 Doc sources tagged for 3.0.8 release.
3163 Revision 2.14 2008/01/17 01:49:51 hal9
3164 Change copyright notice for docs s/2007/2008/. All these will be rebuilt soon
3167 Revision 2.13 2007/10/30 17:59:31 fabiankeil
3168 - Bump p-version, p-status and copyright date.
3169 - Mention that the manual is out of date.
3170 - Don't use examples with HardToReadCamelCase after
3171 explaining that we actually don't like that.
3174 Revision 2.12 2006/11/14 01:57:46 hal9
3175 Dump all docs prior to 3.0.6 release. Various minor changes to faq and user
3178 Revision 2.11 2006/09/26 02:36:29 hal9
3179 Fix broken link per bug tracker.
3181 Revision 2.10 2006/09/22 01:27:55 hal9
3182 Final commit of probably various minor changes here and there. Unless
3183 something changes this should be ready for pending release.
3185 Revision 2.9 2006/09/14 02:30:07 hal9
3186 Fix ijbswa cvs links. Update notes on release process, and which config files
3187 should be overwritten and which not.
3189 Revision 2.8 2006/08/22 23:35:01 hal9
3190 Fix email address, cvs URI, address branching changes and various other
3193 Revision 2.7 2006/07/18 14:48:50 david__schmidt
3194 Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
3195 with what was really the latest development (the v_3_0_branch branch)
3197 Revision 1.46.2.11 2002/12/11 13:12:15 hal9
3198 Rewrite cvs write access give-away section.
3200 Revision 1.46.2.10 2002/09/26 21:53:45 hal9
3201 Changes to reflect recent change in stable branch commit policy (hopefully
3204 Revision 1.46.2.9 2002/09/26 01:21:40 hal9
3205 Porting 3.1.1 changes: more on cvs and branches, more on versions and
3208 Revision 1.46.2.8 2002/08/17 00:16:10 hal9
3209 Add note on updating webserver for User-manual/CGI editor, which is version
3210 dependent (and different from main UM link).
3212 Revision 1.46.2.7 2002/08/14 17:29:25 hal9
3213 Add small notes on post-release steps, and uploading docs to webserver.
3215 Revision 1.46.2.6 2002/08/10 11:40:25 oes
3216 Added disclaimer about probably being out-of-date and two small hints
3218 Revision 1.46.2.5 2002/08/09 01:15:12 hal9
3219 Added some notes on pre-release steps (test builds first, update ChangeLog).
3221 Revision 1.46.2.4 2002/05/29 00:30:59 mal0rd
3222 Fixed a little formatting. Clarified debian section.
3224 Revision 1.46.2.3 2002/05/28 04:32:45 hal9
3225 Change hints on bundling index.html to privoxy-index.html
3227 Revision 1.46.2.2 2002/05/26 17:04:24 hal9
3228 -Spellcheck, very minor edits, and sync across branches
3230 Revision 1.48 2002/05/26 12:48:31 roro
3231 Add releasing information about Debian.
3233 Revision 1.47 2002/05/26 04:55:11 mal0rd
3234 Added debian-dist and debian-upload targets. Also documented usage.
3236 Revision 1.46 2002/05/22 17:15:00 oes
3239 Revision 1.45 2002/05/19 23:01:54 hal9
3240 Add small section on general packaging guidelines (e.g. actions files must
3243 Revision 1.44 2002/05/15 03:55:17 hal9
3244 Fix ulink -> link, and minor modification to release process section for
3247 Revision 1.43 2002/05/10 01:48:19 hal9
3248 This is mostly proposed copyright/licensing additions and changes. Docs
3249 are still GPL, but licensing and copyright are more visible. Also, copyright
3250 changed in doc header comments (eliminate references to JB except FAQ).
3252 Revision 1.42 2002/05/05 20:26:02 hal9
3253 Sorting out license vs copyright in these docs.
3255 Revision 1.41 2002/05/04 08:44:44 swa
3258 Revision 1.40 2002/05/04 00:43:43 hal9
3259 -Remove TOC/first page kludge with proper stylesheet fix.
3260 -Combined the two very brief sections: Intro and Quickstart.
3262 Revision 1.39 2002/05/02 15:08:25 oes
3263 Added explanation about version numbers and RPM package revisions
3265 Revision 1.38 2002/04/29 02:20:31 hal9
3266 Add info on steps for uploading and the release process on SF.
3268 Revision 1.37 2002/04/26 17:23:29 swa
3269 bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
3271 Revision 1.36 2002/04/26 05:25:23 hal9
3272 Mass commit to catch a few scattered fixes.
3274 Revision 1.35 2002/04/17 15:16:15 oes
3275 Added link to docbook crash course
3277 Revision 1.34 2002/04/15 23:39:32 oes
3278 - Extended & fixed the release section
3279 - Added CVS guideline sections
3280 - Separated webserver section from release section
3281 - Commented out boilerplate inclusion (If you don't know yet what it is,
3282 you shouldn't mess with its code ;-)
3285 Revision 1.33 2002/04/12 03:49:53 hal9
3286 Spell checked. Clarification on where docs are kept.
3288 Revision 1.32 2002/04/11 21:29:58 jongfoster
3289 Documenting Win32 release procedure
3291 Revision 1.31 2002/04/11 09:32:52 oes
3294 Revision 1.30 2002/04/11 09:24:53 oes
3297 Revision 1.29 2002/04/10 18:45:14 swa
3300 Revision 1.28 2002/04/08 22:59:26 hal9
3301 Version update. Spell chkconfig correctly :)
3303 Revision 1.27 2002/04/08 15:31:18 hal9
3304 Touch ups to documentation section.
3306 Revision 1.26 2002/04/07 23:50:08 hal9
3307 Documentation changes to reflect HTML docs now in CVS, and new generated files
3310 Revision 1.25 2002/04/06 05:07:28 hal9
3311 -Add privoxy-man-page.sgml, for man page.
3312 -Add authors.sgml for AUTHORS (and p-authors.sgml)
3313 -Reworked various aspects of various docs.
3314 -Added additional comments to sub-docs.
3316 Revision 1.24 2002/04/04 21:33:37 hal9
3317 More on documenting the documents.
3319 Revision 1.23 2002/04/04 18:46:47 swa
3320 consistent look. reuse of copyright, history et. al.
3322 Revision 1.22 2002/04/04 17:27:56 swa
3323 more single file to be included at multiple points. make maintaining easier
3325 Revision 1.21 2002/04/04 06:48:37 hal9
3326 Structural changes to allow for conditional inclusion/exclusion of content
3327 based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
3328 definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
3329 eventually be set by Makefile.
3330 More boilerplate text for use across multiple docs.
3332 Revision 1.20 2002/04/04 03:28:27 david__schmidt
3333 Add Mac OS X section
3335 Revision 1.19 2002/04/03 15:09:42 david__schmidt
3336 Add OS/2 build section
3338 Revision 1.18 2002/04/03 03:51:48 hal9
3341 Revision 1.17 2002/04/03 01:21:17 hal9
3342 Implementing Andreas's suggestions for Release sections.
3344 Revision 1.16 2002/03/31 23:04:40 hal9
3345 Fleshed out the doc section, and added something for an intro so it was not
3348 Revision 1.15 2002/03/30 22:29:47 swa
3351 Revision 1.14 2002/03/30 19:04:08 swa
3352 people release differently. no good.
3353 I want to make parts of the docs only.
3355 Revision 1.13 2002/03/27 01:16:41 hal9
3358 Revision 1.12 2002/03/27 01:02:51 hal9
3359 Touch up on name change...
3361 Revision 1.11 2002/03/26 22:29:55 swa
3362 we have a new homepage!
3364 Revision 1.10 2002/03/24 12:33:01 swa
3367 Revision 1.9 2002/03/24 11:01:05 swa
3370 Revision 1.8 2002/03/23 15:13:11 swa
3371 renamed every reference to the old name with foobar.
3372 fixed "application foobar application" tag, fixed
3373 "the foobar" with "foobar". left junkbustser in cvs
3374 comments and remarks to history untouched.
3376 Revision 1.7 2002/03/11 13:13:27 swa
3377 correct feedback channels
3379 Revision 1.6 2002/02/24 14:25:06 jongfoster
3380 Formatting changes. Now changing the doctype to DocBook XML 4.1
3381 will work - no other changes are needed.
3383 Revision 1.5 2001/10/31 18:16:51 swa
3384 documentation added: howto generate docs in text and html
3385 format, howto move stuff to the webserver.
3387 Revision 1.4 2001/09/23 10:13:48 swa
3388 upload process established. run make webserver and
3389 the documentation is moved to the webserver. documents
3390 are now linked correctly.
3392 Revision 1.3 2001/09/13 15:27:40 swa
3395 Revision 1.2 2001/09/13 15:20:17 swa
3396 merged standards into developer manual
3398 Revision 1.1 2001/09/12 15:36:41 swa
3399 source files for junkbuster documentation
3401 Revision 1.3 2001/09/10 17:43:59 swa
3402 first proposal of a structure.
3404 Revision 1.2 2001/06/13 14:28:31 swa
3405 docs should have an author.
3407 Revision 1.1 2001/06/13 14:20:37 swa
3408 first import of project's documentation for the webserver.