1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
2 <!entity % dummy "IGNORE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity history SYSTEM "history.sgml">
7 <!entity seealso SYSTEM "seealso.sgml">
8 <!entity p-version "3.0.27">
9 <!entity p-status "UNRELEASED">
10 <!entity % p-not-stable "INCLUDE">
11 <!entity % p-stable "IGNORE">
12 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
13 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
14 <!entity % seealso-extra "INCLUDE"> <!-- extra stuff from seealso.sgml -->
15 <!entity my-copy "©"> <!-- kludge for docbook2man -->
18 File : $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
20 Purpose : developer manual
21 This file belongs into
22 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
24 $Id: developer-manual.sgml,v 2.83 2017/06/08 13:08:39 fabiankeil Exp $
26 Copyright (C) 2001-2016 Privoxy Developers https://www.privoxy.org/
29 ========================================================================
30 NOTE: Please read developer-manual/documentation.html before touching
31 anything in this, or other Privoxy documentation. You have been warned!
32 Failure to abide by this rule will result in the revocation of your license
33 to live a peaceful existence!
34 ========================================================================
40 <title>Privoxy Developer Manual</title>
43 <!-- Completely the wrong markup, but very little is allowed -->
44 <!-- in this part of an article. FIXME -->
45 <ulink url="https://www.privoxy.org/user-manual/copyright.html">Copyright</ulink>
46 &my-copy; 2001-2016 by
47 <ulink url="https://www.privoxy.org/">Privoxy Developers</ulink>
52 <pubdate>$Id: developer-manual.sgml,v 2.83 2017/06/08 13:08:39 fabiankeil Exp $</pubdate>
56 Note: this should generate a separate page, and a live link to it.
57 But it doesn't for some mysterious reason. Please leave commented
58 unless it can be fixed proper. For the time being, the copyright
59 statement will be in copyright.smgl.
63 <legalnotice id="legalnotice">
65 text goes here ........
76 This is here to keep vim syntax file from breaking :/
77 If I knew enough to fix it, I would.
78 PLEASE DO NOT REMOVE! HB: hal@foobox.net
83 The developer manual provides guidance on coding, testing, packaging, documentation
84 and other issues of importance to those involved with
85 <application>Privoxy</application> development. It is mandatory (and helpful!) reading
86 for anyone who wants to join the team. Note that it's currently out of date
87 and may not be entirely correct. As always, patches are welcome.
90 <!-- Include privoxy.sgml boilerplate text: -->
92 <!-- &p-intro; Someone interested enough in the project to contribute
93 will already know at this point what Privoxy is. -->
95 <!-- end boilerplate -->
98 Please note that this document is constantly evolving. This copy represents
99 the state at the release of version &p-version;.
100 You can find the latest version of the this manual at <ulink
101 url="https://www.privoxy.org/developer-manual/">https://www.privoxy.org/developer-manual/</ulink>.
102 Please have a look at the
103 <ulink url="https://www.privoxy.org/user-manual/contact.html">contact section in the user manual</ulink>
104 if you are interested in contacting the developers.
111 <!-- ~~~~~ New section ~~~~~ -->
112 <sect1 id="introduction"><title>Introduction</title>
115 I don't like seeing blank space :) So added *something* here.
119 <application>Privoxy</application>, as an heir to
120 <application>Junkbuster</application>, is a Free Software project
121 and the code is licensed under the GNU General Public License version 2.
122 As such, <application>Privoxy</application> development is potentially open
123 to anyone who has the time, knowledge, and desire to contribute
124 in any capacity. Our goals are simply to continue the mission,
125 to improve <application>Privoxy</application>, and
126 to make it available to as wide an audience as possible.
129 One does not have to be a programmer to contribute. Packaging, testing,
130 documenting and porting, are all important jobs as well.
133 <!-- ~~~~~ New section ~~~~~ -->
134 <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
136 The first step is to join the <ulink
137 url="https://lists.privoxy.org/mailman/listinfo/privoxy-devel">privoxy-devel mailing list</ulink>.
138 You can submit your ideas, or even better patches. Patches are best
139 submitted to the Sourceforge tracker set up for this purpose, but
140 can be sent to the list for review too.
143 You will also need to have a cvs package installed, which will
144 entail having ssh installed as well (which seems to be a requirement of
145 SourceForge), in order to access the cvs repository. Having the GNU build
146 tools is also going to be important (particularly, autoconf and gmake).
149 For the time being (read, this section is under construction), you can
150 also refer to the extensive comments in the source code. In fact,
151 reading the code is recommended in any case.
156 <!-- ~~~~~ New section ~~~~~ -->
157 <sect1 id="cvs"><title>The CVS Repository</title>
159 If you become part of the active development team, you will eventually
160 need write access to our holy grail, the CVS repository. One of the
161 team members will need to set this up for you. Please read
162 this chapter completely before accessing via CVS.
165 <sect2 id="cvsaccess"><title>Access to CVS</title>
167 The project's CVS repository is hosted on
168 <ulink url="https://sourceforge.net/">SourceForge.</ulink>
169 For historical reasons, the CVS server is
170 called <literal>ijbswa.cvs.sourceforge.net</literal>, the repository is
171 called <literal>ijbswa</literal>, and the source tree module is called
172 <literal>current</literal>.
176 <sect2 id="cvsbranches">
177 <title>Branches</title>
179 Within the CVS repository, there are modules and branches. As
180 mentioned, the sources are in the <literal>current</literal>
181 <quote>module</quote>. Other modules are present for platform specific
182 issues. There is a webview of the CVS hierarchy at <ulink
183 url="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/"
184 >http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/</ulink>,
185 which might help with visualizing how these pieces fit together.
189 Branches are used to fork a sub-development path from the main trunk.
190 Within the <literal>current</literal> module where the sources are, there
191 is always at least one <quote>branch</quote> from the main trunk
192 devoted to a stable release series. The main trunk is where active
193 development takes place for the next stable series (e.g. 3.2.x).
194 So just prior to each stable series (e.g. 3.0.x), a branch is created
195 just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
196 Once the initial stable release of any stable branch has taken place,
197 this branch is <emphasis>only used for bugfixes</emphasis>, which have
198 had prior testing before being committed to CVS. (See <link
199 linkend="versionnumbers">Version Numbers</link> below for details on
204 At one time there were two distinct branches: stable and unstable. The
205 more drastic changes were to be in the unstable branch. These branches
206 have now been merged to minimize time and effort of maintaining two
211 This will result in at least two active branches, which means there may
212 be occasions that require the same (or similar) item to be
213 checked into to two different places (assuming its a bugfix and needs
214 fixing in both the stable and unstable trees). This also means that in
215 order to have access to both trees, both will have to be checked out
216 separately. Use the <literal>cvs -r</literal> flag to check out a
217 branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
222 <sect2 id="cvscommit"><title>CVS Commit Guidelines</title>
224 The source tree is the heart of every software project. Every effort must
225 be made to ensure that it is readable, compilable and consistent at all
226 times. <!-- There are differing guidelines for the stable branch and the
227 main development trunk, and --> We expect anyone with CVS access to strictly
228 adhere to the following guidelines:
232 Basic Guidelines, for all branches:
237 Please don't commit even
238 a small change without testing it thoroughly first. When we're
239 close to a public release, ask a fellow developer to review your
243 Your commit message should give a concise overview of <emphasis>what you
244 changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
245 Just check previous messages for good examples.
248 Don't use the same message on multiple files, unless it equally applies to
252 If your changes span multiple files, and the code won't recompile unless
253 all changes are committed (e.g. when changing the signature of a function),
254 then commit all files one after another, without long delays in between.
255 If necessary, prepare the commit messages in advance.
258 Before changing things on CVS, make sure that your changes are in line
259 with the team's general consensus on what should be done.
263 Note that near a major public release, we get more cautious.
264 There is always the possibility to submit a patch to the <ulink
265 url="https://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patch
266 tracker</ulink> instead.
274 Stable branches are handled with more care, especially after the
275 initial *.*.0 release, and we are just in bugfix mode. In addition to
276 the above, the below applies only to the stable branch (currently the
277 <literal>v_3_0_branch</literal> branch):
284 Do not commit <emphasis>anything</emphasis> unless your proposed
285 changes have been well tested first, preferably by other members of the
286 project, or have prior approval of the project leaders or consensus
292 Where possible, bugfixes and changes should be tested in the main
293 development trunk first. There may be occasions where this is not
299 Alternately, proposed changes can be submitted as patches to the patch tracker on
300 Sourceforge first: <ulink
301 url="https://sourceforge.net/tracker/?group_id=11118&atid=311118">https://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
302 Then ask for peer review.
307 Do not even think about anything except bugfixes. No new features!
318 <!-- ~~~~~ New section ~~~~~ -->
319 <sect1 id="documentation"><title>Documentation Guidelines</title>
321 All formal documents are maintained in Docbook SGML and located in the
322 <computeroutput>doc/source/*</computeroutput> directory. You will need
323 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
324 DTD's and the Docbook modular stylesheets (or comparable alternatives),
325 and either <application>jade</application> or
326 <application>openjade</application> (recommended) installed in order to
327 build docs from source. Currently there is <ulink
328 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
329 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
330 course this, the <citetitle>developer-manual</citetitle> in this format.
331 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
332 <citetitle>INSTALL</citetitle>,
333 <citetitle>privoxy.1</citetitle> (man page), and
334 <citetitle>config</citetitle> files are also now maintained as Docbook
335 SGML. These files, when built, in the top-level source directory are
336 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
337 variation on this file, <filename>privoxy-index.html</filename>,
338 meant for inclusion with doc packages), are maintained as SGML as well.
339 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
340 contact someone involved in the documentation.
343 <filename>config</filename> requires some special handling. The reason it
344 is maintained this way is so that the extensive comments in the file
345 mirror those in <citetitle>user-manual</citetitle>. But the conversion
346 process requires going from SGML to HTML to text to special formatting
347 required for the embedded comments. Some of this does not survive so
348 well. Especially some of the examples that are longer than 80 characters.
349 The build process for this file outputs to <filename>config.new</filename>,
350 which should be reviewed for errors and mis-formatting. Once satisfied
351 that it is correct, then it should be hand copied to
352 <filename>config</filename>.
355 Other, less formal documents (e.g. <filename>LICENSE</filename>) are
356 maintained as plain text files in the top-level source directory.
359 Packagers are encouraged to include this documentation. For those without
360 the ability to build the docs locally, text versions of each are kept in
361 CVS. HTML versions are also being kept in CVS under
362 <filename>doc/webserver/*</filename>.
365 Formal documents are built with the Makefile targets of
366 <computeroutput>make dok</computeroutput>.
367 The build process uses the document SGML sources in
368 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
369 <computeroutput>doc/text/</computeroutput> and to update all HTML
370 documents in <computeroutput>doc/webserver/</computeroutput>.
373 Documentation writers should please make sure documents build
374 successfully before committing to CVS, if possible.
377 How do you update the webserver (i.e. the pages on privoxy.org)?
379 <orderedlist numeration="arabic">
381 First, build the docs by running <computeroutput>make
382 dok</computeroutput>.
385 Run <computeroutput>make webserver</computeroutput> which copies all
386 files from <computeroutput>doc/webserver</computeroutput> to the
387 sourceforge webserver via scp.
393 Finished docs should be occasionally submitted to CVS
394 (<filename>doc/webserver/*/*.html</filename>) so that those without
395 the ability to build them locally, have access to them if needed.
396 This is especially important just prior to a new release! Please
397 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
398 other release specific data in <filename>configure.in</filename> has been
399 updated (this is done just prior to a new release).
402 <!-- ~~~~~ New section ~~~~~ -->
404 <title>Quickstart to Docbook and SGML</title>
406 If you are not familiar with SGML, it is a markup language similar to HTML.
407 Actually, not a mark up language per se, but a language used to define
408 markup languages. In fact, HTML is an SGML application. Both will use
409 <quote>tags</quote> to format text and other content. SGML tags can be much
410 more varied, and flexible, but do much of the same kinds of things. The tags,
411 or <quote>elements</quote>, are definable in SGML. There is no set
412 <quote>standards</quote>. Since we are using
413 <application>Docbook</application>, our tags are those that are defined by
414 <application>Docbook</application>. Much of how the finish document is
415 rendered is determined by the <quote>stylesheets</quote>.
416 The stylesheets determine how each tag gets translated to HTML, or other
421 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
422 will likely generate errors. Example: <literal><title>My
423 Title</title></literal>. They are also case-insensitive, but we
424 strongly suggest using all lower case. This keeps compatibility with
425 [Docbook] <application>XML</application>.
429 Our documents use <quote>sections</quote> for the most part. Sections
430 will be processed into HTML headers (e.g. <literal>h1</literal> for
431 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
432 will use these to also generate the Table of Contents for each doc. Our
433 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
434 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
435 entries, but <literal>sect4</literal> will not. Each section requires
436 a <literal><title></literal> element, and at least one
437 <literal><para></literal>. There is a limit of five section
438 levels in Docbook, but generally three should be sufficient for our
443 Some common elements that you likely will use:
449 <emphasis><para></para></emphasis>, paragraph delimiter. Most
450 text needs to be within paragraph elements (there are some exceptions).
453 <emphasis><emphasis></emphasis></emphasis>, the stylesheets
457 <emphasis><filename></filename></emphasis>, files and directories.
460 <emphasis><command></command></emphasis>, command examples.
463 <emphasis><literallayout></literallayout></emphasis>, like
464 <literal><pre></literal>, more or less.
467 <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
470 <emphasis><listitem></listitem></emphasis>, member of the above.
473 <emphasis><screen></screen></emphasis>, screen output, implies
474 <literal><literallayout></literal>.
477 <emphasis><ulink url="example.com"></ulink></emphasis>, like
478 HTML <literal><a></literal> tag.
481 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
487 Look at any of the existing docs for examples of all these and more.
492 <!-- <quote><ulink url="http://opensource.bureau-cornavin.com/crash-course/index.html">
493 domain no longer exists so link to the wayback archive -->
494 <quote><ulink url="https://web.archive.org/web/20160315230758/http://opensource.bureau-cornavin.com/crash-course/index.html">
495 Writing Documentation Using DocBook - A Crash Course</ulink></quote> useful.
499 <!-- ~~~~~ New section ~~~~~ -->
500 <sect2 id="docstyle">
501 <title><application>Privoxy</application> Documentation Style</title>
503 It will be easier if everyone follows a similar writing style. This
504 just makes it easier to read what someone else has written if it
505 is all done in a similar fashion.
514 All tags should be lower case.
519 Tags delimiting a <emphasis>block</emphasis> of text (even small
520 blocks) should be on their own line. Like:
526 Tags marking individual words, or few words, should be in-line:
528 Just to <emphasis>emphasize</emphasis>, some text goes here.
534 Tags should be nested and step indented for block text like: (except
541 Some text goes here in our list example.
544 </itemizedlist>
547 This makes it easier to find the text amongst the tags ;-)
552 Use white space to separate logical divisions within a document,
553 like between sections. Running everything together consistently
554 makes it harder to read and work on.
559 Do not hesitate to make comments. Comments can either use the
560 <comment> element, or the <!-- --> style comment
561 familiar from HTML. (Note in Docbook v4.x <comment> is
562 replaced by <remark>.)
567 We have an international audience. Refrain from slang, or English
568 idiosyncrasies (too many to list :). Humor also does not translate
574 Try to keep overall line lengths in source files to 80 characters or less
575 for obvious reasons. This is not always possible, with lengthy URLs for
581 Our documents are available in differing formats. Right now, they
582 are just plain text and/or HTML, but others are always a
583 future possibility. Be careful with URLs (<ulink>), and avoid
587 My favorite site is <ulink url="http://example.com">here</ulink>.
590 This will render as <quote>My favorite site is here</quote>, which is
591 not real helpful in a text doc. Better like this:
594 My favorite site is <ulink url="http://example.com">example.com</ulink>.
599 All documents should be spell checked occasionally.
600 <application>aspell</application> can check SGML with the
601 <literal>-H</literal> option. (<application>ispell</application> I think
612 <!-- ~~~~~ New section ~~~~~ -->
614 <sect2><title>Privoxy Custom Entities</title>
616 <application>Privoxy</application> documentation is using
617 a number of customized <quote>entities</quote> to facilitate
618 documentation maintenance.
621 We are using a set of <quote>boilerplate</quote> files with generic text,
622 that is used by multiple docs. This way we can write something once, and use
623 it repeatedly without having to re-write the same content over and over again.
624 If editing such a file, keep in mind that it should be
625 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
626 contexts without additional modifications.
629 We are also using what <application>Docbook</application> calls
630 <quote>internal entities</quote>. These are like variables in
631 programming. Well, sort of. For instance, we have the
632 <literal>p-version</literal> entity that contains the current
633 <application>Privoxy</application> version string. You are strongly
634 encouraged to use these where possible. Some of these obviously
635 require re-setting with each release (done by the Makefile). A sampling of
636 custom entities are listed below. See any of the main docs for examples.
643 Re- <quote>boilerplate</quote> text entities are defined like:
646 <literal><!entity supported SYSTEM "supported.sgml"></literal>
649 In this example, the contents of the file,
650 <filename>supported.sgml</filename> is available for inclusion anywhere
651 in the doc. To make this happen, just reference the now defined
652 entity: <literal>&supported;</literal> (starts with an ampersand
653 and ends with a semi-colon), and the contents will be dumped into
654 the finished doc at that point.
659 Commonly used <quote>internal entities</quote>:
663 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
664 version string, e.g. <quote>&p-version;</quote>.
667 <emphasis>p-status</emphasis>: the project status, either
668 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
671 <emphasis>p-not-stable</emphasis>: use to conditionally include
672 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
675 <emphasis>p-stable</emphasis>: just the opposite.
678 <emphasis>p-text</emphasis>: this doc is only generated as text.
685 There are others in various places that are defined for a specific
686 purpose. Read the source!
693 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
694 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
696 <!-- ~~~~~ New section ~~~~~ -->
697 <sect1 id="coding"><title>Coding Guidelines</title>
699 <sect2 id="s1"><title>Introduction</title>
701 <para>This set of standards is designed to make our lives easier. It is
702 developed with the simple goal of helping us keep the "new and improved
703 <application>Privoxy</application>" consistent and reliable. Thus making
704 maintenance easier and increasing chances of success of the
707 <para>And that of course comes back to us as individuals. If we can
708 increase our development and product efficiencies then we can solve more
709 of the request for changes/improvements and in general feel good about
710 ourselves. ;-></para>
714 <sect2 id="s2"><title>Using Comments</title>
717 <sect3 id="s3"><title>Comment, Comment, Comment</title>
719 <para><emphasis>Explanation:</emphasis></para>
721 <para>Comment as much as possible without commenting the obvious.
722 For example do not comment "variable_a is equal to variable_b".
723 Instead explain why variable_a should be equal to the variable_b.
724 Just because a person can read code does not mean they will
725 understand why or what is being done. A reader may spend a lot
726 more time figuring out what is going on when a simple comment
727 or explanation would have prevented the extra research. Please
728 help your fellow Privoxy developers out!</para>
730 <para>The comments will also help justify the intent of the code.
731 If the comment describes something different than what the code
732 is doing then maybe a programming error is occurring.</para>
734 <para><emphasis>Example:</emphasis></para>
736 /* if page size greater than 1k ... */
737 if (page_length() > 1024)
739 ... "block" the page up ...
742 /* if page size is small, send it in blocks */
743 if (page_length() > 1024)
745 ... "block" the page up ...
748 This demonstrates 2 cases of "what not to do". The first is a
749 "syntax comment". The second is a comment that does not fit what
750 is actually being done.
756 <sect3 id="s4"><title>Use blocks for comments</title>
758 <para><emphasis>Explanation:</emphasis></para>
760 <para>Comments can help or they can clutter. They help when they
761 are differentiated from the code they describe. One line
762 comments do not offer effective separation between the comment
763 and the code. Block identifiers do, by surrounding the code
764 with a clear, definable pattern.</para>
766 <para><emphasis>Example:</emphasis></para>
768 /*********************************************************************
769 * This will stand out clearly in your code!
770 *********************************************************************/
771 if (this_variable == that_variable)
773 do_something_very_important();
777 /* unfortunately, this may not */
778 if (this_variable == that_variable)
780 do_something_very_important();
784 if (this_variable == that_variable) /* this may not either */
786 do_something_very_important();
789 <para><emphasis>Exception:</emphasis></para>
791 <para>If you are trying to add a small logic comment and do not
792 wish to "disrupt" the flow of the code, feel free to use a 1
793 line comment which is NOT on the same line as the code.</para>
799 <sect3 id="s5"><title>Keep Comments on their own line</title>
801 <para><emphasis>Explanation:</emphasis></para>
803 <para>It goes back to the question of readability. If the comment
804 is on the same line as the code it will be harder to read than
805 the comment that is on its own line.</para>
807 <para>There are three exceptions to this rule, which should be
808 violated freely and often: during the definition of variables,
809 at the end of closing braces, when used to comment
812 <para><emphasis>Example:</emphasis></para>
814 /*********************************************************************
815 * This will stand out clearly in your code,
816 * But the second example won't.
817 *********************************************************************/
818 if (this_variable == this_variable)
820 do_something_very_important();
823 if (this_variable == this_variable) /*can you see me?*/
825 do_something_very_important(); /*not easily*/
829 /*********************************************************************
830 * But, the encouraged exceptions:
831 *********************************************************************/
832 int urls_read = 0; /* # of urls read + rejected */
833 int urls_rejected = 0; /* # of urls rejected */
837 do_something_very_important();
841 short do_something_very_important(
842 short firstparam, /* represents something */
843 short nextparam /* represents something else */ )
847 } /* -END- do_something_very_important */
852 <sect3 id="s6"><title>Comment each logical step</title>
854 <para><emphasis>Explanation:</emphasis></para>
856 <para>Logical steps should be commented to help others follow the
857 intent of the written code and comments will make the code more
860 <para>If you have 25 lines of code without a comment, you should
861 probably go back into it to see where you forgot to put
864 <para>Most "for", "while", "do", etc... loops _probably_ need a
865 comment. After all, these are usually major logic
872 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
874 <para><emphasis>Explanation:</emphasis></para>
876 <para>A reader of the code should be able to look at the comments
877 just prior to the beginning of a function and discern the
878 reason for its existence and the consequences of using it. The
879 reader should not have to read through the code to determine if
880 a given function is safe for a desired use. The proper
881 information thoroughly presented at the introduction of a
882 function not only saves time for subsequent maintenance or
883 debugging, it more importantly aids in code reuse by allowing a
884 user to determine the safety and applicability of any function
885 for the problem at hand. As a result of such benefits, all
886 functions should contain the information presented in the
887 addendum section of this document.</para>
893 <sect3 id="s8"><title>Comment at the end of braces if the
894 content is more than one screen length</title>
896 <para><emphasis>Explanation:</emphasis></para>
898 <para>Each closing brace should be followed on the same line by a
899 comment that describes the origination of the brace if the
900 original brace is off of the screen, or otherwise far away from
901 the closing brace. This will simplify the debugging,
902 maintenance, and readability of the code.</para>
904 <para>As a suggestion , use the following flags to make the
905 comment and its brace more readable:</para>
907 <para>use following a closing brace: } /* -END- if() or while ()
910 <para><emphasis>Example:</emphasis></para>
914 do_something_very_important();
915 ...some long list of commands...
916 } /* -END- if x is 1 */
922 do_something_very_important();
923 ...some long list of commands...
924 } /* -END- if (1 == X) */
930 <sect2 id="s9"><title>Naming Conventions</title>
934 <sect3 id="s10"><title>Variable Names</title>
936 <para><emphasis>Explanation:</emphasis></para>
938 <para>Use all lowercase, and separate words via an underscore
939 ('_'). Do not start an identifier with an underscore. (ANSI C
940 reserves these for use by the compiler and system headers.) Do
941 not use identifiers which are reserved in ANSI C++. (E.g.
942 template, class, true, false, ...). This is in case we ever
943 decide to port Privoxy to C++.</para>
945 <para><emphasis>Example:</emphasis></para>
947 int ms_iis5_hack = 0;</programlisting>
949 <para><emphasis>Instead of:</emphasis></para>
953 int msiis5hack = 0; int msIis5Hack = 0;
961 <sect3 id="s11"><title>Function Names</title>
963 <para><emphasis>Explanation:</emphasis></para>
965 <para>Use all lowercase, and separate words via an underscore
966 ('_'). Do not start an identifier with an underscore. (ANSI C
967 reserves these for use by the compiler and system headers.) Do
968 not use identifiers which are reserved in ANSI C++. (E.g.
969 template, class, true, false, ...). This is in case we ever
970 decide to port Privoxy to C++.</para>
972 <para><emphasis>Example:</emphasis></para>
974 int load_some_file(struct client_state *csp)</programlisting>
976 <para><emphasis>Instead of:</emphasis></para>
980 int loadsomefile(struct client_state *csp)
981 int loadSomeFile(struct client_state *csp)
989 <sect3 id="s12"><title>Header file prototypes</title>
991 <para><emphasis>Explanation:</emphasis></para>
993 <para>Use a descriptive parameter name in the function prototype
994 in header files. Use the same parameter name in the header file
995 that you use in the c file.</para>
997 <para><emphasis>Example:</emphasis></para>
999 (.h) extern int load_aclfile(struct client_state *csp);
1000 (.c) int load_aclfile(struct client_state *csp)</programlisting>
1002 <para><emphasis>Instead of:</emphasis>
1004 (.h) extern int load_aclfile(struct client_state *); or
1005 (.h) extern int load_aclfile();
1006 (.c) int load_aclfile(struct client_state *csp)
1014 <sect3 id="s13"><title>Enumerations, and #defines</title>
1016 <para><emphasis>Explanation:</emphasis></para>
1018 <para>Use all capital letters, with underscores between words. Do
1019 not start an identifier with an underscore. (ANSI C reserves
1020 these for use by the compiler and system headers.)</para>
1022 <para><emphasis>Example:</emphasis></para>
1024 (enumeration) : enum Boolean {FALSE, TRUE};
1025 (#define) : #define DEFAULT_SIZE 100;</programlisting>
1027 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
1028 that toggle a feature in the preprocessor: FEATURE_>, where
1029 > is a short (preferably 1 or 2 word) description.</para>
1031 <para><emphasis>Example:</emphasis></para>
1033 #define FEATURE_FORCE 1
1035 #ifdef FEATURE_FORCE
1036 #define FORCE_PREFIX blah
1037 #endif /* def FEATURE_FORCE */
1042 <sect3 id="s14"><title>Constants</title>
1044 <para><emphasis>Explanation:</emphasis></para>
1046 <para>Spell common words out entirely (do not remove vowels).</para>
1048 <para>Use only widely-known domain acronyms and abbreviations.
1049 Capitalize all letters of an acronym.</para>
1051 <para>Use underscore (_) to separate adjacent acronyms and
1052 abbreviations. Never terminate a name with an underscore.</para>
1054 <para><emphasis>Example:</emphasis></para>
1056 #define USE_IMAGE_LIST 1</programlisting>
1058 <para><emphasis>Instead of:</emphasis></para>
1062 #define USE_IMG_LST 1 or
1063 #define _USE_IMAGE_LIST 1 or
1064 #define USE_IMAGE_LIST_ 1 or
1065 #define use_image_list 1 or
1066 #define UseImageList 1
1076 <sect2 id="s15"><title>Using Space</title>
1080 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1082 <para><emphasis>Explanation:</emphasis></para>
1084 <para>The brace needs to be on a line all by itself, not at the
1085 end of the statement. Curly braces should line up with the
1086 construct that they're associated with. This practice makes it
1087 easier to identify the opening and closing braces for a
1090 <para><emphasis>Example:</emphasis></para>
1097 <para><emphasis>Instead of:</emphasis></para>
1099 <para>if (this == that) { ... }</para>
1103 <para>if (this == that) { ... }</para>
1105 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1106 inside a loop, and it is trivial, i.e. it tests for a
1107 condition that is obvious from the purpose of the block,
1108 one-liners as above may optically preserve the loop structure
1109 and make it easier to read.</para>
1111 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1113 <para><emphasis>Example exception:</emphasis></para>
1115 while (more lines are read)
1117 /* Please document what is/is not a comment line here */
1118 if (it's a comment) continue;
1126 <sect3 id="s17"><title>ALL control statements should have a
1129 <para><emphasis>Explanation:</emphasis></para>
1131 <para>Using braces to make a block will make your code more
1132 readable and less prone to error. All control statements should
1133 have a block defined.</para>
1135 <para><emphasis>Example:</emphasis></para>
1140 do_something_else();
1143 <para><emphasis>Instead of:</emphasis></para>
1145 <para>if (this == that) do_something(); do_something_else();</para>
1149 <para>if (this == that) do_something();</para>
1151 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1152 in a manner other than that which the developer desired (per
1153 indentation). Using code braces would have prevented this
1154 "feature". The "explanation" and "exception" from the point
1155 above also applies.</para>
1161 <sect3 id="s18"><title>Do not belabor/blow-up boolean
1164 <para><emphasis>Example:</emphasis></para>
1166 structure->flag = (condition);</programlisting>
1168 <para><emphasis>Instead of:</emphasis></para>
1170 <para>if (condition) { structure->flag = 1; } else {
1171 structure->flag = 0; }</para>
1173 <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1174 is wordy and inefficient. Please assume that any developer new
1175 to the project has at least a "good" knowledge of C/C++. (Hope
1176 I do not offend by that last comment ... 8-)</para>
1182 <sect3 id="s19"><title>Use white space freely because it is
1185 <para><emphasis>Explanation:</emphasis></para>
1187 <para>Make it readable. The notable exception to using white space
1188 freely is listed in the next guideline.</para>
1190 <para><emphasis>Example:</emphasis></para>
1192 int first_value = 0;
1194 int another_value = 0;
1195 int this_variable = 0;
1200 <sect3 id="s20"><title>Don't use white space around structure
1203 <para><emphasis>Explanation:</emphasis></para>
1205 <para>- structure pointer operator ( "->" ) - member operator (
1206 "." ) - functions and parentheses</para>
1208 <para>It is a general coding practice to put pointers, references,
1209 and function parentheses next to names. With spaces, the
1210 connection between the object and variable/function name is not
1213 <para><emphasis>Example:</emphasis></para>
1217 function_name();</programlisting>
1219 <para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
1220 function_name ();</para>
1226 <sect3 id="s21"><title>Make the last brace of a function stand
1229 <para><emphasis>Example:</emphasis></para>
1231 int function1( ... )
1236 } /* -END- function1 */
1239 int function2( ... )
1241 } /* -END- function2 */
1244 <para><emphasis>Instead of:</emphasis></para>
1246 <para>int function1( ... ) { ...code... return(ret_code); } int
1247 function2( ... ) { }</para>
1249 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1250 lines afterward. This makes the end of function standout to
1251 the most casual viewer. Although function comments help
1252 separate functions, this is still a good coding practice. In
1253 fact, I follow these rules when using blocks in "for", "while",
1254 "do" loops, and long if {} statements too. After all whitespace
1257 <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1258 lines. Enforced is the end of function comments.</para>
1264 <sect3 id="s22"><title>Use 3 character indentions</title>
1266 <para><emphasis>Explanation:</emphasis></para>
1268 <para>If some use 8 character TABs and some use 3 character TABs,
1269 the code can look *very* ragged. So use 3 character indentions
1270 only. If you like to use TABs, pass your code through a filter
1271 such as "expand -t3" before checking in your code.</para>
1273 <para><emphasis>Example:</emphasis></para>
1275 static const char * const url_code_map[256] =
1281 int function1( ... )
1289 return HOW_DID_YOU_GET_HERE;
1292 return NEVER_GETS_HERE;
1301 <sect2 id="s23"><title>Initializing</title>
1305 <sect3 id="s24"><title>Initialize all variables</title>
1307 <para><emphasis>Explanation:</emphasis></para>
1309 <para>Do not assume that the variables declared will not be used
1310 until after they have been assigned a value somewhere else in
1311 the code. Remove the chance of accidentally using an unassigned
1314 <para><emphasis>Example:</emphasis></para>
1318 struct *ptr = NULL;</programlisting>
1320 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1321 message says you are trying to access memory address 00000000
1322 and not 129FA012; or array_ptr[20] causes a SIGSEV vs.
1323 array_ptr[0].</para>
1325 <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1326 variable is assigned a value "shortly after" declaration.</para>
1332 <sect2 id="s25"><title>Functions</title>
1336 <sect3 id="s26"><title>Name functions that return a boolean as a
1339 <para><emphasis>Explanation:</emphasis></para>
1341 <para>Value should be phrased as a question that would logically
1342 be answered as a true or false statement</para>
1344 <para><emphasis>Example:</emphasis></para>
1346 should_we_block_this();
1347 contains_an_image();
1348 is_web_page_blank();
1353 <sect3 id="s27"><title>Always specify a return type for a
1356 <para><emphasis>Explanation:</emphasis></para>
1358 <para>The default return for a function is an int. To avoid
1359 ambiguity, create a return for a function when the return has a
1360 purpose, and create a void return type if the function does not
1361 need to return anything.</para>
1367 <sect3 id="s28"><title>Minimize function calls when iterating by
1368 using variables</title>
1370 <para><emphasis>Explanation:</emphasis></para>
1372 <para>It is easy to write the following code, and a clear argument
1373 can be made that the code is easy to understand:</para>
1375 <para><emphasis>Example:</emphasis></para>
1377 for (size_t cnt = 0; cnt < block_list_length(); cnt++)
1382 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1383 each and every iteration. This increases the overhead in the
1384 program, because the compiler has to look up the function each
1385 time, call it, and return a value. Depending on what occurs in
1386 the block_list_length() call, it might even be creating and
1387 destroying structures with each iteration, even though in each
1388 case it is comparing "cnt" to the same value, over and over.
1389 Remember too - even a call to block_list_length() is a function
1390 call, with the same overhead.</para>
1392 <para>Instead of using a function call during the iterations,
1393 assign the value to a variable, and evaluate using the
1396 <para><emphasis>Example:</emphasis></para>
1398 size_t len = block_list_length();
1400 for (size_t cnt = 0; cnt < len; cnt++)
1405 <para><emphasis>Exceptions:</emphasis> if the value of block_list_length()
1406 *may* change or could *potentially* change, then you must code the
1407 function call in the for/while loop.</para>
1413 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1415 <para><emphasis>Explanation:</emphasis></para>
1417 <para>This allows a developer to define a const pointer and call
1418 your function. If your function does not have the const
1419 keyword, we may not be able to use your function. Consider
1420 strcmp, if it were defined as: extern int strcmp(char *s1,
1423 <para>I could then not use it to compare argv's in main: int
1424 main(int argc, const char *argv[]) { strcmp(argv[0], "privoxy");
1427 <para>Both these pointers are *const*! If the c runtime library
1428 maintainers do it, we should too.</para>
1434 <sect3 id="s30"><title>Pass and Return by Value</title>
1436 <para><emphasis>Explanation:</emphasis></para>
1438 <para>Most structures cannot fit onto a normal stack entry (i.e.
1439 they are not 4 bytes or less). Aka, a function declaration
1440 like: int load_aclfile(struct client_state csp)</para>
1442 <para>would not work. So, to be consistent, we should declare all
1443 prototypes with "pass by value": int load_aclfile(struct
1444 client_state *csp)</para>
1450 <sect3 id="s31"><title>Names of include files</title>
1452 <para><emphasis>Explanation:</emphasis></para>
1454 <para>Your include statements should contain the file name without
1455 a path. The path should be listed in the Makefile, using -I as
1456 processor directive to search the indicated paths. An exception
1457 to this would be for some proprietary software that utilizes a
1458 partial path to distinguish their header files from system or
1459 other header files.</para>
1461 <para><emphasis>Example:</emphasis></para>
1463 #include <iostream.h> /* This is not a local include */
1464 #include "config.h" /* This IS a local include */
1467 <para><emphasis>Exception:</emphasis></para>
1471 /* This is not a local include, but requires a path element. */
1472 #include <sys/fileName.h>
1476 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1477 without a _very_ good reason. This duplicates the #include
1478 "file.h" behavior.</para>
1484 <sect3 id="s32"><title>Provide multiple inclusion
1487 <para><emphasis>Explanation:</emphasis></para>
1489 <para>Prevents compiler and linker errors resulting from
1490 redefinition of items.</para>
1492 <para>Wrap each header file with the following syntax to prevent
1493 multiple inclusions of the file. Of course, replace PROJECT_H
1494 with your file name, with "." Changed to "_", and make it
1497 <para><emphasis>Example:</emphasis></para>
1499 #ifndef PROJECT_H_INCLUDED
1500 #define PROJECT_H_INCLUDED
1502 #endif /* ndef PROJECT_H_INCLUDED */
1507 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1509 <para><emphasis>Explanation:</emphasis></para>
1511 <para>If our headers are included from C++, they must declare our
1512 functions as `extern "C"`. This has no cost in C, but increases
1513 the potential re-usability of our code.</para>
1515 <para><emphasis>Example:</emphasis></para>
1520 #endif /* def __cplusplus */
1522 ... function definitions here ...
1526 #endif /* def __cplusplus */
1531 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1532 Declaration Instead of Includes</title>
1534 <para><emphasis>Explanation:</emphasis></para>
1536 <para>Useful in headers that include pointers to other struct's.
1537 Modifications to excess header files may cause needless
1540 <para><emphasis>Example:</emphasis></para>
1542 /*********************************************************************
1543 * We're avoiding an include statement here!
1544 *********************************************************************/
1546 extern file_list *xyz;</programlisting>
1548 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1549 pointer), then including the proper header file is necessary.
1550 If you only want to prototype a pointer, however, the header
1551 file is unnecessary.</para>
1553 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1559 <sect2 id="s35"><title>General Coding Practices</title>
1563 <sect3 id="s36"><title>Turn on warnings</title>
1565 <para><emphasis>Explanation</emphasis></para>
1567 <para>Compiler warnings are meant to help you find bugs. You
1568 should turn on as many as possible. With GCC, the switch is
1569 "-Wall". Try and fix as many warnings as possible.</para>
1575 <sect3 id="s37"><title>Provide a default case for all switch
1578 <para><emphasis>Explanation:</emphasis></para>
1580 <para>What you think is guaranteed is never really guaranteed. The
1581 value that you don't think you need to check is the one that
1582 someday will be passed. So, to protect yourself from the
1583 unknown, always have a default step in a switch statement.</para>
1585 <para><emphasis>Example:</emphasis></para>
1587 switch (hash_string(cmd))
1589 case hash_actions_file:
1599 ... anomaly code goes here ...
1600 continue; / break; / exit( 1 ); / etc ...
1602 } /* end switch (hash_string(cmd)) */</programlisting>
1604 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1605 are obviously exempt from this point. Of note, most of the
1606 WIN32 code calls `DefWindowProc' after the switch statement.
1607 This API call *should* be included in a default statement.</para>
1609 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1610 as a robust programming issue. The "anomaly code goes here" may
1611 be no more than a print to the STDERR stream (as in
1612 load_config). Or it may really be an abort condition.</para>
1614 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1620 <sect3 id="s38"><title>Try to avoid falling through cases in a
1621 switch statement.</title>
1623 <para><emphasis>Explanation:</emphasis></para>
1625 <para>In general, you will want to have a 'break' statement within
1626 each 'case' of a switch statement. This allows for the code to
1627 be more readable and understandable, and furthermore can
1628 prevent unwanted surprises if someone else later gets creative
1629 and moves the code around.</para>
1631 <para>The language allows you to plan the fall through from one
1632 case statement to another simply by omitting the break
1633 statement within the case statement. This feature does have
1634 benefits, but should only be used in rare cases. In general,
1635 use a break statement for each case statement.</para>
1637 <para>If you choose to allow fall through, you should comment both
1638 the fact of the fall through and reason why you felt it was
1645 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1647 <para><emphasis>Explanation:</emphasis></para>
1649 <para>The type of size_t varies across platforms. Do not make
1650 assumptions about whether it is signed or unsigned, or about
1651 how long it is. Do not compare a size_t against another
1652 variable of a different type (or even against a constant)
1653 without casting one of the values.</para>
1659 <sect3 id="s41"><title>Declare each variable and struct on its
1662 <para><emphasis>Explanation:</emphasis></para>
1664 <para>It can be tempting to declare a series of variables all on
1665 one line. Don't.</para>
1667 <para><emphasis>Example:</emphasis></para>
1671 long c = 0;</programlisting>
1673 <para><emphasis>Instead of:</emphasis></para>
1675 <para>long a, b, c;</para>
1677 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1678 individual variables - easier to add new variables without
1679 messing up the original ones - when searching on a variable to
1680 find its type, there is less clutter to "visually"
1683 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1684 variables or other trivial variables; feel free to declare them
1685 on one line. You should, although, provide a good comment on
1686 their functions.</para>
1688 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1694 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1696 <para><emphasis>Explanation:</emphasis></para>
1698 <para>Create a local struct (on the stack) if the variable will
1699 live and die within the context of one function call.</para>
1701 <para>Only "malloc" a struct (on the heap) if the variable's life
1702 will extend beyond the context of one function call.</para>
1704 <para><emphasis>Example:</emphasis></para>
1706 If a function creates a struct and stores a pointer to it in a
1707 list, then it should definitely be allocated via `malloc'.
1712 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1713 Responsible for Ensuring 'free'</title>
1715 <para><emphasis>Explanation:</emphasis></para>
1717 <para>If you have to "malloc" an instance, you are responsible for
1718 insuring that the instance is `free'd, even if the deallocation
1719 event falls within some other programmer's code. You are also
1720 responsible for ensuring that deletion is timely (i.e. not too
1721 soon, not too late). This is known as "low-coupling" and is a
1722 "good thing (tm)". You may need to offer a
1723 free/unload/destructor type function to accommodate this.</para>
1725 <para><emphasis>Example:</emphasis></para>
1727 int load_re_filterfile(struct client_state *csp) { ... }
1728 static void unload_re_filterfile(void *f) { ... }</programlisting>
1730 <para><emphasis>Exceptions:</emphasis></para>
1732 <para>The developer cannot be expected to provide `free'ing
1733 functions for C run-time library functions ... such as
1736 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1737 standard is for allocating and freeing data structures (complex
1744 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1745 and in order</title>
1747 <para><emphasis>Explanation:</emphasis></para>
1749 <para>I have ordered all of the "blocker" file code to be in alpha
1750 order. It is easier to add/read new blockers when you expect a
1751 certain order.</para>
1753 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1754 places by POPUP tests coming before PCRS tests. But since
1755 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1756 it should come first.</para>
1762 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1763 existing code, use XXX</title>
1765 <para><emphasis>Explanation:</emphasis></para>
1767 <para>If you have enough confidence in new code or confidence in
1768 your changes, but are not *quite* sure of the repercussions,
1771 <para>/* XXX: this code has a logic error on platform XYZ, *
1772 attempting to fix */ #ifdef PLATFORM ...changed code here...
1777 <para>/* XXX: I think the original author really meant this...
1778 */ ...changed code here...</para>
1782 <para>/* XXX: new code that *may* break something else... */
1783 ...new code here...</para>
1785 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1786 be a "good thing (tm)", it will be easier to identify and
1787 include in the project (or conversely exclude from the
1795 <sect2 id="s46"><title>Addendum: Template for files and function
1796 comment blocks:</title>
1798 <para><emphasis>Example for file comments:</emphasis></para>
1800 const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
1801 /*********************************************************************
1803 * File : $S<!-- Break CVS Substitution -->ource$
1805 * Purpose : (Fill me in with a good description!)
1807 * Copyright : Written by and Copyright (C) 2001-2009
1808 * the Privoxy team. https://www.privoxy.org/
1810 * This program is free software; you can redistribute it
1811 * and/or modify it under the terms of the GNU General
1812 * Public License as published by the Free Software
1813 * Foundation; either version 2 of the License, or (at
1814 * your option) any later version.
1816 * This program is distributed in the hope that it will
1817 * be useful, but WITHOUT ANY WARRANTY; without even the
1818 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1819 * PARTICULAR PURPOSE. See the GNU General Public
1820 * License for more details.
1822 * The GNU General Public License should be included with
1823 * this file. If not, you can view it at
1824 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1825 * or write to the Free Software Foundation, Inc.,
1826 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1829 *********************************************************************/
1834 ...necessary include files for us to do our work...
1836 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1839 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1840 added to the "show-version" page. If this is a brand new
1841 creation by you, you are free to change the "Copyright" section
1842 to represent the rights you wish to maintain.</para>
1844 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1845 after the comment flower box is handy for (X|GNU)Emacs users to
1846 skip the verbiage and get to the heart of the code (via
1847 `forward-page' and `backward-page'). Please include it if you
1850 <para><emphasis>Example for file header comments:</emphasis></para>
1854 #define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
1855 /*********************************************************************
1857 * File : $S<!-- Break CVS Substitution -->ource$
1859 * Purpose : (Fill me in with a good description!)
1861 * Copyright : Written by and Copyright (C) 2001-2009
1862 * the Privoxy team. https://www.privoxy.org/
1864 * This program is free software; you can redistribute it
1865 * and/or modify it under the terms of the GNU General
1866 * Public License as published by the Free Software
1867 * Foundation; either version 2 of the License, or (at
1868 * your option) any later version.
1870 * This program is distributed in the hope that it will
1871 * be useful, but WITHOUT ANY WARRANTY; without even the
1872 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1873 * PARTICULAR PURPOSE. See the GNU General Public
1874 * License for more details.
1876 * The GNU General Public License should be included with
1877 * this file. If not, you can view it at
1878 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1879 * or write to the Free Software Foundation, Inc.,
1880 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1883 *********************************************************************/
1886 #include "project.h"
1892 ... function headers here ...
1895 /* Revision control strings from this header and associated .c file */
1896 extern const char FILENAME_rcs[];
1897 extern const char FILENAME_h_rcs[];
1904 #endif /* ndef _FILENAME_H */
1913 <para><emphasis>Example for function comments:</emphasis></para>
1915 /*********************************************************************
1917 * Function : FUNCTION_NAME
1919 * Description : (Fill me in with a good description!)
1922 * 1 : param1 = pointer to an important thing
1923 * 2 : x = pointer to something else
1925 * Returns : 0 => Ok, everything else is an error.
1927 *********************************************************************/
1928 int FUNCTION_NAME(void *param1, const char *x)
1936 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1937 able to parse our code to create a "self-documenting" web
1944 <!-- ~~~~~ New section ~~~~~ -->
1945 <sect1 id="testing"><title>Testing Guidelines</title>
1949 <!-- ~~~~~ New section ~~~~~ -->
1950 <sect2 id="testing-plan"><title>Testplan for releases</title>
1952 Explain release numbers. major, minor. developer releases. etc.
1954 <orderedlist numeration="arabic">
1956 Remove any existing rpm with rpm -e
1959 Remove any file that was left over. This includes (but is not limited to)
1961 <listitem><para>/var/log/privoxy</para></listitem>
1962 <listitem><para>/etc/privoxy</para></listitem>
1963 <listitem><para>/usr/sbin/privoxy</para></listitem>
1964 <listitem><para>/etc/init.d/privoxy</para></listitem>
1965 <listitem><para>/usr/doc/privoxy*</para></listitem>
1969 Install the rpm. Any error messages?
1971 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1972 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1973 autostart work?</para></listitem>
1974 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1975 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1979 <!-- XXX: Document how to write test reports and where to send them -->
1981 <!-- ~~~~~ New section ~~~~~ -->
1982 <sect2 id="fuzzing"><title>Fuzzing Privoxy</title>
1984 To make fuzzing more convenient, Privoxy can be configured
1985 with --enable-fuzz which will result in the --fuzz option
1989 Example (tested on ElectroBSD):
1992 # Compile Privoxy with instrumentation for afl
1993 $ export CC=afl-clang
1994 $ export CFLAGS="-fsanitize=address -ggdb"
1995 $ export CPPFLAGS=-I/usr/local/include/
1996 $ export LDFLAGS="-fsanitize=address -L/usr/local/lib"
1997 $ export AFL_USE_ASAN=1
1998 $ export AFL_HARDEN=1
1999 $ ./configure --with-debug --enable-extended-host-patterns --enable-accept-filter --enable-no-gifs --enable-compression --enable-strptime-sanity-checks --enable-external-filters --enable-fuzz
2002 Privoxy version 3.0.24 (http://www.privoxy.org/)
2003 Usage: ./privoxy [--config-test] [--chroot] [--help] [--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] [--version] [configfile]
2004 ./privoxy --fuzz fuzz-mode ./path/to/fuzzed/input [--stfu]
2006 Supported fuzz modes and the expected input:
2007 action: Text to parse as action file.
2008 client-request: Client request to parse. Currently incomplete
2009 client-header: Client header to parse.
2010 chunked-transfer-encoding: Chunk-encoded data to dechunk.
2011 deflate: deflate-compressed data to decompress.
2012 filter: Text to parse as filter file.
2013 gif: gif to deanimate.
2014 gzip: gzip-compressed data to decompress.
2015 pcrs-substitute: A pcrs-substitute to compile. Not a whole pcrs job! Example: Bla $1 bla C $3 blah.
2016 server-header: Server header to parse.
2017 server-response: Server response to parse.
2019 The following fuzz modes read data from stdin if the 'file' is '-'
2022 chunked-transfer-encoding
2032 $ export ASAN_OPTIONS='abort_on_error=1'
2033 $ mkdir input output
2034 $ echo '$1 bla fasel $2' > input/pcrs
2035 $ afl-fuzz -i input -o output -m none ~/git/privoxy/privoxy --fuzz pcrs-substitute - --stfu
2037 $ cat >input/pcrs.txt
2039 s@(.{1})[432](\d+)@$1$2$hostname@UgisT
2041 $ afl-fuzz -i input/ -o output/ -f bla.filter -m none privoxy --fuzz filter bla.filter --stfu
2046 <!-- ~~~~~ New section ~~~~~ -->
2047 <sect1 id="newrelease"><title>Releasing a New Version</title>
2049 When we release versions of <application>Privoxy</application>,
2050 our work leaves our cozy secret lab and has to work in the cold
2051 RealWorld[tm]. Once it is released, there is no way to call it
2052 back, so it is very important that great care is taken to ensure
2053 that everything runs fine, and not to introduce problems in the
2057 So when releasing a new version, please adhere exactly to the
2058 procedure outlined in this chapter.
2062 The following programs are required to follow this process:
2063 <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
2064 <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
2067 <sect2 id="versionnumbers">
2068 <title>Version numbers</title>
2071 First you need to determine which version number the release will have.
2072 <application>Privoxy</application> version numbers consist of three numbers,
2073 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
2077 X, the version major, is rarely ever changed. It is increased by one if
2078 turning a development branch into stable substantially changes the functionality,
2079 user interface or configuration syntax. Majors 1 and 2 were
2080 <application>Junkbuster</application>, and 3 will be the first stable
2081 <application>Privoxy</application> release.
2086 Y, the version minor, represents the branch within the major version.
2087 At any point in time, there are two branches being maintained:
2088 The stable branch, with an even minor, say, 2N, in which no functionality is
2089 being added and only bug-fixes are made, and 2N+1, the development branch, in
2090 which the further development of <application>Privoxy</application> takes
2092 This enables us to turn the code upside down and inside out, while at the same time
2093 providing and maintaining a stable version.
2094 The minor is reset to zero (and one) when the major is incremented. When a development
2095 branch has matured to the point where it can be turned into stable, the old stable branch
2096 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2097 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2102 Z, the point or sub version, represents a release of the software within a branch.
2103 It is therefore incremented immediately before each code freeze.
2104 In development branches, only the even point versions correspond to actual releases,
2105 while the odd ones denote the evolving state of the sources on CVS in between.
2106 It follows that Z is odd on CVS in development branches most of the time. There, it gets
2107 increased to an even number immediately before a code freeze, and is increased to an odd
2108 number again immediately thereafter.
2109 This ensures that builds from CVS snapshots are easily distinguished from released versions.
2110 The point version is reset to zero when the minor changes.
2113 Stable branches work a little differently, since there should be
2114 little to no development happening in such branches. Remember,
2115 only bugfixes, which presumably should have had some testing
2116 before being committed. Stable branches will then have their
2117 version reported as <literal>0.0.0</literal>, during that period
2118 between releases when changes are being added. This is to denote
2119 that this code is <emphasis>not for release</emphasis>. Then
2120 as the release nears, the version is bumped according: e.g.
2121 <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
2127 In summary, the main CVS trunk is the development branch where new
2128 features are being worked on for the next stable series. This should
2129 almost always be where the most activity takes place. There is always at
2130 least one stable branch from the trunk, e.g now it is
2131 <literal>3.0</literal>, which is only used to release stable versions.
2132 Once the initial *.0 release of the stable branch has been done, then as a
2133 rule, only bugfixes that have had prior testing should be committed to
2134 the stable branch. Once there are enough bugfixes to justify a new
2135 release, the version of this branch is again incremented Example: 3.0.0
2136 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
2137 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
2138 taking place. If any questions, please post to the devel list
2139 <emphasis>before</emphasis> committing to a stable branch!
2142 Developers should remember too that if they commit a bugfix to the stable
2143 branch, this will more than likely require a separate submission to the
2144 main trunk, since these are separate development trees within CVS. If you
2145 are working on both, then this would require at least two separate check
2146 outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
2147 which is <literal>v_3_0_branch</literal> at the moment).
2152 <sect2 id="beforerelease">
2153 <title>Before the Release: Freeze</title>
2155 The following <emphasis>must be done by one of the
2156 developers</emphasis> prior to each new release.
2162 Make sure that everybody who has worked on the code in the last
2163 couple of days has had a chance to yell <quote>no!</quote> in case
2164 they have pending changes/fixes in their pipelines. Announce the
2165 freeze so that nobody will interfere with last minute changes.
2170 Increment the version number (point from odd to even in development
2171 branches!) in <filename>configure.in</filename> and update the code
2172 status (CODE_STATUS="xxx") to one of "alpha", "beta" or "stable".
2173 Rebuild configure and GNUMakefile to make sure the updated values are
2179 Use the dok-release target to update the sgml documentation source files.
2184 If action file processing has changed and is not backward-compatible,
2185 make sure the "for-privoxy-version=x.y.z" minimum version number in
2186 default.action.master has been updated:
2189 #############################################################################
2190 #MASTER# COMMENT: The minimum Privoxy version:
2191 for-privoxy-version=3.0.11
2197 All documentation should be rebuild after the version bump.
2198 Finished docs should be then be committed to CVS (for those
2199 without the ability to build these). Some docs may require
2200 rather obscure processing tools. <filename>config</filename>,
2201 the man page (and the html version of the man page)
2202 fall in this category. README, the man page, AUTHORS, and config
2203 should all also be committed to CVS for other packagers. The
2204 formal docs should be uploaded to the webserver. See the
2205 Section "Updating the webserver" in this manual for details.
2210 The <citetitle>User Manual</citetitle> is also used for context
2211 sensitive help for the CGI editor. This is version sensitive, so that
2212 the user will get appropriate help for his/her release. So with
2213 each release a fresh version should be uploaded to the webserver
2214 (this is in addition to the main <citetitle>User Manual</citetitle>
2215 link from the main page since we need to keep manuals for various
2216 versions available). The CGI pages will link to something like
2217 <literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. This
2218 will need to be updated for each new release. There is no Makefile
2219 target for this at this time!!! It needs to be done manually.
2224 All developers should look at the <filename>ChangeLog</filename> and
2225 make sure noteworthy changes are referenced.
2230 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2235 Tag all files in CVS with the version number with
2236 <quote><command>cvs tag v_X_Y_Z</command></quote>.
2237 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2242 If the release was in a development branch, increase the point version
2243 from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
2249 On the webserver, copy the user manual to a new top-level directory
2250 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2251 pages, which have the version as a prefix, will go into the right version of the manual.
2252 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2253 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2254 <filename>.</filename> (i.e. dot).
2261 <sect2 id="therelease">
2262 <title>Building and Releasing the Packages</title>
2264 Now the individual packages can be built and released. Note that for
2265 GPL reasons the first package to be released is always the source tarball.
2269 For <emphasis>all</emphasis> types of packages, including the source tarball,
2270 <emphasis>you must make sure that you build from clean sources by exporting
2271 the right version from CVS into an empty directory</emphasis> (just press return when
2272 asked for a password):
2277 mkdir dist # delete or choose different name if it already exists
2279 cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
2280 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2285 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2286 version information after export from CVS. This is to make sure that
2287 all release packages, and with them, all future bug reports, are based
2288 on exactly the same code.
2293 Every significant release of Privoxy has included at least one
2294 package that either had incorrect versions of files, missing files,
2295 or incidental leftovers from a previous build process that gave
2296 unknown numbers of users headaches to try to figure out what was
2297 wrong. PLEASE, make sure you are using pristene sources, and are
2298 following the prescribed process!
2303 Please find additional instructions for the source tarball and the
2304 individual platform dependent binary packages below. And details
2305 on the Sourceforge release process below that.
2308 <sect3 id="pack-guidelines">
2309 <title>Note on Privoxy Packaging</title>
2311 Please keep these general guidelines in mind when putting together
2312 your package. These apply to <emphasis>all</emphasis> platforms!
2318 <application>Privoxy</application> <emphasis>requires</emphasis>
2319 write access to: all <filename>*.action</filename> files, all
2320 logfiles, and the <filename>trust</filename> file. You will
2321 need to determine the best way to do this for your platform.
2326 Please include up to date documentation. At a bare minimum:
2330 <filename>LICENSE</filename> (top-level directory)
2335 <filename>README</filename> (top-level directory)
2340 <filename>AUTHORS</filename> (top-level directory)
2345 <filename>man page</filename> (top-level directory, Unix-like
2351 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2356 <filename>FAQ</filename> (doc/webserver/faq/)
2360 Also suggested: <filename>Developer Manual</filename>
2361 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2362 (top-level directory). <filename>FAQ</filename> and the manuals are
2363 HTML docs. There are also text versions in
2364 <filename>doc/text/</filename> which could conceivably also be
2368 The documentation has been designed such that the manuals are linked
2369 to each other from parallel directories, and should be packaged
2370 that way. <filename>privoxy-index.html</filename> can also be
2371 included and can serve as a focal point for docs and other links of
2372 interest (and possibly renamed to <filename>index.html</filename>).
2373 This should be one level up from the manuals. There is a link also
2374 on this page to an HTMLized version of the man page. To avoid 404 for
2375 this, it is in CVS as
2376 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2377 and should be included along with the manuals. There is also a
2378 css stylesheets that can be included for better presentation:
2379 <filename>p_doc.css</filename>. This should be in the same directory
2380 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2381 the manual directories).
2386 <filename>user.action</filename> and <filename>user.filter</filename>
2387 are designed for local preferences. Make sure these do not get overwritten!
2388 <filename>config</filename> should not be overwritten either. This
2389 has especially important configuration data in it.
2390 <filename>trust</filename> should be left in tact as well.
2395 Other configuration files (<filename>default.action</filename> and
2396 <filename>default.filter</filename>) should be installed as the new
2397 defaults, but all previously installed configuration files should be
2398 preserved as backups. This is just good manners :-) These files are
2399 likely to change between releases and contain important new features
2405 Please check platform specific notes in this doc, if you haven't
2406 done <quote>Privoxy</quote> packaging before for other platform
2407 specific issues. Conversely, please add any notes that you know
2408 are important for your platform (or contact one of the doc
2409 maintainers to do this if you can't).
2414 Packagers should do a <quote>clean</quote> install of their
2415 package after building it. So any previous installs should be
2416 removed first to ensure the integrity of the newly built package.
2417 Then run the package for a while to make sure there are no
2418 obvious problems, before uploading.
2427 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2429 First, <emphasis>make sure that you have freshly exported the right
2430 version into an empty directory</emphasis>. (See "Building and releasing
2431 packages" above). Then run:
2436 autoheader && autoconf && ./configure
2448 To upload the package to Sourceforge, simply issue
2456 Go to the displayed URL and release the file publicly on Sourceforge.
2457 For the change log field, use the relevant section of the
2458 <filename>ChangeLog</filename> file.
2462 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2464 In following text, replace <replaceable class="parameter">dist</replaceable>
2465 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2468 First, <emphasis>make sure that you have freshly exported the right
2469 version into an empty directory</emphasis>. (See "Building and releasing
2473 As the only exception to not changing anything after export from CVS,
2474 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2475 and make sure that the version information and the RPM release number are
2476 correct. The RPM release numbers for each version start at one. Hence it must
2477 be reset to one if this is the first RPM for
2478 <replaceable class="parameter">dist</replaceable> which is built from version
2480 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">file
2481 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2482 release number for that version plus one.
2490 autoheader && autoconf && ./configure
2498 make <replaceable class="parameter">dist</replaceable>-dist
2502 To upload the package to Sourceforge, simply issue
2506 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2510 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2511 RPM release number as determined above.
2512 Go to the displayed URL and release the file publicly on Sourceforge.
2513 Use the release notes and change log from the source tarball package.
2517 <sect3 id="newrelease-os2"><title>OS/2</title>
2519 First, <emphasis>make sure that you have freshly exported the right
2520 version into an empty directory</emphasis>. (See "Building and releasing
2521 packages" above). Then get the OS/2 Setup module:
2525 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
2529 You will need a mix of development tools.
2530 The main compilation takes place with IBM Visual Age C++.
2531 Some ancillary work takes place with GNU tools, available from
2532 various sources like hobbes.nmsu.edu.
2533 Specificially, you will need <filename>autoheader</filename>,
2534 <filename>autoconf</filename> and <filename>sh</filename> tools.
2535 The packaging takes place with WarpIN, available from various sources, including
2536 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2539 Change directory to the <filename>os2setup</filename> directory.
2540 Edit the os2build.cmd file to set the final executable filename.
2545 installExeName='privoxyos2_setup_X.Y.Z.exe'
2549 Next, edit the <filename>IJB.wis</filename> file so the release number matches
2550 in the <filename>PACKAGEID</filename> section:
2554 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2558 You're now ready to build. Run:
2566 You will find the WarpIN-installable executable in the
2567 <filename>./files</filename> directory. Upload this anonymously to
2568 <filename>uploads.sourceforge.net/incoming</filename>, create a release
2569 for it, and you're done. Use the release notes and Change Log from the
2570 source tarball package.
2574 <sect3 id="newrelease-solaris"><title>Solaris</title>
2576 Login to Sourceforge's compilefarm via ssh:
2580 ssh cf.sourceforge.net
2584 Choose the right operating system (not the Debian one).
2585 When logged in, <emphasis>make sure that you have freshly exported the right
2586 version into an empty directory</emphasis>. (See "Building and releasing
2587 packages" above). Then run:
2592 autoheader && autoconf && ./configure
2604 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2605 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2606 to manually upload the archive to Sourceforge's ftp server and release
2607 the file publicly. Use the release notes and Change Log from the
2608 source tarball package.
2612 <sect3 id="newrelease-windows"><title>Windows</title>
2614 Use the <ulink url="http://www.fruitbat.org/Cygwin/index.html#cygwincirca">
2615 Cygwin Time Machine</ulink> to install the last 1.5 version of Cygwin.
2616 Run the following commands from within the Cygwin 1.5 bash shell.
2619 First, <emphasis>make sure that you have freshly exported the right
2620 version into an empty directory</emphasis>. (See "Building and releasing
2621 packages" above). Then get the Windows setup module:
2625 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
2629 Then you can build the package. This is fully automated, and is
2630 controlled by <filename>winsetup/GNUmakefile</filename>.
2631 All you need to do is:
2640 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2641 <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
2642 SourceForge. When releasing the package on SourceForge, use the release notes
2643 and Change Log from the source tarball package.
2647 <sect3 id="newrelease-debian"><title>Debian</title>
2649 First, <emphasis>make sure that you have freshly exported the
2650 right version into an empty directory</emphasis>. (See
2651 "Building and releasing packages" above). Then add a log
2652 entry to <filename>debian/changelog</filename>, if it is not
2653 already there, for example by running:
2657 debchange -v &p-version;-&p-status;-1 "New upstream version"
2665 dpkg-buildpackage -rfakeroot -us -uc -b
2670 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2671 which can be uploaded. To upload the package to Sourceforge, simply
2681 <sect3 id="newrelease-macosx"><title>Mac OS X</title>
2683 First, <emphasis>make sure that you have freshly exported the right
2684 version into an empty directory</emphasis>. (See "Building and releasing
2688 There are three modules available in the CVS repository for use on Mac
2689 OS X, though technically only two of them generate a release (the other
2690 can be used to install from source).
2692 <sect4 id="OS-X-OSXPackageBuilder-module">
2693 <title>OSXPackageBuilder module</title>
2695 The OSXPackageBuilder module generates OS X installer packages
2696 supporting all Macs running OS X 10.4 and above. Obtain it from CVS as
2697 follows into a folder parallel to the exported privoxy source:
2699 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
2703 The module contains complete instructions on its usage in the file
2704 <filename>OS X Package Builder HOWTO.txt</filename>.
2707 Once the package(s) have been generated, you can then upload them
2708 directly to the Files section of the Sourceforge project in the
2709 Macintosh (OS X) folder. Each new version release of Privoxy should
2710 have a new subfolder created in which to store its files. Please
2711 ensure that the folder contains a readme file that makes it clear
2712 which package is for whichversion of OS X.
2715 <sect4 id="OS-X-osxsetup-module">
2716 <title>osxsetup module (DEPRECATED)</title>
2718 <emphasis>This module is deprecated since the installer it generates
2719 places all Privoxy files in one folder in a non-standard location, and
2720 supports only Intel Macs running OS X 10.6 or higher.</emphasis>
2723 Check out the module from CVS as follows into a folder parallel to the
2724 exported privoxy source:
2726 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
2739 This will run <filename>autoheader</filename>, <filename>autoconf</filename>
2740 and <filename>configure</filename> as well as <filename>make</filename>.
2741 Finally, it will copy over the necessary files to the ./osxsetup/files
2742 directory for further processing by <filename>PackageMaker</filename>.
2745 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
2746 modify the package name to match the release, and hit the "Create
2747 package" button. If you specify ./Privoxy.pkg as the output package
2748 name, you can then create the distributable zip file with the command:
2752 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2756 You can then upload this file directly to the Files section of the
2757 Sourceforge project in the Macintosh (OS X) folder. Each new version
2758 release of Privoxy should have a new subfolder created in which to
2760 Please ensure that the folder contains a readme file that makes it
2761 clear which version(s) of OS X the package supports.
2764 <sect4 id="OS-X-macsetup-module">
2765 <title>macsetup module</title>
2767 The macsetup module is ideal if you wish to build and install Privoxy
2768 from source on a single machine.
2771 Check out the module from CVS as follows into a folder parallel to the
2772 exported privoxy source:
2774 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
2778 The module contains complete instructions on its usage in its
2779 <filename>README</filename> file. The end result will be the
2780 exported version of Privoxy installed on the build machine.
2785 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2787 Update the www/privoxy port and submit a diff upstream.
2788 For details see the <ulink url="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/">FreeBSD Porter's Handbook</ulink>.
2793 <sect2 id="releasing">
2794 <title>Uploading and Releasing Your Package</title>
2796 After the package is ready, it is time to upload it
2797 to SourceForge, and go through the release steps. The upload
2804 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2809 user: <literal>anonymous</literal>
2814 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2820 Or use the <command>make</command> targets as described above.
2823 Once this done go to <ulink
2824 url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
2825 >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
2826 making sure you are logged in. Find your target platform in the
2827 second column, and click <literal>Add Release</literal>. You will
2828 then need to create a new release for your package, using the format
2829 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2833 Now just follow the prompts. Be sure to add any appropriate Release
2834 notes. You should see your freshly uploaded packages in
2835 <quote>Step 2. Add Files To This Release</quote>. Check the
2836 appropriate box(es). Remember at each step to hit the
2837 <quote>Refresh/Submit</quote> buttons! You should now see your
2838 file(s) listed in Step 3. Fill out the forms with the appropriate
2839 information for your platform, being sure to hit <quote>Update</quote>
2840 for each file. If anyone is monitoring your platform, check the
2841 <quote>email</quote> box at the very bottom to notify them of
2842 the new package. This should do it!
2845 If you have made errors, or need to make changes, you can go through
2846 essentially the same steps, but select <literal>Edit Release</literal>,
2847 instead of <literal>Add Release</literal>.
2851 <sect2 id="afterrelease">
2852 <title>After the Release</title>
2854 When all (or: most of the) packages have been uploaded and made available,
2855 send an email to the <ulink url="mailto:privoxy-announce@lists.privoxy.org">announce
2856 mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2858 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">download
2859 location</ulink>, the release notes and the Changelog. Also, post an
2860 updated News item on the project page Sourceforge, and update the Home
2861 page and docs linked from the Home page (see below). Other news sites
2862 and release oriented sites, such as Freshmeat, should also be notified.
2868 <!-- ~~~~~ New section ~~~~~ -->
2869 <sect1 id="webserver-update"><title>Update the Webserver</title>
2871 The webserver should be updated at least with each stable release. When
2872 updating, please follow these steps to make sure that no broken links,
2873 inconsistent contents or permission problems will occur (as it has many
2874 times in the past!):
2877 If you have changed anything in the stable-branch documentation source
2886 That will generate <filename>doc/webserver/user-manual</filename>,
2887 <filename>doc/webserver/developer-manual</filename>,
2888 <filename>doc/webserver/faq</filename>,
2889 <filename>doc/webserver/index.html</filename> automatically.
2892 If you changed the manual page sources, generate
2893 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2894 by running <quote><command>make man</command></quote>. (This is
2895 a separate target due to dependencies on some obscure perl scripts
2896 [now in CVS, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
2899 If you want to add new files to the webserver, create them locally in
2900 the <filename>doc/webserver/*</filename> directory (or
2901 create new directories under <filename>doc/webserver</filename>).
2904 Next, commit any changes from the above steps to CVS. All set?
2905 If these are docs in the stable branch, then do:
2913 This will do the upload to <ulink url="https://www.privoxy.org/">the
2914 webserver</ulink> (www.privoxy.org) and ensure all files and directories
2915 there are group writable.
2918 Please do <emphasis>NOT</emphasis> use any other means of transferring
2919 files to the webserver to avoid permission problems. Also, please do not
2920 upload docs from development branches or versions. The publicly posted
2921 docs should be in sync with the last official release.
2927 This program is free software; you can redistribute it
2928 and/or modify it under the terms of the GNU General
2929 Public License as published by the Free Software
2930 Foundation; either version 2 of the License, or (at
2931 your option) any later version.
2933 This program is distributed in the hope that it will
2934 be useful, but WITHOUT ANY WARRANTY; without even the
2935 implied warranty of MERCHANTABILITY or FITNESS FOR A
2936 PARTICULAR PURPOSE. See the GNU General Public
2937 License for more details.
2939 The GNU General Public License should be included with
2940 this file. If not, you can view it at
2941 http://www.gnu.org/copyleft/gpl.html
2942 or write to the Free Software Foundation, Inc., 59
2943 Temple Place - Suite 330, Boston, MA 02111-1307, USA.