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.25">
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.67 2016/02/26 12:27:32 fabiankeil Exp $
26 Copyright (C) 2001-2016 Privoxy Developers http://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="http://www.privoxy.org/user-manual/copyright.html">Copyright</ulink>
46 &my-copy; 2001-2016 by
47 <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
52 <pubdate>$Id: developer-manual.sgml,v 2.67 2016/02/26 12:27:32 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="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
102 Please have a look at the
103 <ulink url="http://www.privoxy.org/user-manual/contact.html">contact section in the user manual</ulink>
104 if you are interested in contacting the developers.
107 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
114 <!-- ~~~~~ New section ~~~~~ -->
115 <sect1 id="introduction"><title>Introduction</title>
118 I don't like seeing blank space :) So added *something* here.
122 <application>Privoxy</application>, as an heir to
123 <application>Junkbuster</application>, is a Free Software project
124 and the code is licensed under the GNU General Public License version 2.
125 As such, <application>Privoxy</application> development is potentially open
126 to anyone who has the time, knowledge, and desire to contribute
127 in any capacity. Our goals are simply to continue the mission,
128 to improve <application>Privoxy</application>, and
129 to make it available to as wide an audience as possible.
132 One does not have to be a programmer to contribute. Packaging, testing,
133 documenting and porting, are all important jobs as well.
136 <!-- ~~~~~ New section ~~~~~ -->
137 <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
139 The first step is to join the <ulink
140 url="mailto:ijbswa-developers@lists.sourceforge.net">developer's mailing list</ulink>.
141 You can submit your ideas, or even better patches. Patches are best
142 submitted to the Sourceforge tracker set up for this purpose, but
143 can be sent to the list for review too.
146 You will also need to have a cvs package installed, which will
147 entail having ssh installed as well (which seems to be a requirement of
148 SourceForge), in order to access the cvs repository. Having the GNU build
149 tools is also going to be important (particularly, autoconf and gmake).
152 For the time being (read, this section is under construction), you can
153 also refer to the extensive comments in the source code. In fact,
154 reading the code is recommended in any case.
159 <!-- ~~~~~ New section ~~~~~ -->
160 <sect1 id="cvs"><title>The CVS Repository</title>
162 If you become part of the active development team, you will eventually
163 need write access to our holy grail, the CVS repository. One of the
164 team members will need to set this up for you. Please read
165 this chapter completely before accessing via CVS.
168 <sect2 id="cvsaccess"><title>Access to CVS</title>
170 The project's CVS repository is hosted on
171 <ulink url="https://sourceforge.net/">SourceForge.</ulink>
172 For historical reasons, the CVS server is
173 called <literal>ijbswa.cvs.sourceforge.net</literal>, the repository is
174 called <literal>ijbswa</literal>, and the source tree module is called
175 <literal>current</literal>.
179 <sect2 id="cvsbranches">
180 <title>Branches</title>
182 Within the CVS repository, there are modules and branches. As
183 mentioned, the sources are in the <literal>current</literal>
184 <quote>module</quote>. Other modules are present for platform specific
185 issues. There is a webview of the CVS hierarchy at <ulink
186 url="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/"
187 >http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/</ulink>,
188 which might help with visualizing how these pieces fit together.
192 Branches are used to fork a sub-development path from the main trunk.
193 Within the <literal>current</literal> module where the sources are, there
194 is always at least one <quote>branch</quote> from the main trunk
195 devoted to a stable release series. The main trunk is where active
196 development takes place for the next stable series (e.g. 3.2.x).
197 So just prior to each stable series (e.g. 3.0.x), a branch is created
198 just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
199 Once the initial stable release of any stable branch has taken place,
200 this branch is <emphasis>only used for bugfixes</emphasis>, which have
201 had prior testing before being committed to CVS. (See <link
202 linkend="versionnumbers">Version Numbers</link> below for details on
207 At one time there were two distinct branches: stable and unstable. The
208 more drastic changes were to be in the unstable branch. These branches
209 have now been merged to minimize time and effort of maintaining two
214 This will result in at least two active branches, which means there may
215 be occasions that require the same (or similar) item to be
216 checked into to two different places (assuming its a bugfix and needs
217 fixing in both the stable and unstable trees). This also means that in
218 order to have access to both trees, both will have to be checked out
219 separately. Use the <literal>cvs -r</literal> flag to check out a
220 branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
225 <sect2 id="cvscommit"><title>CVS Commit Guidelines</title>
227 The source tree is the heart of every software project. Every effort must
228 be made to ensure that it is readable, compilable and consistent at all
229 times. <!-- There are differing guidelines for the stable branch and the
230 main development trunk, and --> We expect anyone with CVS access to strictly
231 adhere to the following guidelines:
235 Basic Guidelines, for all branches:
240 Please don't commit even
241 a small change without testing it thoroughly first. When we're
242 close to a public release, ask a fellow developer to review your
246 Your commit message should give a concise overview of <emphasis>what you
247 changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
248 Just check previous messages for good examples.
251 Don't use the same message on multiple files, unless it equally applies to
255 If your changes span multiple files, and the code won't recompile unless
256 all changes are committed (e.g. when changing the signature of a function),
257 then commit all files one after another, without long delays in between.
258 If necessary, prepare the commit messages in advance.
261 Before changing things on CVS, make sure that your changes are in line
262 with the team's general consensus on what should be done.
266 Note that near a major public release, we get more cautious.
267 There is always the possibility to submit a patch to the <ulink
268 url="https://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patch
269 tracker</ulink> instead.
277 Stable branches are handled with more care, especially after the
278 initial *.*.0 release, and we are just in bugfix mode. In addition to
279 the above, the below applies only to the stable branch (currently the
280 <literal>v_3_0_branch</literal> branch):
287 Do not commit <emphasis>anything</emphasis> unless your proposed
288 changes have been well tested first, preferably by other members of the
289 project, or have prior approval of the project leaders or consensus
295 Where possible, bugfixes and changes should be tested in the main
296 development trunk first. There may be occasions where this is not
302 Alternately, proposed changes can be submitted as patches to the patch tracker on
303 Sourceforge first: <ulink
304 url="https://sourceforge.net/tracker/?group_id=11118&atid=311118">https://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
305 Then ask for peer review.
310 Do not even think about anything except bugfixes. No new features!
321 <!-- ~~~~~ New section ~~~~~ -->
322 <sect1 id="documentation"><title>Documentation Guidelines</title>
324 All formal documents are maintained in Docbook SGML and located in the
325 <computeroutput>doc/source/*</computeroutput> directory. You will need
326 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
327 DTD's and the Docbook modular stylesheets (or comparable alternatives),
328 and either <application>jade</application> or
329 <application>openjade</application> (recommended) installed in order to
330 build docs from source. Currently there is <ulink
331 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
332 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
333 course this, the <citetitle>developer-manual</citetitle> in this format.
334 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
335 <citetitle>INSTALL</citetitle>,
336 <citetitle>privoxy.1</citetitle> (man page), and
337 <citetitle>config</citetitle> files are also now maintained as Docbook
338 SGML. These files, when built, in the top-level source directory are
339 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
340 variation on this file, <filename>privoxy-index.html</filename>,
341 meant for inclusion with doc packages), are maintained as SGML as well.
342 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
343 contact someone involved in the documentation.
346 <filename>config</filename> requires some special handling. The reason it
347 is maintained this way is so that the extensive comments in the file
348 mirror those in <citetitle>user-manual</citetitle>. But the conversion
349 process requires going from SGML to HTML to text to special formatting
350 required for the embedded comments. Some of this does not survive so
351 well. Especially some of the examples that are longer than 80 characters.
352 The build process for this file outputs to <filename>config.new</filename>,
353 which should be reviewed for errors and mis-formatting. Once satisfied
354 that it is correct, then it should be hand copied to
355 <filename>config</filename>.
358 Other, less formal documents (e.g. <filename>LICENSE</filename>) are
359 maintained as plain text files in the top-level source directory.
362 Packagers are encouraged to include this documentation. For those without
363 the ability to build the docs locally, text versions of each are kept in
364 CVS. HTML versions are also being kept in CVS under
365 <filename>doc/webserver/*</filename>.
368 Formal documents are built with the Makefile targets of
369 <computeroutput>make dok</computeroutput>.
370 The build process uses the document SGML sources in
371 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
372 <computeroutput>doc/text/</computeroutput> and to update all HTML
373 documents in <computeroutput>doc/webserver/</computeroutput>.
376 Documentation writers should please make sure documents build
377 successfully before committing to CVS, if possible.
380 How do you update the webserver (i.e. the pages on privoxy.org)?
382 <orderedlist numeration="arabic">
384 First, build the docs by running <computeroutput>make
385 dok</computeroutput>.
388 Run <computeroutput>make webserver</computeroutput> which copies all
389 files from <computeroutput>doc/webserver</computeroutput> to the
390 sourceforge webserver via scp.
396 Finished docs should be occasionally submitted to CVS
397 (<filename>doc/webserver/*/*.html</filename>) so that those without
398 the ability to build them locally, have access to them if needed.
399 This is especially important just prior to a new release! Please
400 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
401 other release specific data in <filename>configure.in</filename> has been
402 updated (this is done just prior to a new release).
405 <!-- ~~~~~ New section ~~~~~ -->
407 <title>Quickstart to Docbook and SGML</title>
409 If you are not familiar with SGML, it is a markup language similar to HTML.
410 Actually, not a mark up language per se, but a language used to define
411 markup languages. In fact, HTML is an SGML application. Both will use
412 <quote>tags</quote> to format text and other content. SGML tags can be much
413 more varied, and flexible, but do much of the same kinds of things. The tags,
414 or <quote>elements</quote>, are definable in SGML. There is no set
415 <quote>standards</quote>. Since we are using
416 <application>Docbook</application>, our tags are those that are defined by
417 <application>Docbook</application>. Much of how the finish document is
418 rendered is determined by the <quote>stylesheets</quote>.
419 The stylesheets determine how each tag gets translated to HTML, or other
424 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
425 will likely generate errors. Example: <literal><title>My
426 Title</title></literal>. They are also case-insensitive, but we
427 strongly suggest using all lower case. This keeps compatibility with
428 [Docbook] <application>XML</application>.
432 Our documents use <quote>sections</quote> for the most part. Sections
433 will be processed into HTML headers (e.g. <literal>h1</literal> for
434 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
435 will use these to also generate the Table of Contents for each doc. Our
436 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
437 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
438 entries, but <literal>sect4</literal> will not. Each section requires
439 a <literal><title></literal> element, and at least one
440 <literal><para></literal>. There is a limit of five section
441 levels in Docbook, but generally three should be sufficient for our
446 Some common elements that you likely will use:
452 <emphasis><para></para></emphasis>, paragraph delimiter. Most
453 text needs to be within paragraph elements (there are some exceptions).
456 <emphasis><emphasis></emphasis></emphasis>, the stylesheets
460 <emphasis><filename></filename></emphasis>, files and directories.
463 <emphasis><command></command></emphasis>, command examples.
466 <emphasis><literallayout></literallayout></emphasis>, like
467 <literal><pre></literal>, more or less.
470 <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
473 <emphasis><listitem></listitem></emphasis>, member of the above.
476 <emphasis><screen></screen></emphasis>, screen output, implies
477 <literal><literallayout></literal>.
480 <emphasis><ulink url="example.com"></ulink></emphasis>, like
481 HTML <literal><a></literal> tag.
484 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
490 Look at any of the existing docs for examples of all these and more.
494 You might also find <quote><ulink
495 url="http://opensource.bureau-cornavin.com/crash-course/index.html">Writing Documentation
496 Using DocBook - A Crash Course</ulink></quote> useful.
500 <!-- ~~~~~ New section ~~~~~ -->
501 <sect2 id="docstyle">
502 <title><application>Privoxy</application> Documentation Style</title>
504 It will be easier if everyone follows a similar writing style. This
505 just makes it easier to read what someone else has written if it
506 is all done in a similar fashion.
515 All tags should be lower case.
520 Tags delimiting a <emphasis>block</emphasis> of text (even small
521 blocks) should be on their own line. Like:
527 Tags marking individual words, or few words, should be in-line:
529 Just to <emphasis>emphasize</emphasis>, some text goes here.
535 Tags should be nested and step indented for block text like: (except
542 Some text goes here in our list example.
545 </itemizedlist>
548 This makes it easier to find the text amongst the tags ;-)
553 Use white space to separate logical divisions within a document,
554 like between sections. Running everything together consistently
555 makes it harder to read and work on.
560 Do not hesitate to make comments. Comments can either use the
561 <comment> element, or the <!-- --> style comment
562 familiar from HTML. (Note in Docbook v4.x <comment> is
563 replaced by <remark>.)
568 We have an international audience. Refrain from slang, or English
569 idiosyncrasies (too many to list :). Humor also does not translate
575 Try to keep overall line lengths in source files to 80 characters or less
576 for obvious reasons. This is not always possible, with lengthy URLs for
582 Our documents are available in differing formats. Right now, they
583 are just plain text and/or HTML, but others are always a
584 future possibility. Be careful with URLs (<ulink>), and avoid
588 My favorite site is <ulink url="http://example.com">here</ulink>.
591 This will render as <quote>My favorite site is here</quote>, which is
592 not real helpful in a text doc. Better like this:
595 My favorite site is <ulink url="http://example.com">example.com</ulink>.
600 All documents should be spell checked occasionally.
601 <application>aspell</application> can check SGML with the
602 <literal>-H</literal> option. (<application>ispell</application> I think
613 <!-- ~~~~~ New section ~~~~~ -->
615 <sect2><title>Privoxy Custom Entities</title>
617 <application>Privoxy</application> documentation is using
618 a number of customized <quote>entities</quote> to facilitate
619 documentation maintenance.
622 We are using a set of <quote>boilerplate</quote> files with generic text,
623 that is used by multiple docs. This way we can write something once, and use
624 it repeatedly without having to re-write the same content over and over again.
625 If editing such a file, keep in mind that it should be
626 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
627 contexts without additional modifications.
630 We are also using what <application>Docbook</application> calls
631 <quote>internal entities</quote>. These are like variables in
632 programming. Well, sort of. For instance, we have the
633 <literal>p-version</literal> entity that contains the current
634 <application>Privoxy</application> version string. You are strongly
635 encouraged to use these where possible. Some of these obviously
636 require re-setting with each release (done by the Makefile). A sampling of
637 custom entities are listed below. See any of the main docs for examples.
644 Re- <quote>boilerplate</quote> text entities are defined like:
647 <literal><!entity supported SYSTEM "supported.sgml"></literal>
650 In this example, the contents of the file,
651 <filename>supported.sgml</filename> is available for inclusion anywhere
652 in the doc. To make this happen, just reference the now defined
653 entity: <literal>&supported;</literal> (starts with an ampersand
654 and ends with a semi-colon), and the contents will be dumped into
655 the finished doc at that point.
660 Commonly used <quote>internal entities</quote>:
664 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
665 version string, e.g. <quote>&p-version;</quote>.
668 <emphasis>p-status</emphasis>: the project status, either
669 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
672 <emphasis>p-not-stable</emphasis>: use to conditionally include
673 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
676 <emphasis>p-stable</emphasis>: just the opposite.
679 <emphasis>p-text</emphasis>: this doc is only generated as text.
686 There are others in various places that are defined for a specific
687 purpose. Read the source!
694 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
695 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
697 <!-- ~~~~~ New section ~~~~~ -->
698 <sect1 id="coding"><title>Coding Guidelines</title>
700 <sect2 id="s1"><title>Introduction</title>
702 <para>This set of standards is designed to make our lives easier. It is
703 developed with the simple goal of helping us keep the "new and improved
704 <application>Privoxy</application>" consistent and reliable. Thus making
705 maintenance easier and increasing chances of success of the
708 <para>And that of course comes back to us as individuals. If we can
709 increase our development and product efficiencies then we can solve more
710 of the request for changes/improvements and in general feel good about
711 ourselves. ;-></para>
715 <sect2 id="s2"><title>Using Comments</title>
718 <sect3 id="s3"><title>Comment, Comment, Comment</title>
720 <para><emphasis>Explanation:</emphasis></para>
722 <para>Comment as much as possible without commenting the obvious.
723 For example do not comment "variable_a is equal to variable_b".
724 Instead explain why variable_a should be equal to the variable_b.
725 Just because a person can read code does not mean they will
726 understand why or what is being done. A reader may spend a lot
727 more time figuring out what is going on when a simple comment
728 or explanation would have prevented the extra research. Please
729 help your fellow Privoxy developers out!</para>
731 <para>The comments will also help justify the intent of the code.
732 If the comment describes something different than what the code
733 is doing then maybe a programming error is occurring.</para>
735 <para><emphasis>Example:</emphasis></para>
737 /* if page size greater than 1k ... */
738 if (page_length() > 1024)
740 ... "block" the page up ...
743 /* if page size is small, send it in blocks */
744 if (page_length() > 1024)
746 ... "block" the page up ...
749 This demonstrates 2 cases of "what not to do". The first is a
750 "syntax comment". The second is a comment that does not fit what
751 is actually being done.
757 <sect3 id="s4"><title>Use blocks for comments</title>
759 <para><emphasis>Explanation:</emphasis></para>
761 <para>Comments can help or they can clutter. They help when they
762 are differentiated from the code they describe. One line
763 comments do not offer effective separation between the comment
764 and the code. Block identifiers do, by surrounding the code
765 with a clear, definable pattern.</para>
767 <para><emphasis>Example:</emphasis></para>
769 /*********************************************************************
770 * This will stand out clearly in your code!
771 *********************************************************************/
772 if (this_variable == that_variable)
774 do_something_very_important();
778 /* unfortunately, this may not */
779 if (this_variable == that_variable)
781 do_something_very_important();
785 if (this_variable == that_variable) /* this may not either */
787 do_something_very_important();
790 <para><emphasis>Exception:</emphasis></para>
792 <para>If you are trying to add a small logic comment and do not
793 wish to "disrupt" the flow of the code, feel free to use a 1
794 line comment which is NOT on the same line as the code.</para>
800 <sect3 id="s5"><title>Keep Comments on their own line</title>
802 <para><emphasis>Explanation:</emphasis></para>
804 <para>It goes back to the question of readability. If the comment
805 is on the same line as the code it will be harder to read than
806 the comment that is on its own line.</para>
808 <para>There are three exceptions to this rule, which should be
809 violated freely and often: during the definition of variables,
810 at the end of closing braces, when used to comment
813 <para><emphasis>Example:</emphasis></para>
815 /*********************************************************************
816 * This will stand out clearly in your code,
817 * But the second example won't.
818 *********************************************************************/
819 if (this_variable == this_variable)
821 do_something_very_important();
824 if (this_variable == this_variable) /*can you see me?*/
826 do_something_very_important(); /*not easily*/
830 /*********************************************************************
831 * But, the encouraged exceptions:
832 *********************************************************************/
833 int urls_read = 0; /* # of urls read + rejected */
834 int urls_rejected = 0; /* # of urls rejected */
838 do_something_very_important();
842 short do_something_very_important(
843 short firstparam, /* represents something */
844 short nextparam /* represents something else */ )
848 } /* -END- do_something_very_important */
853 <sect3 id="s6"><title>Comment each logical step</title>
855 <para><emphasis>Explanation:</emphasis></para>
857 <para>Logical steps should be commented to help others follow the
858 intent of the written code and comments will make the code more
861 <para>If you have 25 lines of code without a comment, you should
862 probably go back into it to see where you forgot to put
865 <para>Most "for", "while", "do", etc... loops _probably_ need a
866 comment. After all, these are usually major logic
873 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
875 <para><emphasis>Explanation:</emphasis></para>
877 <para>A reader of the code should be able to look at the comments
878 just prior to the beginning of a function and discern the
879 reason for its existence and the consequences of using it. The
880 reader should not have to read through the code to determine if
881 a given function is safe for a desired use. The proper
882 information thoroughly presented at the introduction of a
883 function not only saves time for subsequent maintenance or
884 debugging, it more importantly aids in code reuse by allowing a
885 user to determine the safety and applicability of any function
886 for the problem at hand. As a result of such benefits, all
887 functions should contain the information presented in the
888 addendum section of this document.</para>
894 <sect3 id="s8"><title>Comment at the end of braces if the
895 content is more than one screen length</title>
897 <para><emphasis>Explanation:</emphasis></para>
899 <para>Each closing brace should be followed on the same line by a
900 comment that describes the origination of the brace if the
901 original brace is off of the screen, or otherwise far away from
902 the closing brace. This will simplify the debugging,
903 maintenance, and readability of the code.</para>
905 <para>As a suggestion , use the following flags to make the
906 comment and its brace more readable:</para>
908 <para>use following a closing brace: } /* -END- if() or while ()
911 <para><emphasis>Example:</emphasis></para>
915 do_something_very_important();
916 ...some long list of commands...
917 } /* -END- if x is 1 */
923 do_something_very_important();
924 ...some long list of commands...
925 } /* -END- if (1 == X) */
931 <sect2 id="s9"><title>Naming Conventions</title>
935 <sect3 id="s10"><title>Variable Names</title>
937 <para><emphasis>Explanation:</emphasis></para>
939 <para>Use all lowercase, and separate words via an underscore
940 ('_'). Do not start an identifier with an underscore. (ANSI C
941 reserves these for use by the compiler and system headers.) Do
942 not use identifiers which are reserved in ANSI C++. (E.g.
943 template, class, true, false, ...). This is in case we ever
944 decide to port Privoxy to C++.</para>
946 <para><emphasis>Example:</emphasis></para>
948 int ms_iis5_hack = 0;</programlisting>
950 <para><emphasis>Instead of:</emphasis></para>
954 int msiis5hack = 0; int msIis5Hack = 0;
962 <sect3 id="s11"><title>Function Names</title>
964 <para><emphasis>Explanation:</emphasis></para>
966 <para>Use all lowercase, and separate words via an underscore
967 ('_'). Do not start an identifier with an underscore. (ANSI C
968 reserves these for use by the compiler and system headers.) Do
969 not use identifiers which are reserved in ANSI C++. (E.g.
970 template, class, true, false, ...). This is in case we ever
971 decide to port Privoxy to C++.</para>
973 <para><emphasis>Example:</emphasis></para>
975 int load_some_file(struct client_state *csp)</programlisting>
977 <para><emphasis>Instead of:</emphasis></para>
981 int loadsomefile(struct client_state *csp)
982 int loadSomeFile(struct client_state *csp)
990 <sect3 id="s12"><title>Header file prototypes</title>
992 <para><emphasis>Explanation:</emphasis></para>
994 <para>Use a descriptive parameter name in the function prototype
995 in header files. Use the same parameter name in the header file
996 that you use in the c file.</para>
998 <para><emphasis>Example:</emphasis></para>
1000 (.h) extern int load_aclfile(struct client_state *csp);
1001 (.c) int load_aclfile(struct client_state *csp)</programlisting>
1003 <para><emphasis>Instead of:</emphasis>
1005 (.h) extern int load_aclfile(struct client_state *); or
1006 (.h) extern int load_aclfile();
1007 (.c) int load_aclfile(struct client_state *csp)
1015 <sect3 id="s13"><title>Enumerations, and #defines</title>
1017 <para><emphasis>Explanation:</emphasis></para>
1019 <para>Use all capital letters, with underscores between words. Do
1020 not start an identifier with an underscore. (ANSI C reserves
1021 these for use by the compiler and system headers.)</para>
1023 <para><emphasis>Example:</emphasis></para>
1025 (enumeration) : enum Boolean {FALSE, TRUE};
1026 (#define) : #define DEFAULT_SIZE 100;</programlisting>
1028 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
1029 that toggle a feature in the preprocessor: FEATURE_>, where
1030 > is a short (preferably 1 or 2 word) description.</para>
1032 <para><emphasis>Example:</emphasis></para>
1034 #define FEATURE_FORCE 1
1036 #ifdef FEATURE_FORCE
1037 #define FORCE_PREFIX blah
1038 #endif /* def FEATURE_FORCE */
1043 <sect3 id="s14"><title>Constants</title>
1045 <para><emphasis>Explanation:</emphasis></para>
1047 <para>Spell common words out entirely (do not remove vowels).</para>
1049 <para>Use only widely-known domain acronyms and abbreviations.
1050 Capitalize all letters of an acronym.</para>
1052 <para>Use underscore (_) to separate adjacent acronyms and
1053 abbreviations. Never terminate a name with an underscore.</para>
1055 <para><emphasis>Example:</emphasis></para>
1057 #define USE_IMAGE_LIST 1</programlisting>
1059 <para><emphasis>Instead of:</emphasis></para>
1063 #define USE_IMG_LST 1 or
1064 #define _USE_IMAGE_LIST 1 or
1065 #define USE_IMAGE_LIST_ 1 or
1066 #define use_image_list 1 or
1067 #define UseImageList 1
1077 <sect2 id="s15"><title>Using Space</title>
1081 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1083 <para><emphasis>Explanation:</emphasis></para>
1085 <para>The brace needs to be on a line all by itself, not at the
1086 end of the statement. Curly braces should line up with the
1087 construct that they're associated with. This practice makes it
1088 easier to identify the opening and closing braces for a
1091 <para><emphasis>Example:</emphasis></para>
1098 <para><emphasis>Instead of:</emphasis></para>
1100 <para>if (this == that) { ... }</para>
1104 <para>if (this == that) { ... }</para>
1106 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1107 inside a loop, and it is trivial, i.e. it tests for a
1108 condition that is obvious from the purpose of the block,
1109 one-liners as above may optically preserve the loop structure
1110 and make it easier to read.</para>
1112 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1114 <para><emphasis>Example exception:</emphasis></para>
1116 while (more lines are read)
1118 /* Please document what is/is not a comment line here */
1119 if (it's a comment) continue;
1127 <sect3 id="s17"><title>ALL control statements should have a
1130 <para><emphasis>Explanation:</emphasis></para>
1132 <para>Using braces to make a block will make your code more
1133 readable and less prone to error. All control statements should
1134 have a block defined.</para>
1136 <para><emphasis>Example:</emphasis></para>
1141 do_something_else();
1144 <para><emphasis>Instead of:</emphasis></para>
1146 <para>if (this == that) do_something(); do_something_else();</para>
1150 <para>if (this == that) do_something();</para>
1152 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1153 in a manner other than that which the developer desired (per
1154 indentation). Using code braces would have prevented this
1155 "feature". The "explanation" and "exception" from the point
1156 above also applies.</para>
1162 <sect3 id="s18"><title>Do not belabor/blow-up boolean
1165 <para><emphasis>Example:</emphasis></para>
1167 structure->flag = (condition);</programlisting>
1169 <para><emphasis>Instead of:</emphasis></para>
1171 <para>if (condition) { structure->flag = 1; } else {
1172 structure->flag = 0; }</para>
1174 <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1175 is wordy and inefficient. Please assume that any developer new
1176 to the project has at least a "good" knowledge of C/C++. (Hope
1177 I do not offend by that last comment ... 8-)</para>
1183 <sect3 id="s19"><title>Use white space freely because it is
1186 <para><emphasis>Explanation:</emphasis></para>
1188 <para>Make it readable. The notable exception to using white space
1189 freely is listed in the next guideline.</para>
1191 <para><emphasis>Example:</emphasis></para>
1193 int first_value = 0;
1195 int another_value = 0;
1196 int this_variable = 0;
1201 <sect3 id="s20"><title>Don't use white space around structure
1204 <para><emphasis>Explanation:</emphasis></para>
1206 <para>- structure pointer operator ( "->" ) - member operator (
1207 "." ) - functions and parentheses</para>
1209 <para>It is a general coding practice to put pointers, references,
1210 and function parentheses next to names. With spaces, the
1211 connection between the object and variable/function name is not
1214 <para><emphasis>Example:</emphasis></para>
1218 function_name();</programlisting>
1220 <para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
1221 function_name ();</para>
1227 <sect3 id="s21"><title>Make the last brace of a function stand
1230 <para><emphasis>Example:</emphasis></para>
1232 int function1( ... )
1237 } /* -END- function1 */
1240 int function2( ... )
1242 } /* -END- function2 */
1245 <para><emphasis>Instead of:</emphasis></para>
1247 <para>int function1( ... ) { ...code... return(ret_code); } int
1248 function2( ... ) { }</para>
1250 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1251 lines afterward. This makes the end of function standout to
1252 the most casual viewer. Although function comments help
1253 separate functions, this is still a good coding practice. In
1254 fact, I follow these rules when using blocks in "for", "while",
1255 "do" loops, and long if {} statements too. After all whitespace
1258 <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1259 lines. Enforced is the end of function comments.</para>
1265 <sect3 id="s22"><title>Use 3 character indentions</title>
1267 <para><emphasis>Explanation:</emphasis></para>
1269 <para>If some use 8 character TABs and some use 3 character TABs,
1270 the code can look *very* ragged. So use 3 character indentions
1271 only. If you like to use TABs, pass your code through a filter
1272 such as "expand -t3" before checking in your code.</para>
1274 <para><emphasis>Example:</emphasis></para>
1276 static const char * const url_code_map[256] =
1282 int function1( ... )
1290 return HOW_DID_YOU_GET_HERE;
1293 return NEVER_GETS_HERE;
1302 <sect2 id="s23"><title>Initializing</title>
1306 <sect3 id="s24"><title>Initialize all variables</title>
1308 <para><emphasis>Explanation:</emphasis></para>
1310 <para>Do not assume that the variables declared will not be used
1311 until after they have been assigned a value somewhere else in
1312 the code. Remove the chance of accidentally using an unassigned
1315 <para><emphasis>Example:</emphasis></para>
1319 struct *ptr = NULL;</programlisting>
1321 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1322 message says you are trying to access memory address 00000000
1323 and not 129FA012; or array_ptr[20] causes a SIGSEV vs.
1324 array_ptr[0].</para>
1326 <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1327 variable is assigned a value "shortly after" declaration.</para>
1333 <sect2 id="s25"><title>Functions</title>
1337 <sect3 id="s26"><title>Name functions that return a boolean as a
1340 <para><emphasis>Explanation:</emphasis></para>
1342 <para>Value should be phrased as a question that would logically
1343 be answered as a true or false statement</para>
1345 <para><emphasis>Example:</emphasis></para>
1347 should_we_block_this();
1348 contains_an_image();
1349 is_web_page_blank();
1354 <sect3 id="s27"><title>Always specify a return type for a
1357 <para><emphasis>Explanation:</emphasis></para>
1359 <para>The default return for a function is an int. To avoid
1360 ambiguity, create a return for a function when the return has a
1361 purpose, and create a void return type if the function does not
1362 need to return anything.</para>
1368 <sect3 id="s28"><title>Minimize function calls when iterating by
1369 using variables</title>
1371 <para><emphasis>Explanation:</emphasis></para>
1373 <para>It is easy to write the following code, and a clear argument
1374 can be made that the code is easy to understand:</para>
1376 <para><emphasis>Example:</emphasis></para>
1378 for (size_t cnt = 0; cnt < block_list_length(); cnt++)
1383 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1384 each and every iteration. This increases the overhead in the
1385 program, because the compiler has to look up the function each
1386 time, call it, and return a value. Depending on what occurs in
1387 the block_list_length() call, it might even be creating and
1388 destroying structures with each iteration, even though in each
1389 case it is comparing "cnt" to the same value, over and over.
1390 Remember too - even a call to block_list_length() is a function
1391 call, with the same overhead.</para>
1393 <para>Instead of using a function call during the iterations,
1394 assign the value to a variable, and evaluate using the
1397 <para><emphasis>Example:</emphasis></para>
1399 size_t len = block_list_length();
1401 for (size_t cnt = 0; cnt < len; cnt++)
1406 <para><emphasis>Exceptions:</emphasis> if the value of block_list_length()
1407 *may* change or could *potentially* change, then you must code the
1408 function call in the for/while loop.</para>
1414 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1416 <para><emphasis>Explanation:</emphasis></para>
1418 <para>This allows a developer to define a const pointer and call
1419 your function. If your function does not have the const
1420 keyword, we may not be able to use your function. Consider
1421 strcmp, if it were defined as: extern int strcmp(char *s1,
1424 <para>I could then not use it to compare argv's in main: int
1425 main(int argc, const char *argv[]) { strcmp(argv[0], "privoxy");
1428 <para>Both these pointers are *const*! If the c runtime library
1429 maintainers do it, we should too.</para>
1435 <sect3 id="s30"><title>Pass and Return by Value</title>
1437 <para><emphasis>Explanation:</emphasis></para>
1439 <para>Most structures cannot fit onto a normal stack entry (i.e.
1440 they are not 4 bytes or less). Aka, a function declaration
1441 like: int load_aclfile(struct client_state csp)</para>
1443 <para>would not work. So, to be consistent, we should declare all
1444 prototypes with "pass by value": int load_aclfile(struct
1445 client_state *csp)</para>
1451 <sect3 id="s31"><title>Names of include files</title>
1453 <para><emphasis>Explanation:</emphasis></para>
1455 <para>Your include statements should contain the file name without
1456 a path. The path should be listed in the Makefile, using -I as
1457 processor directive to search the indicated paths. An exception
1458 to this would be for some proprietary software that utilizes a
1459 partial path to distinguish their header files from system or
1460 other header files.</para>
1462 <para><emphasis>Example:</emphasis></para>
1464 #include <iostream.h> /* This is not a local include */
1465 #include "config.h" /* This IS a local include */
1468 <para><emphasis>Exception:</emphasis></para>
1472 /* This is not a local include, but requires a path element. */
1473 #include <sys/fileName.h>
1477 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1478 without a _very_ good reason. This duplicates the #include
1479 "file.h" behavior.</para>
1485 <sect3 id="s32"><title>Provide multiple inclusion
1488 <para><emphasis>Explanation:</emphasis></para>
1490 <para>Prevents compiler and linker errors resulting from
1491 redefinition of items.</para>
1493 <para>Wrap each header file with the following syntax to prevent
1494 multiple inclusions of the file. Of course, replace PROJECT_H
1495 with your file name, with "." Changed to "_", and make it
1498 <para><emphasis>Example:</emphasis></para>
1500 #ifndef PROJECT_H_INCLUDED
1501 #define PROJECT_H_INCLUDED
1503 #endif /* ndef PROJECT_H_INCLUDED */
1508 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1510 <para><emphasis>Explanation:</emphasis></para>
1512 <para>If our headers are included from C++, they must declare our
1513 functions as `extern "C"`. This has no cost in C, but increases
1514 the potential re-usability of our code.</para>
1516 <para><emphasis>Example:</emphasis></para>
1521 #endif /* def __cplusplus */
1523 ... function definitions here ...
1527 #endif /* def __cplusplus */
1532 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1533 Declaration Instead of Includes</title>
1535 <para><emphasis>Explanation:</emphasis></para>
1537 <para>Useful in headers that include pointers to other struct's.
1538 Modifications to excess header files may cause needless
1541 <para><emphasis>Example:</emphasis></para>
1543 /*********************************************************************
1544 * We're avoiding an include statement here!
1545 *********************************************************************/
1547 extern file_list *xyz;</programlisting>
1549 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1550 pointer), then including the proper header file is necessary.
1551 If you only want to prototype a pointer, however, the header
1552 file is unnecessary.</para>
1554 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1560 <sect2 id="s35"><title>General Coding Practices</title>
1564 <sect3 id="s36"><title>Turn on warnings</title>
1566 <para><emphasis>Explanation</emphasis></para>
1568 <para>Compiler warnings are meant to help you find bugs. You
1569 should turn on as many as possible. With GCC, the switch is
1570 "-Wall". Try and fix as many warnings as possible.</para>
1576 <sect3 id="s37"><title>Provide a default case for all switch
1579 <para><emphasis>Explanation:</emphasis></para>
1581 <para>What you think is guaranteed is never really guaranteed. The
1582 value that you don't think you need to check is the one that
1583 someday will be passed. So, to protect yourself from the
1584 unknown, always have a default step in a switch statement.</para>
1586 <para><emphasis>Example:</emphasis></para>
1588 switch (hash_string(cmd))
1590 case hash_actions_file:
1600 ... anomaly code goes here ...
1601 continue; / break; / exit( 1 ); / etc ...
1603 } /* end switch (hash_string(cmd)) */</programlisting>
1605 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1606 are obviously exempt from this point. Of note, most of the
1607 WIN32 code calls `DefWindowProc' after the switch statement.
1608 This API call *should* be included in a default statement.</para>
1610 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1611 as a robust programming issue. The "anomaly code goes here" may
1612 be no more than a print to the STDERR stream (as in
1613 load_config). Or it may really be an abort condition.</para>
1615 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1621 <sect3 id="s38"><title>Try to avoid falling through cases in a
1622 switch statement.</title>
1624 <para><emphasis>Explanation:</emphasis></para>
1626 <para>In general, you will want to have a 'break' statement within
1627 each 'case' of a switch statement. This allows for the code to
1628 be more readable and understandable, and furthermore can
1629 prevent unwanted surprises if someone else later gets creative
1630 and moves the code around.</para>
1632 <para>The language allows you to plan the fall through from one
1633 case statement to another simply by omitting the break
1634 statement within the case statement. This feature does have
1635 benefits, but should only be used in rare cases. In general,
1636 use a break statement for each case statement.</para>
1638 <para>If you choose to allow fall through, you should comment both
1639 the fact of the fall through and reason why you felt it was
1646 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1648 <para><emphasis>Explanation:</emphasis></para>
1650 <para>The type of size_t varies across platforms. Do not make
1651 assumptions about whether it is signed or unsigned, or about
1652 how long it is. Do not compare a size_t against another
1653 variable of a different type (or even against a constant)
1654 without casting one of the values.</para>
1660 <sect3 id="s41"><title>Declare each variable and struct on its
1663 <para><emphasis>Explanation:</emphasis></para>
1665 <para>It can be tempting to declare a series of variables all on
1666 one line. Don't.</para>
1668 <para><emphasis>Example:</emphasis></para>
1672 long c = 0;</programlisting>
1674 <para><emphasis>Instead of:</emphasis></para>
1676 <para>long a, b, c;</para>
1678 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1679 individual variables - easier to add new variables without
1680 messing up the original ones - when searching on a variable to
1681 find its type, there is less clutter to "visually"
1684 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1685 variables or other trivial variables; feel free to declare them
1686 on one line. You should, although, provide a good comment on
1687 their functions.</para>
1689 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1695 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1697 <para><emphasis>Explanation:</emphasis></para>
1699 <para>Create a local struct (on the stack) if the variable will
1700 live and die within the context of one function call.</para>
1702 <para>Only "malloc" a struct (on the heap) if the variable's life
1703 will extend beyond the context of one function call.</para>
1705 <para><emphasis>Example:</emphasis></para>
1707 If a function creates a struct and stores a pointer to it in a
1708 list, then it should definitely be allocated via `malloc'.
1713 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1714 Responsible for Ensuring 'free'</title>
1716 <para><emphasis>Explanation:</emphasis></para>
1718 <para>If you have to "malloc" an instance, you are responsible for
1719 insuring that the instance is `free'd, even if the deallocation
1720 event falls within some other programmer's code. You are also
1721 responsible for ensuring that deletion is timely (i.e. not too
1722 soon, not too late). This is known as "low-coupling" and is a
1723 "good thing (tm)". You may need to offer a
1724 free/unload/destructor type function to accommodate this.</para>
1726 <para><emphasis>Example:</emphasis></para>
1728 int load_re_filterfile(struct client_state *csp) { ... }
1729 static void unload_re_filterfile(void *f) { ... }</programlisting>
1731 <para><emphasis>Exceptions:</emphasis></para>
1733 <para>The developer cannot be expected to provide `free'ing
1734 functions for C run-time library functions ... such as
1737 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1738 standard is for allocating and freeing data structures (complex
1745 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1746 and in order</title>
1748 <para><emphasis>Explanation:</emphasis></para>
1750 <para>I have ordered all of the "blocker" file code to be in alpha
1751 order. It is easier to add/read new blockers when you expect a
1752 certain order.</para>
1754 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1755 places by POPUP tests coming before PCRS tests. But since
1756 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1757 it should come first.</para>
1763 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1764 existing code, use XXX</title>
1766 <para><emphasis>Explanation:</emphasis></para>
1768 <para>If you have enough confidence in new code or confidence in
1769 your changes, but are not *quite* sure of the repercussions,
1772 <para>/* XXX: this code has a logic error on platform XYZ, *
1773 attempting to fix */ #ifdef PLATFORM ...changed code here...
1778 <para>/* XXX: I think the original author really meant this...
1779 */ ...changed code here...</para>
1783 <para>/* XXX: new code that *may* break something else... */
1784 ...new code here...</para>
1786 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1787 be a "good thing (tm)", it will be easier to identify and
1788 include in the project (or conversely exclude from the
1796 <sect2 id="s46"><title>Addendum: Template for files and function
1797 comment blocks:</title>
1799 <para><emphasis>Example for file comments:</emphasis></para>
1801 const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
1802 /*********************************************************************
1804 * File : $S<!-- Break CVS Substitution -->ource$
1806 * Purpose : (Fill me in with a good description!)
1808 * Copyright : Written by and Copyright (C) 2001-2009
1809 * the Privoxy team. http://www.privoxy.org/
1811 * This program is free software; you can redistribute it
1812 * and/or modify it under the terms of the GNU General
1813 * Public License as published by the Free Software
1814 * Foundation; either version 2 of the License, or (at
1815 * your option) any later version.
1817 * This program is distributed in the hope that it will
1818 * be useful, but WITHOUT ANY WARRANTY; without even the
1819 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1820 * PARTICULAR PURPOSE. See the GNU General Public
1821 * License for more details.
1823 * The GNU General Public License should be included with
1824 * this file. If not, you can view it at
1825 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1826 * or write to the Free Software Foundation, Inc.,
1827 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1830 *********************************************************************/
1835 ...necessary include files for us to do our work...
1837 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1840 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1841 added to the "show-proxy-args" page. If this is a brand new
1842 creation by you, you are free to change the "Copyright" section
1843 to represent the rights you wish to maintain.</para>
1845 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1846 after the comment flower box is handy for (X|GNU)Emacs users to
1847 skip the verbiage and get to the heart of the code (via
1848 `forward-page' and `backward-page'). Please include it if you
1851 <para><emphasis>Example for file header comments:</emphasis></para>
1855 #define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
1856 /*********************************************************************
1858 * File : $S<!-- Break CVS Substitution -->ource$
1860 * Purpose : (Fill me in with a good description!)
1862 * Copyright : Written by and Copyright (C) 2001-2009
1863 * the Privoxy team. http://www.privoxy.org/
1865 * This program is free software; you can redistribute it
1866 * and/or modify it under the terms of the GNU General
1867 * Public License as published by the Free Software
1868 * Foundation; either version 2 of the License, or (at
1869 * your option) any later version.
1871 * This program is distributed in the hope that it will
1872 * be useful, but WITHOUT ANY WARRANTY; without even the
1873 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1874 * PARTICULAR PURPOSE. See the GNU General Public
1875 * License for more details.
1877 * The GNU General Public License should be included with
1878 * this file. If not, you can view it at
1879 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1880 * or write to the Free Software Foundation, Inc.,
1881 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1884 *********************************************************************/
1887 #include "project.h"
1893 ... function headers here ...
1896 /* Revision control strings from this header and associated .c file */
1897 extern const char FILENAME_rcs[];
1898 extern const char FILENAME_h_rcs[];
1905 #endif /* ndef _FILENAME_H */
1914 <para><emphasis>Example for function comments:</emphasis></para>
1916 /*********************************************************************
1918 * Function : FUNCTION_NAME
1920 * Description : (Fill me in with a good description!)
1923 * 1 : param1 = pointer to an important thing
1924 * 2 : x = pointer to something else
1926 * Returns : 0 => Ok, everything else is an error.
1928 *********************************************************************/
1929 int FUNCTION_NAME(void *param1, const char *x)
1937 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1938 able to parse our code to create a "self-documenting" web
1945 <!-- ~~~~~ New section ~~~~~ -->
1946 <sect1 id="testing"><title>Testing Guidelines</title>
1950 <!-- ~~~~~ New section ~~~~~ -->
1951 <sect2 id="testing-plan"><title>Testplan for releases</title>
1953 Explain release numbers. major, minor. developer releases. etc.
1955 <orderedlist numeration="arabic">
1957 Remove any existing rpm with rpm -e
1960 Remove any file that was left over. This includes (but is not limited to)
1962 <listitem><para>/var/log/privoxy</para></listitem>
1963 <listitem><para>/etc/privoxy</para></listitem>
1964 <listitem><para>/usr/sbin/privoxy</para></listitem>
1965 <listitem><para>/etc/init.d/privoxy</para></listitem>
1966 <listitem><para>/usr/doc/privoxy*</para></listitem>
1970 Install the rpm. Any error messages?
1972 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1973 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1974 autostart work?</para></listitem>
1975 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1976 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1980 <!-- XXX: Document how to write test reports and where to send them -->
1983 <!-- ~~~~~ New section ~~~~~ -->
1984 <sect1 id="newrelease"><title>Releasing a New Version</title>
1986 When we release versions of <application>Privoxy</application>,
1987 our work leaves our cozy secret lab and has to work in the cold
1988 RealWorld[tm]. Once it is released, there is no way to call it
1989 back, so it is very important that great care is taken to ensure
1990 that everything runs fine, and not to introduce problems in the
1994 So when releasing a new version, please adhere exactly to the
1995 procedure outlined in this chapter.
1999 The following programs are required to follow this process:
2000 <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
2001 <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
2004 <sect2 id="versionnumbers">
2005 <title>Version numbers</title>
2008 First you need to determine which version number the release will have.
2009 <application>Privoxy</application> version numbers consist of three numbers,
2010 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
2014 X, the version major, is rarely ever changed. It is increased by one if
2015 turning a development branch into stable substantially changes the functionality,
2016 user interface or configuration syntax. Majors 1 and 2 were
2017 <application>Junkbuster</application>, and 3 will be the first stable
2018 <application>Privoxy</application> release.
2023 Y, the version minor, represents the branch within the major version.
2024 At any point in time, there are two branches being maintained:
2025 The stable branch, with an even minor, say, 2N, in which no functionality is
2026 being added and only bug-fixes are made, and 2N+1, the development branch, in
2027 which the further development of <application>Privoxy</application> takes
2029 This enables us to turn the code upside down and inside out, while at the same time
2030 providing and maintaining a stable version.
2031 The minor is reset to zero (and one) when the major is incremented. When a development
2032 branch has matured to the point where it can be turned into stable, the old stable branch
2033 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2034 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2039 Z, the point or sub version, represents a release of the software within a branch.
2040 It is therefore incremented immediately before each code freeze.
2041 In development branches, only the even point versions correspond to actual releases,
2042 while the odd ones denote the evolving state of the sources on CVS in between.
2043 It follows that Z is odd on CVS in development branches most of the time. There, it gets
2044 increased to an even number immediately before a code freeze, and is increased to an odd
2045 number again immediately thereafter.
2046 This ensures that builds from CVS snapshots are easily distinguished from released versions.
2047 The point version is reset to zero when the minor changes.
2050 Stable branches work a little differently, since there should be
2051 little to no development happening in such branches. Remember,
2052 only bugfixes, which presumably should have had some testing
2053 before being committed. Stable branches will then have their
2054 version reported as <literal>0.0.0</literal>, during that period
2055 between releases when changes are being added. This is to denote
2056 that this code is <emphasis>not for release</emphasis>. Then
2057 as the release nears, the version is bumped according: e.g.
2058 <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
2064 In summary, the main CVS trunk is the development branch where new
2065 features are being worked on for the next stable series. This should
2066 almost always be where the most activity takes place. There is always at
2067 least one stable branch from the trunk, e.g now it is
2068 <literal>3.0</literal>, which is only used to release stable versions.
2069 Once the initial *.0 release of the stable branch has been done, then as a
2070 rule, only bugfixes that have had prior testing should be committed to
2071 the stable branch. Once there are enough bugfixes to justify a new
2072 release, the version of this branch is again incremented Example: 3.0.0
2073 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
2074 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
2075 taking place. If any questions, please post to the devel list
2076 <emphasis>before</emphasis> committing to a stable branch!
2079 Developers should remember too that if they commit a bugfix to the stable
2080 branch, this will more than likely require a separate submission to the
2081 main trunk, since these are separate development trees within CVS. If you
2082 are working on both, then this would require at least two separate check
2083 outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
2084 which is <literal>v_3_0_branch</literal> at the moment).
2089 <sect2 id="beforerelease">
2090 <title>Before the Release: Freeze</title>
2092 The following <emphasis>must be done by one of the
2093 developers</emphasis> prior to each new release.
2099 Make sure that everybody who has worked on the code in the last
2100 couple of days has had a chance to yell <quote>no!</quote> in case
2101 they have pending changes/fixes in their pipelines. Announce the
2102 freeze so that nobody will interfere with last minute changes.
2107 Increment the version number (point from odd to even in development
2108 branches!) in <filename>configure.in</filename>. (RPM spec files
2109 will need to be incremented as well.)
2114 If <filename>default.action</filename> has changed since last
2115 release (i.e. software release or standalone actions file release),
2116 bump up its version info to A.B in this line:
2120 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
2124 Then change the version info in doc/webserver/actions/index.php,
2125 line: '$required_actions_file_version = "A.B";'
2130 All documentation should be rebuild after the version bump.
2131 Finished docs should be then be committed to CVS (for those
2132 without the ability to build these). Some docs may require
2133 rather obscure processing tools. <filename>config</filename>,
2134 the man page (and the html version of the man page)
2135 fall in this category. REAMDE, the man page, AUTHORS, and config
2136 should all also be committed to CVS for other packagers. The
2137 formal docs should be uploaded to the webserver. See the
2138 Section "Updating the webserver" in this manual for details.
2143 The <citetitle>User Manual</citetitle> is also used for context
2144 sensitive help for the CGI editor. This is version sensitive, so that
2145 the user will get appropriate help for his/her release. So with
2146 each release a fresh version should be uploaded to the webserver
2147 (this is in addition to the main <citetitle>User Manual</citetitle>
2148 link from the main page since we need to keep manuals for various
2149 versions available). The CGI pages will link to something like
2150 <literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. This
2151 will need to be updated for each new release. There is no Makefile
2152 target for this at this time!!! It needs to be done manually.
2157 All developers should look at the <filename>ChangeLog</filename> and
2158 make sure noteworthy changes are referenced.
2163 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2168 Tag all files in CVS with the version number with
2169 <quote><command>cvs tag v_X_Y_Z</command></quote>.
2170 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2175 If the release was in a development branch, increase the point version
2176 from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
2182 On the webserver, copy the user manual to a new top-level directory
2183 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2184 pages, which have the version as a prefix, will go into the right version of the manual.
2185 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2186 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2187 <filename>.</filename> (i.e. dot).
2194 <sect2 id="therelease">
2195 <title>Building and Releasing the Packages</title>
2197 Now the individual packages can be built and released. Note that for
2198 GPL reasons the first package to be released is always the source tarball.
2202 For <emphasis>all</emphasis> types of packages, including the source tarball,
2203 <emphasis>you must make sure that you build from clean sources by exporting
2204 the right version from CVS into an empty directory</emphasis> (just press return when
2205 asked for a password):
2210 mkdir dist # delete or choose different name if it already exists
2212 cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
2213 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2218 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2219 version information after export from CVS. This is to make sure that
2220 all release packages, and with them, all future bug reports, are based
2221 on exactly the same code.
2226 Every significant release of Privoxy has included at least one
2227 package that either had incorrect versions of files, missing files,
2228 or incidental leftovers from a previous build process that gave
2229 unknown numbers of users headaches to try to figure out what was
2230 wrong. PLEASE, make sure you are using pristene sources, and are
2231 following the prescribed process!
2236 Please find additional instructions for the source tarball and the
2237 individual platform dependent binary packages below. And details
2238 on the Sourceforge release process below that.
2241 <sect3 id="pack-guidelines">
2242 <title>Note on Privoxy Packaging</title>
2244 Please keep these general guidelines in mind when putting together
2245 your package. These apply to <emphasis>all</emphasis> platforms!
2251 <application>Privoxy</application> <emphasis>requires</emphasis>
2252 write access to: all <filename>*.action</filename> files, all
2253 logfiles, and the <filename>trust</filename> file. You will
2254 need to determine the best way to do this for your platform.
2259 Please include up to date documentation. At a bare minimum:
2263 <filename>LICENSE</filename> (top-level directory)
2268 <filename>README</filename> (top-level directory)
2273 <filename>AUTHORS</filename> (top-level directory)
2278 <filename>man page</filename> (top-level directory, Unix-like
2284 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2289 <filename>FAQ</filename> (doc/webserver/faq/)
2293 Also suggested: <filename>Developer Manual</filename>
2294 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2295 (top-level directory). <filename>FAQ</filename> and the manuals are
2296 HTML docs. There are also text versions in
2297 <filename>doc/text/</filename> which could conceivably also be
2301 The documentation has been designed such that the manuals are linked
2302 to each other from parallel directories, and should be packaged
2303 that way. <filename>privoxy-index.html</filename> can also be
2304 included and can serve as a focal point for docs and other links of
2305 interest (and possibly renamed to <filename>index.html</filename>).
2306 This should be one level up from the manuals. There is a link also
2307 on this page to an HTMLized version of the man page. To avoid 404 for
2308 this, it is in CVS as
2309 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2310 and should be included along with the manuals. There is also a
2311 css stylesheets that can be included for better presentation:
2312 <filename>p_doc.css</filename>. This should be in the same directory
2313 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2314 the manual directories).
2319 <filename>user.action</filename> and <filename>user.filter</filename>
2320 are designed for local preferences. Make sure these do not get overwritten!
2321 <filename>config</filename> should not be overwritten either. This
2322 has especially important configuration data in it.
2323 <filename>trust</filename> should be left in tact as well.
2328 Other configuration files (<filename>default.action</filename> and
2329 <filename>default.filter</filename>) should be installed as the new
2330 defaults, but all previously installed configuration files should be
2331 preserved as backups. This is just good manners :-) These files are
2332 likely to change between releases and contain important new features
2338 Please check platform specific notes in this doc, if you haven't
2339 done <quote>Privoxy</quote> packaging before for other platform
2340 specific issues. Conversely, please add any notes that you know
2341 are important for your platform (or contact one of the doc
2342 maintainers to do this if you can't).
2347 Packagers should do a <quote>clean</quote> install of their
2348 package after building it. So any previous installs should be
2349 removed first to ensure the integrity of the newly built package.
2350 Then run the package for a while to make sure there are no
2351 obvious problems, before uploading.
2360 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2362 First, <emphasis>make sure that you have freshly exported the right
2363 version into an empty directory</emphasis>. (See "Building and releasing
2364 packages" above). Then run:
2369 autoheader && autoconf && ./configure
2381 To upload the package to Sourceforge, simply issue
2389 Go to the displayed URL and release the file publicly on Sourceforge.
2390 For the change log field, use the relevant section of the
2391 <filename>ChangeLog</filename> file.
2395 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2397 In following text, replace <replaceable class="parameter">dist</replaceable>
2398 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2401 First, <emphasis>make sure that you have freshly exported the right
2402 version into an empty directory</emphasis>. (See "Building and releasing
2406 As the only exception to not changing anything after export from CVS,
2407 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2408 and make sure that the version information and the RPM release number are
2409 correct. The RPM release numbers for each version start at one. Hence it must
2410 be reset to one if this is the first RPM for
2411 <replaceable class="parameter">dist</replaceable> which is built from version
2413 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">file
2414 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2415 release number for that version plus one.
2423 autoheader && autoconf && ./configure
2431 make <replaceable class="parameter">dist</replaceable>-dist
2435 To upload the package to Sourceforge, simply issue
2439 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2443 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2444 RPM release number as determined above.
2445 Go to the displayed URL and release the file publicly on Sourceforge.
2446 Use the release notes and change log from the source tarball package.
2450 <sect3 id="newrelease-os2"><title>OS/2</title>
2452 First, <emphasis>make sure that you have freshly exported the right
2453 version into an empty directory</emphasis>. (See "Building and releasing
2454 packages" above). Then get the OS/2 Setup module:
2458 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
2462 You will need a mix of development tools.
2463 The main compilation takes place with IBM Visual Age C++.
2464 Some ancillary work takes place with GNU tools, available from
2465 various sources like hobbes.nmsu.edu.
2466 Specificially, you will need <filename>autoheader</filename>,
2467 <filename>autoconf</filename> and <filename>sh</filename> tools.
2468 The packaging takes place with WarpIN, available from various sources, including
2469 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2472 Change directory to the <filename>os2setup</filename> directory.
2473 Edit the os2build.cmd file to set the final executable filename.
2478 installExeName='privoxyos2_setup_X.Y.Z.exe'
2482 Next, edit the <filename>IJB.wis</filename> file so the release number matches
2483 in the <filename>PACKAGEID</filename> section:
2487 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2491 You're now ready to build. Run:
2499 You will find the WarpIN-installable executable in the
2500 <filename>./files</filename> directory. Upload this anonymously to
2501 <filename>uploads.sourceforge.net/incoming</filename>, create a release
2502 for it, and you're done. Use the release notes and Change Log from the
2503 source tarball package.
2507 <sect3 id="newrelease-solaris"><title>Solaris</title>
2509 Login to Sourceforge's compilefarm via ssh:
2513 ssh cf.sourceforge.net
2517 Choose the right operating system (not the Debian one).
2518 When logged in, <emphasis>make sure that you have freshly exported the right
2519 version into an empty directory</emphasis>. (See "Building and releasing
2520 packages" above). Then run:
2525 autoheader && autoconf && ./configure
2537 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2538 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2539 to manually upload the archive to Sourceforge's ftp server and release
2540 the file publicly. Use the release notes and Change Log from the
2541 source tarball package.
2545 <sect3 id="newrelease-windows"><title>Windows</title>
2547 Use the <ulink url="http://www.fruitbat.org/Cygwin/index.html#cygwincirca">
2548 Cygwin Time Machine</ulink> to install the last 1.5 version of Cygwin.
2549 Run the following commands from within the Cygwin 1.5 bash shell.
2552 First, <emphasis>make sure that you have freshly exported the right
2553 version into an empty directory</emphasis>. (See "Building and releasing
2554 packages" above). Then get the Windows setup module:
2558 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
2562 Then you can build the package. This is fully automated, and is
2563 controlled by <filename>winsetup/GNUmakefile</filename>.
2564 All you need to do is:
2573 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2574 <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
2575 SourceForge. When releasing the package on SourceForge, use the release notes
2576 and Change Log from the source tarball package.
2580 <sect3 id="newrelease-debian"><title>Debian</title>
2582 First, <emphasis>make sure that you have freshly exported the
2583 right version into an empty directory</emphasis>. (See
2584 "Building and releasing packages" above). Then add a log
2585 entry to <filename>debian/changelog</filename>, if it is not
2586 already there, for example by running:
2590 debchange -v &p-version;-&p-status;-1 "New upstream version"
2598 dpkg-buildpackage -rfakeroot -us -uc -b
2603 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2604 which can be uploaded. To upload the package to Sourceforge, simply
2614 <sect3 id="newrelease-macosx"><title>Mac OS X</title>
2616 First, <emphasis>make sure that you have freshly exported the right
2617 version into an empty directory</emphasis>. (See "Building and releasing
2621 There are three modules available in the CVS repository for use on Mac
2622 OS X, though technically only two of them generate a release (the other
2623 can be used to install from source).
2625 <sect4 id="OS-X-OSXPackageBuilder-module">
2626 <title>OSXPackageBuilder module</title>
2628 The OSXPackageBuilder module generates OS X installer packages
2629 supporting all Macs running OS X 10.4 and above. Obtain it from CVS as
2630 follows into a folder parallel to the exported privoxy source:
2632 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
2636 The module contains complete instructions on its usage in the file
2637 <filename>OS X Package Builder HOWTO.txt</filename>.
2640 Once the package(s) have been generated, you can then upload them
2641 directly to the Files section of the Sourceforge project in the
2642 Macintosh (OS X) folder. Each new version release of Privoxy should
2643 have a new subfolder created in which to store its files. Please
2644 ensure that the folder contains a readme file that makes it clear
2645 which package is for whichversion of OS X.
2648 <sect4 id="OS-X-osxsetup-module">
2649 <title>osxsetup module (DEPRECATED)</title>
2651 <emphasis>This module is deprecated since the installer it generates
2652 places all Privoxy files in one folder in a non-standard location, and
2653 supports only Intel Macs running OS X 10.6 or higher.</emphasis>
2656 Check out the module from CVS as follows into a folder parallel to the
2657 exported privoxy source:
2659 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
2672 This will run <filename>autoheader</filename>, <filename>autoconf</filename>
2673 and <filename>configure</filename> as well as <filename>make</filename>.
2674 Finally, it will copy over the necessary files to the ./osxsetup/files
2675 directory for further processing by <filename>PackageMaker</filename>.
2678 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
2679 modify the package name to match the release, and hit the "Create
2680 package" button. If you specify ./Privoxy.pkg as the output package
2681 name, you can then create the distributable zip file with the command:
2685 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2689 You can then upload this file directly to the Files section of the
2690 Sourceforge project in the Macintosh (OS X) folder. Each new version
2691 release of Privoxy should have a new subfolder created in which to
2693 Please ensure that the folder contains a readme file that makes it
2694 clear which version(s) of OS X the package supports.
2697 <sect4 id="OS-X-macsetup-module">
2698 <title>macsetup module</title>
2700 The macsetup module is ideal if you wish to build and install Privoxy
2701 from source on a single machine.
2704 Check out the module from CVS as follows into a folder parallel to the
2705 exported privoxy source:
2707 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
2711 The module contains complete instructions on its usage in its
2712 <filename>README</filename> file. The end result will be the
2713 exported version of Privoxy installed on the build machine.
2718 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2720 Update the www/privoxy port and submit a diff upstream.
2721 For details see the <ulink url="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/">FreeBSD Porter's Handbook</ulink>.
2725 <sect2 id="releasing">
2726 <title>Uploading and Releasing Your Package</title>
2728 After the package is ready, it is time to upload it
2729 to SourceForge, and go through the release steps. The upload
2736 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2741 user: <literal>anonymous</literal>
2746 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2752 Or use the <command>make</command> targets as described above.
2755 Once this done go to <ulink
2756 url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
2757 >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
2758 making sure you are logged in. Find your target platform in the
2759 second column, and click <literal>Add Release</literal>. You will
2760 then need to create a new release for your package, using the format
2761 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2765 Now just follow the prompts. Be sure to add any appropriate Release
2766 notes. You should see your freshly uploaded packages in
2767 <quote>Step 2. Add Files To This Release</quote>. Check the
2768 appropriate box(es). Remember at each step to hit the
2769 <quote>Refresh/Submit</quote> buttons! You should now see your
2770 file(s) listed in Step 3. Fill out the forms with the appropriate
2771 information for your platform, being sure to hit <quote>Update</quote>
2772 for each file. If anyone is monitoring your platform, check the
2773 <quote>email</quote> box at the very bottom to notify them of
2774 the new package. This should do it!
2777 If you have made errors, or need to make changes, you can go through
2778 essentially the same steps, but select <literal>Edit Release</literal>,
2779 instead of <literal>Add Release</literal>.
2783 <sect2 id="afterrelease">
2784 <title>After the Release</title>
2786 When all (or: most of the) packages have been uploaded and made available,
2787 send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
2788 mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2790 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">download
2791 location</ulink>, the release notes and the Changelog. Also, post an
2792 updated News item on the project page Sourceforge, and update the Home
2793 page and docs linked from the Home page (see below). Other news sites
2794 and release oriented sites, such as Freshmeat, should also be notified.
2800 <!-- ~~~~~ New section ~~~~~ -->
2801 <sect1 id="webserver-update"><title>Update the Webserver</title>
2803 The webserver should be updated at least with each stable release. When
2804 updating, please follow these steps to make sure that no broken links,
2805 inconsistent contents or permission problems will occur (as it has many
2806 times in the past!):
2809 If you have changed anything in the stable-branch documentation source
2818 That will generate <filename>doc/webserver/user-manual</filename>,
2819 <filename>doc/webserver/developer-manual</filename>,
2820 <filename>doc/webserver/faq</filename>,
2821 <filename>doc/webserver/index.html</filename> automatically.
2824 If you changed the manual page sources, generate
2825 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2826 by running <quote><command>make man</command></quote>. (This is
2827 a separate target due to dependencies on some obscure perl scripts
2828 [now in CVS, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
2831 If you want to add new files to the webserver, create them locally in
2832 the <filename>doc/webserver/*</filename> directory (or
2833 create new directories under <filename>doc/webserver</filename>).
2836 Next, commit any changes from the above steps to CVS. All set?
2837 If these are docs in the stable branch, then do:
2845 This will do the upload to <ulink url="http://www.privoxy.org/">the
2846 webserver</ulink> (www.privoxy.org) and ensure all files and directories
2847 there are group writable.
2850 Please do <emphasis>NOT</emphasis> use any other means of transferring
2851 files to the webserver to avoid permission problems. Also, please do not
2852 upload docs from development branches or versions. The publicly posted
2853 docs should be in sync with the last official release.
2859 This program is free software; you can redistribute it
2860 and/or modify it under the terms of the GNU General
2861 Public License as published by the Free Software
2862 Foundation; either version 2 of the License, or (at
2863 your option) any later version.
2865 This program is distributed in the hope that it will
2866 be useful, but WITHOUT ANY WARRANTY; without even the
2867 implied warranty of MERCHANTABILITY or FITNESS FOR A
2868 PARTICULAR PURPOSE. See the GNU General Public
2869 License for more details.
2871 The GNU General Public License should be included with
2872 this file. If not, you can view it at
2873 http://www.gnu.org/copyleft/gpl.html
2874 or write to the Free Software Foundation, Inc., 59
2875 Temple Place - Suite 330, Boston, MA 02111-1307, USA.