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.24">
9 <!entity p-status "stable">
10 <!entity % p-not-stable "IGNORE">
11 <!entity % p-stable "INCLUDE">
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.63 2016/01/23 11:57:50 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.63 2016/01/23 11:57:50 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="http://sourceforge.net/">SourceForge.</ulink>
172 Please refer to the chapters 6 and 7 in
173 <ulink url="http://sourceforge.net/docman/?group_id=1">SF's site
174 documentation</ulink> for the technical access details for your
175 operating system. For historical reasons, the CVS server is
176 called <literal>ijbswa.cvs.sourceforge.net</literal>, the repository is
177 called <literal>ijbswa</literal>, and the source tree module is called
178 <literal>current</literal>.
182 <sect2 id="cvsbranches">
183 <title>Branches</title>
185 Within the CVS repository, there are modules and branches. As
186 mentioned, the sources are in the <literal>current</literal>
187 <quote>module</quote>. Other modules are present for platform specific
188 issues. There is a webview of the CVS hierarchy at <ulink
189 url="http://ijbswa.cvs.sourceforge.net/ijbswa/">http://ijbswa.cvs.sourceforge.net/ijbswa/</ulink>,
190 which might help with visualizing how these pieces fit together.
194 Branches are used to fork a sub-development path from the main trunk.
195 Within the <literal>current</literal> module where the sources are, there
196 is always at least one <quote>branch</quote> from the main trunk
197 devoted to a stable release series. The main trunk is where active
198 development takes place for the next stable series (e.g. 3.2.x).
199 So just prior to each stable series (e.g. 3.0.x), a branch is created
200 just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
201 Once the initial stable release of any stable branch has taken place,
202 this branch is <emphasis>only used for bugfixes</emphasis>, which have
203 had prior testing before being committed to CVS. (See <link
204 linkend="versionnumbers">Version Numbers</link> below for details on
209 At one time there were two distinct branches: stable and unstable. The
210 more drastic changes were to be in the unstable branch. These branches
211 have now been merged to minimize time and effort of maintaining two
216 This will result in at least two active branches, which means there may
217 be occasions that require the same (or similar) item to be
218 checked into to two different places (assuming its a bugfix and needs
219 fixing in both the stable and unstable trees). This also means that in
220 order to have access to both trees, both will have to be checked out
221 separately. Use the <literal>cvs -r</literal> flag to check out a
222 branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
227 <sect2 id="cvscommit"><title>CVS Commit Guidelines</title>
229 The source tree is the heart of every software project. Every effort must
230 be made to ensure that it is readable, compilable and consistent at all
231 times. <!-- There are differing guidelines for the stable branch and the
232 main development trunk, and --> We expect anyone with CVS access to strictly
233 adhere to the following guidelines:
237 Basic Guidelines, for all branches:
242 Please don't commit even
243 a small change without testing it thoroughly first. When we're
244 close to a public release, ask a fellow developer to review your
248 Your commit message should give a concise overview of <emphasis>what you
249 changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
250 Just check previous messages for good examples.
253 Don't use the same message on multiple files, unless it equally applies to
257 If your changes span multiple files, and the code won't recompile unless
258 all changes are committed (e.g. when changing the signature of a function),
259 then commit all files one after another, without long delays in between.
260 If necessary, prepare the commit messages in advance.
263 Before changing things on CVS, make sure that your changes are in line
264 with the team's general consensus on what should be done.
268 Note that near a major public release, we get more cautious.
269 There is always the possibility to submit a patch to the <ulink
270 url="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patch
271 tracker</ulink> instead.
279 Stable branches are handled with more care, especially after the
280 initial *.*.0 release, and we are just in bugfix mode. In addition to
281 the above, the below applies only to the stable branch (currently the
282 <literal>v_3_0_branch</literal> branch):
289 Do not commit <emphasis>anything</emphasis> unless your proposed
290 changes have been well tested first, preferably by other members of the
291 project, or have prior approval of the project leaders or consensus
297 Where possible, bugfixes and changes should be tested in the main
298 development trunk first. There may be occasions where this is not
304 Alternately, proposed changes can be submitted as patches to the patch tracker on
305 Sourceforge first: <ulink
306 url="http://sourceforge.net/tracker/?group_id=11118&atid=311118">http://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
307 Then ask for peer review.
312 Do not even think about anything except bugfixes. No new features!
323 <!-- ~~~~~ New section ~~~~~ -->
324 <sect1 id="documentation"><title>Documentation Guidelines</title>
326 All formal documents are maintained in Docbook SGML and located in the
327 <computeroutput>doc/source/*</computeroutput> directory. You will need
328 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
329 DTD's and the Docbook modular stylesheets (or comparable alternatives),
330 and either <application>jade</application> or
331 <application>openjade</application> (recommended) installed in order to
332 build docs from source. Currently there is <ulink
333 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
334 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
335 course this, the <citetitle>developer-manual</citetitle> in this format.
336 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
337 <citetitle>INSTALL</citetitle>,
338 <citetitle>privoxy.1</citetitle> (man page), and
339 <citetitle>config</citetitle> files are also now maintained as Docbook
340 SGML. These files, when built, in the top-level source directory are
341 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
342 variation on this file, <filename>privoxy-index.html</filename>,
343 meant for inclusion with doc packages), are maintained as SGML as well.
344 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
345 contact someone involved in the documentation.
348 <filename>config</filename> requires some special handling. The reason it
349 is maintained this way is so that the extensive comments in the file
350 mirror those in <citetitle>user-manual</citetitle>. But the conversion
351 process requires going from SGML to HTML to text to special formatting
352 required for the embedded comments. Some of this does not survive so
353 well. Especially some of the examples that are longer than 80 characters.
354 The build process for this file outputs to <filename>config.new</filename>,
355 which should be reviewed for errors and mis-formatting. Once satisfied
356 that it is correct, then it should be hand copied to
357 <filename>config</filename>.
360 Other, less formal documents (e.g. <filename>LICENSE</filename>) are
361 maintained as plain text files in the top-level source directory.
364 Packagers are encouraged to include this documentation. For those without
365 the ability to build the docs locally, text versions of each are kept in
366 CVS. HTML versions are also being kept in CVS under
367 <filename>doc/webserver/*</filename>.
370 Formal documents are built with the Makefile targets of
371 <computeroutput>make dok</computeroutput>.
372 The build process uses the document SGML sources in
373 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
374 <computeroutput>doc/text/</computeroutput> and to update all HTML
375 documents in <computeroutput>doc/webserver/</computeroutput>.
378 Documentation writers should please make sure documents build
379 successfully before committing to CVS, if possible.
382 How do you update the webserver (i.e. the pages on privoxy.org)?
384 <orderedlist numeration="arabic">
386 First, build the docs by running <computeroutput>make
387 dok</computeroutput>.
390 Run <computeroutput>make webserver</computeroutput> which copies all
391 files from <computeroutput>doc/webserver</computeroutput> to the
392 sourceforge webserver via scp.
398 Finished docs should be occasionally submitted to CVS
399 (<filename>doc/webserver/*/*.html</filename>) so that those without
400 the ability to build them locally, have access to them if needed.
401 This is especially important just prior to a new release! Please
402 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
403 other release specific data in <filename>configure.in</filename> has been
404 updated (this is done just prior to a new release).
407 <!-- ~~~~~ New section ~~~~~ -->
409 <title>Quickstart to Docbook and SGML</title>
411 If you are not familiar with SGML, it is a markup language similar to HTML.
412 Actually, not a mark up language per se, but a language used to define
413 markup languages. In fact, HTML is an SGML application. Both will use
414 <quote>tags</quote> to format text and other content. SGML tags can be much
415 more varied, and flexible, but do much of the same kinds of things. The tags,
416 or <quote>elements</quote>, are definable in SGML. There is no set
417 <quote>standards</quote>. Since we are using
418 <application>Docbook</application>, our tags are those that are defined by
419 <application>Docbook</application>. Much of how the finish document is
420 rendered is determined by the <quote>stylesheets</quote>.
421 The stylesheets determine how each tag gets translated to HTML, or other
426 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
427 will likely generate errors. Example: <literal><title>My
428 Title</title></literal>. They are also case-insensitive, but we
429 strongly suggest using all lower case. This keeps compatibility with
430 [Docbook] <application>XML</application>.
434 Our documents use <quote>sections</quote> for the most part. Sections
435 will be processed into HTML headers (e.g. <literal>h1</literal> for
436 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
437 will use these to also generate the Table of Contents for each doc. Our
438 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
439 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
440 entries, but <literal>sect4</literal> will not. Each section requires
441 a <literal><title></literal> element, and at least one
442 <literal><para></literal>. There is a limit of five section
443 levels in Docbook, but generally three should be sufficient for our
448 Some common elements that you likely will use:
454 <emphasis><para></para></emphasis>, paragraph delimiter. Most
455 text needs to be within paragraph elements (there are some exceptions).
458 <emphasis><emphasis></emphasis></emphasis>, the stylesheets
462 <emphasis><filename></filename></emphasis>, files and directories.
465 <emphasis><command></command></emphasis>, command examples.
468 <emphasis><literallayout></literallayout></emphasis>, like
469 <literal><pre></literal>, more or less.
472 <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
475 <emphasis><listitem></listitem></emphasis>, member of the above.
478 <emphasis><screen></screen></emphasis>, screen output, implies
479 <literal><literallayout></literal>.
482 <emphasis><ulink url="example.com"></ulink></emphasis>, like
483 HTML <literal><a></literal> tag.
486 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
492 Look at any of the existing docs for examples of all these and more.
496 You might also find <quote><ulink
497 url="http://opensource.bureau-cornavin.com/crash-course/index.html">Writing Documentation
498 Using DocBook - A Crash Course</ulink></quote> useful.
502 <!-- ~~~~~ New section ~~~~~ -->
503 <sect2 id="docstyle">
504 <title><application>Privoxy</application> Documentation Style</title>
506 It will be easier if everyone follows a similar writing style. This
507 just makes it easier to read what someone else has written if it
508 is all done in a similar fashion.
517 All tags should be lower case.
522 Tags delimiting a <emphasis>block</emphasis> of text (even small
523 blocks) should be on their own line. Like:
529 Tags marking individual words, or few words, should be in-line:
531 Just to <emphasis>emphasize</emphasis>, some text goes here.
537 Tags should be nested and step indented for block text like: (except
544 Some text goes here in our list example.
547 </itemizedlist>
550 This makes it easier to find the text amongst the tags ;-)
555 Use white space to separate logical divisions within a document,
556 like between sections. Running everything together consistently
557 makes it harder to read and work on.
562 Do not hesitate to make comments. Comments can either use the
563 <comment> element, or the <!-- --> style comment
564 familiar from HTML. (Note in Docbook v4.x <comment> is
565 replaced by <remark>.)
570 We have an international audience. Refrain from slang, or English
571 idiosyncrasies (too many to list :). Humor also does not translate
577 Try to keep overall line lengths in source files to 80 characters or less
578 for obvious reasons. This is not always possible, with lengthy URLs for
584 Our documents are available in differing formats. Right now, they
585 are just plain text and/or HTML, but others are always a
586 future possibility. Be careful with URLs (<ulink>), and avoid
590 My favorite site is <ulink url="http://example.com">here</ulink>.
593 This will render as <quote>My favorite site is here</quote>, which is
594 not real helpful in a text doc. Better like this:
597 My favorite site is <ulink url="http://example.com">example.com</ulink>.
602 All documents should be spell checked occasionally.
603 <application>aspell</application> can check SGML with the
604 <literal>-H</literal> option. (<application>ispell</application> I think
615 <!-- ~~~~~ New section ~~~~~ -->
617 <sect2><title>Privoxy Custom Entities</title>
619 <application>Privoxy</application> documentation is using
620 a number of customized <quote>entities</quote> to facilitate
621 documentation maintenance.
624 We are using a set of <quote>boilerplate</quote> files with generic text,
625 that is used by multiple docs. This way we can write something once, and use
626 it repeatedly without having to re-write the same content over and over again.
627 If editing such a file, keep in mind that it should be
628 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
629 contexts without additional modifications.
632 We are also using what <application>Docbook</application> calls
633 <quote>internal entities</quote>. These are like variables in
634 programming. Well, sort of. For instance, we have the
635 <literal>p-version</literal> entity that contains the current
636 <application>Privoxy</application> version string. You are strongly
637 encouraged to use these where possible. Some of these obviously
638 require re-setting with each release (done by the Makefile). A sampling of
639 custom entities are listed below. See any of the main docs for examples.
646 Re- <quote>boilerplate</quote> text entities are defined like:
649 <literal><!entity supported SYSTEM "supported.sgml"></literal>
652 In this example, the contents of the file,
653 <filename>supported.sgml</filename> is available for inclusion anywhere
654 in the doc. To make this happen, just reference the now defined
655 entity: <literal>&supported;</literal> (starts with an ampersand
656 and ends with a semi-colon), and the contents will be dumped into
657 the finished doc at that point.
662 Commonly used <quote>internal entities</quote>:
666 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
667 version string, e.g. <quote>&p-version;</quote>.
670 <emphasis>p-status</emphasis>: the project status, either
671 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
674 <emphasis>p-not-stable</emphasis>: use to conditionally include
675 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
678 <emphasis>p-stable</emphasis>: just the opposite.
681 <emphasis>p-text</emphasis>: this doc is only generated as text.
688 There are others in various places that are defined for a specific
689 purpose. Read the source!
696 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
697 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
699 <!-- ~~~~~ New section ~~~~~ -->
700 <sect1 id="coding"><title>Coding Guidelines</title>
702 <sect2 id="s1"><title>Introduction</title>
704 <para>This set of standards is designed to make our lives easier. It is
705 developed with the simple goal of helping us keep the "new and improved
706 <application>Privoxy</application>" consistent and reliable. Thus making
707 maintenance easier and increasing chances of success of the
710 <para>And that of course comes back to us as individuals. If we can
711 increase our development and product efficiencies then we can solve more
712 of the request for changes/improvements and in general feel good about
713 ourselves. ;-></para>
717 <sect2 id="s2"><title>Using Comments</title>
720 <sect3 id="s3"><title>Comment, Comment, Comment</title>
722 <para><emphasis>Explanation:</emphasis></para>
724 <para>Comment as much as possible without commenting the obvious.
725 For example do not comment "variable_a is equal to variable_b".
726 Instead explain why variable_a should be equal to the variable_b.
727 Just because a person can read code does not mean they will
728 understand why or what is being done. A reader may spend a lot
729 more time figuring out what is going on when a simple comment
730 or explanation would have prevented the extra research. Please
731 help your fellow Privoxy developers out!</para>
733 <para>The comments will also help justify the intent of the code.
734 If the comment describes something different than what the code
735 is doing then maybe a programming error is occurring.</para>
737 <para><emphasis>Example:</emphasis></para>
739 /* if page size greater than 1k ... */
740 if (page_length() > 1024)
742 ... "block" the page up ...
745 /* if page size is small, send it in blocks */
746 if (page_length() > 1024)
748 ... "block" the page up ...
751 This demonstrates 2 cases of "what not to do". The first is a
752 "syntax comment". The second is a comment that does not fit what
753 is actually being done.
759 <sect3 id="s4"><title>Use blocks for comments</title>
761 <para><emphasis>Explanation:</emphasis></para>
763 <para>Comments can help or they can clutter. They help when they
764 are differentiated from the code they describe. One line
765 comments do not offer effective separation between the comment
766 and the code. Block identifiers do, by surrounding the code
767 with a clear, definable pattern.</para>
769 <para><emphasis>Example:</emphasis></para>
771 /*********************************************************************
772 * This will stand out clearly in your code!
773 *********************************************************************/
774 if (this_variable == that_variable)
776 do_something_very_important();
780 /* unfortunately, this may not */
781 if (this_variable == that_variable)
783 do_something_very_important();
787 if (this_variable == that_variable) /* this may not either */
789 do_something_very_important();
792 <para><emphasis>Exception:</emphasis></para>
794 <para>If you are trying to add a small logic comment and do not
795 wish to "disrupt" the flow of the code, feel free to use a 1
796 line comment which is NOT on the same line as the code.</para>
802 <sect3 id="s5"><title>Keep Comments on their own line</title>
804 <para><emphasis>Explanation:</emphasis></para>
806 <para>It goes back to the question of readability. If the comment
807 is on the same line as the code it will be harder to read than
808 the comment that is on its own line.</para>
810 <para>There are three exceptions to this rule, which should be
811 violated freely and often: during the definition of variables,
812 at the end of closing braces, when used to comment
815 <para><emphasis>Example:</emphasis></para>
817 /*********************************************************************
818 * This will stand out clearly in your code,
819 * But the second example won't.
820 *********************************************************************/
821 if (this_variable == this_variable)
823 do_something_very_important();
826 if (this_variable == this_variable) /*can you see me?*/
828 do_something_very_important(); /*not easily*/
832 /*********************************************************************
833 * But, the encouraged exceptions:
834 *********************************************************************/
835 int urls_read = 0; /* # of urls read + rejected */
836 int urls_rejected = 0; /* # of urls rejected */
840 do_something_very_important();
844 short do_something_very_important(
845 short firstparam, /* represents something */
846 short nextparam /* represents something else */ )
850 } /* -END- do_something_very_important */
855 <sect3 id="s6"><title>Comment each logical step</title>
857 <para><emphasis>Explanation:</emphasis></para>
859 <para>Logical steps should be commented to help others follow the
860 intent of the written code and comments will make the code more
863 <para>If you have 25 lines of code without a comment, you should
864 probably go back into it to see where you forgot to put
867 <para>Most "for", "while", "do", etc... loops _probably_ need a
868 comment. After all, these are usually major logic
875 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
877 <para><emphasis>Explanation:</emphasis></para>
879 <para>A reader of the code should be able to look at the comments
880 just prior to the beginning of a function and discern the
881 reason for its existence and the consequences of using it. The
882 reader should not have to read through the code to determine if
883 a given function is safe for a desired use. The proper
884 information thoroughly presented at the introduction of a
885 function not only saves time for subsequent maintenance or
886 debugging, it more importantly aids in code reuse by allowing a
887 user to determine the safety and applicability of any function
888 for the problem at hand. As a result of such benefits, all
889 functions should contain the information presented in the
890 addendum section of this document.</para>
896 <sect3 id="s8"><title>Comment at the end of braces if the
897 content is more than one screen length</title>
899 <para><emphasis>Explanation:</emphasis></para>
901 <para>Each closing brace should be followed on the same line by a
902 comment that describes the origination of the brace if the
903 original brace is off of the screen, or otherwise far away from
904 the closing brace. This will simplify the debugging,
905 maintenance, and readability of the code.</para>
907 <para>As a suggestion , use the following flags to make the
908 comment and its brace more readable:</para>
910 <para>use following a closing brace: } /* -END- if() or while ()
913 <para><emphasis>Example:</emphasis></para>
917 do_something_very_important();
918 ...some long list of commands...
919 } /* -END- if x is 1 */
925 do_something_very_important();
926 ...some long list of commands...
927 } /* -END- if (1 == X) */
933 <sect2 id="s9"><title>Naming Conventions</title>
937 <sect3 id="s10"><title>Variable Names</title>
939 <para><emphasis>Explanation:</emphasis></para>
941 <para>Use all lowercase, and separate words via an underscore
942 ('_'). Do not start an identifier with an underscore. (ANSI C
943 reserves these for use by the compiler and system headers.) Do
944 not use identifiers which are reserved in ANSI C++. (E.g.
945 template, class, true, false, ...). This is in case we ever
946 decide to port Privoxy to C++.</para>
948 <para><emphasis>Example:</emphasis></para>
950 int ms_iis5_hack = 0;</programlisting>
952 <para><emphasis>Instead of:</emphasis></para>
956 int msiis5hack = 0; int msIis5Hack = 0;
964 <sect3 id="s11"><title>Function Names</title>
966 <para><emphasis>Explanation:</emphasis></para>
968 <para>Use all lowercase, and separate words via an underscore
969 ('_'). Do not start an identifier with an underscore. (ANSI C
970 reserves these for use by the compiler and system headers.) Do
971 not use identifiers which are reserved in ANSI C++. (E.g.
972 template, class, true, false, ...). This is in case we ever
973 decide to port Privoxy to C++.</para>
975 <para><emphasis>Example:</emphasis></para>
977 int load_some_file(struct client_state *csp)</programlisting>
979 <para><emphasis>Instead of:</emphasis></para>
983 int loadsomefile(struct client_state *csp)
984 int loadSomeFile(struct client_state *csp)
992 <sect3 id="s12"><title>Header file prototypes</title>
994 <para><emphasis>Explanation:</emphasis></para>
996 <para>Use a descriptive parameter name in the function prototype
997 in header files. Use the same parameter name in the header file
998 that you use in the c file.</para>
1000 <para><emphasis>Example:</emphasis></para>
1002 (.h) extern int load_aclfile(struct client_state *csp);
1003 (.c) int load_aclfile(struct client_state *csp)</programlisting>
1005 <para><emphasis>Instead of:</emphasis>
1007 (.h) extern int load_aclfile(struct client_state *); or
1008 (.h) extern int load_aclfile();
1009 (.c) int load_aclfile(struct client_state *csp)
1017 <sect3 id="s13"><title>Enumerations, and #defines</title>
1019 <para><emphasis>Explanation:</emphasis></para>
1021 <para>Use all capital letters, with underscores between words. Do
1022 not start an identifier with an underscore. (ANSI C reserves
1023 these for use by the compiler and system headers.)</para>
1025 <para><emphasis>Example:</emphasis></para>
1027 (enumeration) : enum Boolean {FALSE, TRUE};
1028 (#define) : #define DEFAULT_SIZE 100;</programlisting>
1030 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
1031 that toggle a feature in the preprocessor: FEATURE_>, where
1032 > is a short (preferably 1 or 2 word) description.</para>
1034 <para><emphasis>Example:</emphasis></para>
1036 #define FEATURE_FORCE 1
1038 #ifdef FEATURE_FORCE
1039 #define FORCE_PREFIX blah
1040 #endif /* def FEATURE_FORCE */
1045 <sect3 id="s14"><title>Constants</title>
1047 <para><emphasis>Explanation:</emphasis></para>
1049 <para>Spell common words out entirely (do not remove vowels).</para>
1051 <para>Use only widely-known domain acronyms and abbreviations.
1052 Capitalize all letters of an acronym.</para>
1054 <para>Use underscore (_) to separate adjacent acronyms and
1055 abbreviations. Never terminate a name with an underscore.</para>
1057 <para><emphasis>Example:</emphasis></para>
1059 #define USE_IMAGE_LIST 1</programlisting>
1061 <para><emphasis>Instead of:</emphasis></para>
1065 #define USE_IMG_LST 1 or
1066 #define _USE_IMAGE_LIST 1 or
1067 #define USE_IMAGE_LIST_ 1 or
1068 #define use_image_list 1 or
1069 #define UseImageList 1
1079 <sect2 id="s15"><title>Using Space</title>
1083 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1085 <para><emphasis>Explanation:</emphasis></para>
1087 <para>The brace needs to be on a line all by itself, not at the
1088 end of the statement. Curly braces should line up with the
1089 construct that they're associated with. This practice makes it
1090 easier to identify the opening and closing braces for a
1093 <para><emphasis>Example:</emphasis></para>
1100 <para><emphasis>Instead of:</emphasis></para>
1102 <para>if (this == that) { ... }</para>
1106 <para>if (this == that) { ... }</para>
1108 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1109 inside a loop, and it is trivial, i.e. it tests for a
1110 condition that is obvious from the purpose of the block,
1111 one-liners as above may optically preserve the loop structure
1112 and make it easier to read.</para>
1114 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1116 <para><emphasis>Example exception:</emphasis></para>
1118 while (more lines are read)
1120 /* Please document what is/is not a comment line here */
1121 if (it's a comment) continue;
1129 <sect3 id="s17"><title>ALL control statements should have a
1132 <para><emphasis>Explanation:</emphasis></para>
1134 <para>Using braces to make a block will make your code more
1135 readable and less prone to error. All control statements should
1136 have a block defined.</para>
1138 <para><emphasis>Example:</emphasis></para>
1143 do_something_else();
1146 <para><emphasis>Instead of:</emphasis></para>
1148 <para>if (this == that) do_something(); do_something_else();</para>
1152 <para>if (this == that) do_something();</para>
1154 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1155 in a manner other than that which the developer desired (per
1156 indentation). Using code braces would have prevented this
1157 "feature". The "explanation" and "exception" from the point
1158 above also applies.</para>
1164 <sect3 id="s18"><title>Do not belabor/blow-up boolean
1167 <para><emphasis>Example:</emphasis></para>
1169 structure->flag = (condition);</programlisting>
1171 <para><emphasis>Instead of:</emphasis></para>
1173 <para>if (condition) { structure->flag = 1; } else {
1174 structure->flag = 0; }</para>
1176 <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1177 is wordy and inefficient. Please assume that any developer new
1178 to the project has at least a "good" knowledge of C/C++. (Hope
1179 I do not offend by that last comment ... 8-)</para>
1185 <sect3 id="s19"><title>Use white space freely because it is
1188 <para><emphasis>Explanation:</emphasis></para>
1190 <para>Make it readable. The notable exception to using white space
1191 freely is listed in the next guideline.</para>
1193 <para><emphasis>Example:</emphasis></para>
1195 int first_value = 0;
1197 int another_value = 0;
1198 int this_variable = 0;
1203 <sect3 id="s20"><title>Don't use white space around structure
1206 <para><emphasis>Explanation:</emphasis></para>
1208 <para>- structure pointer operator ( "->" ) - member operator (
1209 "." ) - functions and parentheses</para>
1211 <para>It is a general coding practice to put pointers, references,
1212 and function parentheses next to names. With spaces, the
1213 connection between the object and variable/function name is not
1216 <para><emphasis>Example:</emphasis></para>
1220 function_name();</programlisting>
1222 <para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
1223 function_name ();</para>
1229 <sect3 id="s21"><title>Make the last brace of a function stand
1232 <para><emphasis>Example:</emphasis></para>
1234 int function1( ... )
1239 } /* -END- function1 */
1242 int function2( ... )
1244 } /* -END- function2 */
1247 <para><emphasis>Instead of:</emphasis></para>
1249 <para>int function1( ... ) { ...code... return(ret_code); } int
1250 function2( ... ) { }</para>
1252 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1253 lines afterward. This makes the end of function standout to
1254 the most casual viewer. Although function comments help
1255 separate functions, this is still a good coding practice. In
1256 fact, I follow these rules when using blocks in "for", "while",
1257 "do" loops, and long if {} statements too. After all whitespace
1260 <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1261 lines. Enforced is the end of function comments.</para>
1267 <sect3 id="s22"><title>Use 3 character indentions</title>
1269 <para><emphasis>Explanation:</emphasis></para>
1271 <para>If some use 8 character TABs and some use 3 character TABs,
1272 the code can look *very* ragged. So use 3 character indentions
1273 only. If you like to use TABs, pass your code through a filter
1274 such as "expand -t3" before checking in your code.</para>
1276 <para><emphasis>Example:</emphasis></para>
1278 static const char * const url_code_map[256] =
1284 int function1( ... )
1292 return HOW_DID_YOU_GET_HERE;
1295 return NEVER_GETS_HERE;
1304 <sect2 id="s23"><title>Initializing</title>
1308 <sect3 id="s24"><title>Initialize all variables</title>
1310 <para><emphasis>Explanation:</emphasis></para>
1312 <para>Do not assume that the variables declared will not be used
1313 until after they have been assigned a value somewhere else in
1314 the code. Remove the chance of accidentally using an unassigned
1317 <para><emphasis>Example:</emphasis></para>
1321 struct *ptr = NULL;</programlisting>
1323 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1324 message says you are trying to access memory address 00000000
1325 and not 129FA012; or array_ptr[20] causes a SIGSEV vs.
1326 array_ptr[0].</para>
1328 <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1329 variable is assigned a value "shortly after" declaration.</para>
1335 <sect2 id="s25"><title>Functions</title>
1339 <sect3 id="s26"><title>Name functions that return a boolean as a
1342 <para><emphasis>Explanation:</emphasis></para>
1344 <para>Value should be phrased as a question that would logically
1345 be answered as a true or false statement</para>
1347 <para><emphasis>Example:</emphasis></para>
1349 should_we_block_this();
1350 contains_an_image();
1351 is_web_page_blank();
1356 <sect3 id="s27"><title>Always specify a return type for a
1359 <para><emphasis>Explanation:</emphasis></para>
1361 <para>The default return for a function is an int. To avoid
1362 ambiguity, create a return for a function when the return has a
1363 purpose, and create a void return type if the function does not
1364 need to return anything.</para>
1370 <sect3 id="s28"><title>Minimize function calls when iterating by
1371 using variables</title>
1373 <para><emphasis>Explanation:</emphasis></para>
1375 <para>It is easy to write the following code, and a clear argument
1376 can be made that the code is easy to understand:</para>
1378 <para><emphasis>Example:</emphasis></para>
1380 for (size_t cnt = 0; cnt < block_list_length(); cnt++)
1385 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1386 each and every iteration. This increases the overhead in the
1387 program, because the compiler has to look up the function each
1388 time, call it, and return a value. Depending on what occurs in
1389 the block_list_length() call, it might even be creating and
1390 destroying structures with each iteration, even though in each
1391 case it is comparing "cnt" to the same value, over and over.
1392 Remember too - even a call to block_list_length() is a function
1393 call, with the same overhead.</para>
1395 <para>Instead of using a function call during the iterations,
1396 assign the value to a variable, and evaluate using the
1399 <para><emphasis>Example:</emphasis></para>
1401 size_t len = block_list_length();
1403 for (size_t cnt = 0; cnt < len; cnt++)
1408 <para><emphasis>Exceptions:</emphasis> if the value of block_list_length()
1409 *may* change or could *potentially* change, then you must code the
1410 function call in the for/while loop.</para>
1416 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1418 <para><emphasis>Explanation:</emphasis></para>
1420 <para>This allows a developer to define a const pointer and call
1421 your function. If your function does not have the const
1422 keyword, we may not be able to use your function. Consider
1423 strcmp, if it were defined as: extern int strcmp(char *s1,
1426 <para>I could then not use it to compare argv's in main: int
1427 main(int argc, const char *argv[]) { strcmp(argv[0], "privoxy");
1430 <para>Both these pointers are *const*! If the c runtime library
1431 maintainers do it, we should too.</para>
1437 <sect3 id="s30"><title>Pass and Return by Value</title>
1439 <para><emphasis>Explanation:</emphasis></para>
1441 <para>Most structures cannot fit onto a normal stack entry (i.e.
1442 they are not 4 bytes or less). Aka, a function declaration
1443 like: int load_aclfile(struct client_state csp)</para>
1445 <para>would not work. So, to be consistent, we should declare all
1446 prototypes with "pass by value": int load_aclfile(struct
1447 client_state *csp)</para>
1453 <sect3 id="s31"><title>Names of include files</title>
1455 <para><emphasis>Explanation:</emphasis></para>
1457 <para>Your include statements should contain the file name without
1458 a path. The path should be listed in the Makefile, using -I as
1459 processor directive to search the indicated paths. An exception
1460 to this would be for some proprietary software that utilizes a
1461 partial path to distinguish their header files from system or
1462 other header files.</para>
1464 <para><emphasis>Example:</emphasis></para>
1466 #include <iostream.h> /* This is not a local include */
1467 #include "config.h" /* This IS a local include */
1470 <para><emphasis>Exception:</emphasis></para>
1474 /* This is not a local include, but requires a path element. */
1475 #include <sys/fileName.h>
1479 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1480 without a _very_ good reason. This duplicates the #include
1481 "file.h" behavior.</para>
1487 <sect3 id="s32"><title>Provide multiple inclusion
1490 <para><emphasis>Explanation:</emphasis></para>
1492 <para>Prevents compiler and linker errors resulting from
1493 redefinition of items.</para>
1495 <para>Wrap each header file with the following syntax to prevent
1496 multiple inclusions of the file. Of course, replace PROJECT_H
1497 with your file name, with "." Changed to "_", and make it
1500 <para><emphasis>Example:</emphasis></para>
1502 #ifndef PROJECT_H_INCLUDED
1503 #define PROJECT_H_INCLUDED
1505 #endif /* ndef PROJECT_H_INCLUDED */
1510 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1512 <para><emphasis>Explanation:</emphasis></para>
1514 <para>If our headers are included from C++, they must declare our
1515 functions as `extern "C"`. This has no cost in C, but increases
1516 the potential re-usability of our code.</para>
1518 <para><emphasis>Example:</emphasis></para>
1523 #endif /* def __cplusplus */
1525 ... function definitions here ...
1529 #endif /* def __cplusplus */
1534 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1535 Declaration Instead of Includes</title>
1537 <para><emphasis>Explanation:</emphasis></para>
1539 <para>Useful in headers that include pointers to other struct's.
1540 Modifications to excess header files may cause needless
1543 <para><emphasis>Example:</emphasis></para>
1545 /*********************************************************************
1546 * We're avoiding an include statement here!
1547 *********************************************************************/
1549 extern file_list *xyz;</programlisting>
1551 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1552 pointer), then including the proper header file is necessary.
1553 If you only want to prototype a pointer, however, the header
1554 file is unnecessary.</para>
1556 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1562 <sect2 id="s35"><title>General Coding Practices</title>
1566 <sect3 id="s36"><title>Turn on warnings</title>
1568 <para><emphasis>Explanation</emphasis></para>
1570 <para>Compiler warnings are meant to help you find bugs. You
1571 should turn on as many as possible. With GCC, the switch is
1572 "-Wall". Try and fix as many warnings as possible.</para>
1578 <sect3 id="s37"><title>Provide a default case for all switch
1581 <para><emphasis>Explanation:</emphasis></para>
1583 <para>What you think is guaranteed is never really guaranteed. The
1584 value that you don't think you need to check is the one that
1585 someday will be passed. So, to protect yourself from the
1586 unknown, always have a default step in a switch statement.</para>
1588 <para><emphasis>Example:</emphasis></para>
1590 switch (hash_string(cmd))
1592 case hash_actions_file:
1602 ... anomaly code goes here ...
1603 continue; / break; / exit( 1 ); / etc ...
1605 } /* end switch (hash_string(cmd)) */</programlisting>
1607 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1608 are obviously exempt from this point. Of note, most of the
1609 WIN32 code calls `DefWindowProc' after the switch statement.
1610 This API call *should* be included in a default statement.</para>
1612 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1613 as a robust programming issue. The "anomaly code goes here" may
1614 be no more than a print to the STDERR stream (as in
1615 load_config). Or it may really be an abort condition.</para>
1617 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1623 <sect3 id="s38"><title>Try to avoid falling through cases in a
1624 switch statement.</title>
1626 <para><emphasis>Explanation:</emphasis></para>
1628 <para>In general, you will want to have a 'break' statement within
1629 each 'case' of a switch statement. This allows for the code to
1630 be more readable and understandable, and furthermore can
1631 prevent unwanted surprises if someone else later gets creative
1632 and moves the code around.</para>
1634 <para>The language allows you to plan the fall through from one
1635 case statement to another simply by omitting the break
1636 statement within the case statement. This feature does have
1637 benefits, but should only be used in rare cases. In general,
1638 use a break statement for each case statement.</para>
1640 <para>If you choose to allow fall through, you should comment both
1641 the fact of the fall through and reason why you felt it was
1648 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1650 <para><emphasis>Explanation:</emphasis></para>
1652 <para>The type of size_t varies across platforms. Do not make
1653 assumptions about whether it is signed or unsigned, or about
1654 how long it is. Do not compare a size_t against another
1655 variable of a different type (or even against a constant)
1656 without casting one of the values.</para>
1662 <sect3 id="s41"><title>Declare each variable and struct on its
1665 <para><emphasis>Explanation:</emphasis></para>
1667 <para>It can be tempting to declare a series of variables all on
1668 one line. Don't.</para>
1670 <para><emphasis>Example:</emphasis></para>
1674 long c = 0;</programlisting>
1676 <para><emphasis>Instead of:</emphasis></para>
1678 <para>long a, b, c;</para>
1680 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1681 individual variables - easier to add new variables without
1682 messing up the original ones - when searching on a variable to
1683 find its type, there is less clutter to "visually"
1686 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1687 variables or other trivial variables; feel free to declare them
1688 on one line. You should, although, provide a good comment on
1689 their functions.</para>
1691 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1697 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1699 <para><emphasis>Explanation:</emphasis></para>
1701 <para>Create a local struct (on the stack) if the variable will
1702 live and die within the context of one function call.</para>
1704 <para>Only "malloc" a struct (on the heap) if the variable's life
1705 will extend beyond the context of one function call.</para>
1707 <para><emphasis>Example:</emphasis></para>
1709 If a function creates a struct and stores a pointer to it in a
1710 list, then it should definitely be allocated via `malloc'.
1715 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1716 Responsible for Ensuring 'free'</title>
1718 <para><emphasis>Explanation:</emphasis></para>
1720 <para>If you have to "malloc" an instance, you are responsible for
1721 insuring that the instance is `free'd, even if the deallocation
1722 event falls within some other programmer's code. You are also
1723 responsible for ensuring that deletion is timely (i.e. not too
1724 soon, not too late). This is known as "low-coupling" and is a
1725 "good thing (tm)". You may need to offer a
1726 free/unload/destructor type function to accommodate this.</para>
1728 <para><emphasis>Example:</emphasis></para>
1730 int load_re_filterfile(struct client_state *csp) { ... }
1731 static void unload_re_filterfile(void *f) { ... }</programlisting>
1733 <para><emphasis>Exceptions:</emphasis></para>
1735 <para>The developer cannot be expected to provide `free'ing
1736 functions for C run-time library functions ... such as
1739 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1740 standard is for allocating and freeing data structures (complex
1747 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1748 and in order</title>
1750 <para><emphasis>Explanation:</emphasis></para>
1752 <para>I have ordered all of the "blocker" file code to be in alpha
1753 order. It is easier to add/read new blockers when you expect a
1754 certain order.</para>
1756 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1757 places by POPUP tests coming before PCRS tests. But since
1758 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1759 it should come first.</para>
1765 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1766 existing code, use XXX</title>
1768 <para><emphasis>Explanation:</emphasis></para>
1770 <para>If you have enough confidence in new code or confidence in
1771 your changes, but are not *quite* sure of the repercussions,
1774 <para>/* XXX: this code has a logic error on platform XYZ, *
1775 attempting to fix */ #ifdef PLATFORM ...changed code here...
1780 <para>/* XXX: I think the original author really meant this...
1781 */ ...changed code here...</para>
1785 <para>/* XXX: new code that *may* break something else... */
1786 ...new code here...</para>
1788 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1789 be a "good thing (tm)", it will be easier to identify and
1790 include in the project (or conversely exclude from the
1798 <sect2 id="s46"><title>Addendum: Template for files and function
1799 comment blocks:</title>
1801 <para><emphasis>Example for file comments:</emphasis></para>
1803 const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
1804 /*********************************************************************
1806 * File : $S<!-- Break CVS Substitution -->ource$
1808 * Purpose : (Fill me in with a good description!)
1810 * Copyright : Written by and Copyright (C) 2001-2009
1811 * the Privoxy team. http://www.privoxy.org/
1813 * This program is free software; you can redistribute it
1814 * and/or modify it under the terms of the GNU General
1815 * Public License as published by the Free Software
1816 * Foundation; either version 2 of the License, or (at
1817 * your option) any later version.
1819 * This program is distributed in the hope that it will
1820 * be useful, but WITHOUT ANY WARRANTY; without even the
1821 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1822 * PARTICULAR PURPOSE. See the GNU General Public
1823 * License for more details.
1825 * The GNU General Public License should be included with
1826 * this file. If not, you can view it at
1827 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1828 * or write to the Free Software Foundation, Inc.,
1829 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1832 *********************************************************************/
1837 ...necessary include files for us to do our work...
1839 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1842 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1843 added to the "show-proxy-args" page. If this is a brand new
1844 creation by you, you are free to change the "Copyright" section
1845 to represent the rights you wish to maintain.</para>
1847 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1848 after the comment flower box is handy for (X|GNU)Emacs users to
1849 skip the verbiage and get to the heart of the code (via
1850 `forward-page' and `backward-page'). Please include it if you
1853 <para><emphasis>Example for file header comments:</emphasis></para>
1857 #define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
1858 /*********************************************************************
1860 * File : $S<!-- Break CVS Substitution -->ource$
1862 * Purpose : (Fill me in with a good description!)
1864 * Copyright : Written by and Copyright (C) 2001-2009
1865 * the Privoxy team. http://www.privoxy.org/
1867 * This program is free software; you can redistribute it
1868 * and/or modify it under the terms of the GNU General
1869 * Public License as published by the Free Software
1870 * Foundation; either version 2 of the License, or (at
1871 * your option) any later version.
1873 * This program is distributed in the hope that it will
1874 * be useful, but WITHOUT ANY WARRANTY; without even the
1875 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1876 * PARTICULAR PURPOSE. See the GNU General Public
1877 * License for more details.
1879 * The GNU General Public License should be included with
1880 * this file. If not, you can view it at
1881 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1882 * or write to the Free Software Foundation, Inc.,
1883 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1886 *********************************************************************/
1889 #include "project.h"
1895 ... function headers here ...
1898 /* Revision control strings from this header and associated .c file */
1899 extern const char FILENAME_rcs[];
1900 extern const char FILENAME_h_rcs[];
1907 #endif /* ndef _FILENAME_H */
1916 <para><emphasis>Example for function comments:</emphasis></para>
1918 /*********************************************************************
1920 * Function : FUNCTION_NAME
1922 * Description : (Fill me in with a good description!)
1925 * 1 : param1 = pointer to an important thing
1926 * 2 : x = pointer to something else
1928 * Returns : 0 => Ok, everything else is an error.
1930 *********************************************************************/
1931 int FUNCTION_NAME(void *param1, const char *x)
1939 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1940 able to parse our code to create a "self-documenting" web
1947 <!-- ~~~~~ New section ~~~~~ -->
1948 <sect1 id="testing"><title>Testing Guidelines</title>
1952 <!-- ~~~~~ New section ~~~~~ -->
1953 <sect2 id="testing-plan"><title>Testplan for releases</title>
1955 Explain release numbers. major, minor. developer releases. etc.
1957 <orderedlist numeration="arabic">
1959 Remove any existing rpm with rpm -e
1962 Remove any file that was left over. This includes (but is not limited to)
1964 <listitem><para>/var/log/privoxy</para></listitem>
1965 <listitem><para>/etc/privoxy</para></listitem>
1966 <listitem><para>/usr/sbin/privoxy</para></listitem>
1967 <listitem><para>/etc/init.d/privoxy</para></listitem>
1968 <listitem><para>/usr/doc/privoxy*</para></listitem>
1972 Install the rpm. Any error messages?
1974 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1975 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1976 autostart work?</para></listitem>
1977 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1978 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1983 <!-- ~~~~~ New section ~~~~~ -->
1984 <sect2 id="testing-report"><title>Test reports</title>
1986 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
1987 at sourceforge. Three simple steps:
1990 <listitem><para>Select category: the distribution you test on.</para></listitem>
1991 <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
1992 <listitem><para>Fill the Summary and Detailed Description with something
1993 intelligent (keep it short and precise).</para>
1996 Do not mail to the mailing list (we cannot keep track on issues there).
2002 <!-- ~~~~~ New section ~~~~~ -->
2003 <sect1 id="newrelease"><title>Releasing a New Version</title>
2005 When we release versions of <application>Privoxy</application>,
2006 our work leaves our cozy secret lab and has to work in the cold
2007 RealWorld[tm]. Once it is released, there is no way to call it
2008 back, so it is very important that great care is taken to ensure
2009 that everything runs fine, and not to introduce problems in the
2013 So when releasing a new version, please adhere exactly to the
2014 procedure outlined in this chapter.
2018 The following programs are required to follow this process:
2019 <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
2020 <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
2023 <sect2 id="versionnumbers">
2024 <title>Version numbers</title>
2027 First you need to determine which version number the release will have.
2028 <application>Privoxy</application> version numbers consist of three numbers,
2029 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
2033 X, the version major, is rarely ever changed. It is increased by one if
2034 turning a development branch into stable substantially changes the functionality,
2035 user interface or configuration syntax. Majors 1 and 2 were
2036 <application>Junkbuster</application>, and 3 will be the first stable
2037 <application>Privoxy</application> release.
2042 Y, the version minor, represents the branch within the major version.
2043 At any point in time, there are two branches being maintained:
2044 The stable branch, with an even minor, say, 2N, in which no functionality is
2045 being added and only bug-fixes are made, and 2N+1, the development branch, in
2046 which the further development of <application>Privoxy</application> takes
2048 This enables us to turn the code upside down and inside out, while at the same time
2049 providing and maintaining a stable version.
2050 The minor is reset to zero (and one) when the major is incremented. When a development
2051 branch has matured to the point where it can be turned into stable, the old stable branch
2052 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2053 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2058 Z, the point or sub version, represents a release of the software within a branch.
2059 It is therefore incremented immediately before each code freeze.
2060 In development branches, only the even point versions correspond to actual releases,
2061 while the odd ones denote the evolving state of the sources on CVS in between.
2062 It follows that Z is odd on CVS in development branches most of the time. There, it gets
2063 increased to an even number immediately before a code freeze, and is increased to an odd
2064 number again immediately thereafter.
2065 This ensures that builds from CVS snapshots are easily distinguished from released versions.
2066 The point version is reset to zero when the minor changes.
2069 Stable branches work a little differently, since there should be
2070 little to no development happening in such branches. Remember,
2071 only bugfixes, which presumably should have had some testing
2072 before being committed. Stable branches will then have their
2073 version reported as <literal>0.0.0</literal>, during that period
2074 between releases when changes are being added. This is to denote
2075 that this code is <emphasis>not for release</emphasis>. Then
2076 as the release nears, the version is bumped according: e.g.
2077 <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
2083 In summary, the main CVS trunk is the development branch where new
2084 features are being worked on for the next stable series. This should
2085 almost always be where the most activity takes place. There is always at
2086 least one stable branch from the trunk, e.g now it is
2087 <literal>3.0</literal>, which is only used to release stable versions.
2088 Once the initial *.0 release of the stable branch has been done, then as a
2089 rule, only bugfixes that have had prior testing should be committed to
2090 the stable branch. Once there are enough bugfixes to justify a new
2091 release, the version of this branch is again incremented Example: 3.0.0
2092 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
2093 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
2094 taking place. If any questions, please post to the devel list
2095 <emphasis>before</emphasis> committing to a stable branch!
2098 Developers should remember too that if they commit a bugfix to the stable
2099 branch, this will more than likely require a separate submission to the
2100 main trunk, since these are separate development trees within CVS. If you
2101 are working on both, then this would require at least two separate check
2102 outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
2103 which is <literal>v_3_0_branch</literal> at the moment).
2108 <sect2 id="beforerelease">
2109 <title>Before the Release: Freeze</title>
2111 The following <emphasis>must be done by one of the
2112 developers</emphasis> prior to each new release.
2118 Make sure that everybody who has worked on the code in the last
2119 couple of days has had a chance to yell <quote>no!</quote> in case
2120 they have pending changes/fixes in their pipelines. Announce the
2121 freeze so that nobody will interfere with last minute changes.
2126 Increment the version number (point from odd to even in development
2127 branches!) in <filename>configure.in</filename>. (RPM spec files
2128 will need to be incremented as well.)
2133 If <filename>default.action</filename> has changed since last
2134 release (i.e. software release or standalone actions file release),
2135 bump up its version info to A.B in this line:
2139 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
2143 Then change the version info in doc/webserver/actions/index.php,
2144 line: '$required_actions_file_version = "A.B";'
2149 All documentation should be rebuild after the version bump.
2150 Finished docs should be then be committed to CVS (for those
2151 without the ability to build these). Some docs may require
2152 rather obscure processing tools. <filename>config</filename>,
2153 the man page (and the html version of the man page)
2154 fall in this category. REAMDE, the man page, AUTHORS, and config
2155 should all also be committed to CVS for other packagers. The
2156 formal docs should be uploaded to the webserver. See the
2157 Section "Updating the webserver" in this manual for details.
2162 The <citetitle>User Manual</citetitle> is also used for context
2163 sensitive help for the CGI editor. This is version sensitive, so that
2164 the user will get appropriate help for his/her release. So with
2165 each release a fresh version should be uploaded to the webserver
2166 (this is in addition to the main <citetitle>User Manual</citetitle>
2167 link from the main page since we need to keep manuals for various
2168 versions available). The CGI pages will link to something like
2169 <literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. This
2170 will need to be updated for each new release. There is no Makefile
2171 target for this at this time!!! It needs to be done manually.
2176 All developers should look at the <filename>ChangeLog</filename> and
2177 make sure noteworthy changes are referenced.
2182 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2187 Tag all files in CVS with the version number with
2188 <quote><command>cvs tag v_X_Y_Z</command></quote>.
2189 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2194 If the release was in a development branch, increase the point version
2195 from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
2201 On the webserver, copy the user manual to a new top-level directory
2202 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2203 pages, which have the version as a prefix, will go into the right version of the manual.
2204 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2205 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2206 <filename>.</filename> (i.e. dot).
2213 <sect2 id="therelease">
2214 <title>Building and Releasing the Packages</title>
2216 Now the individual packages can be built and released. Note that for
2217 GPL reasons the first package to be released is always the source tarball.
2221 For <emphasis>all</emphasis> types of packages, including the source tarball,
2222 <emphasis>you must make sure that you build from clean sources by exporting
2223 the right version from CVS into an empty directory</emphasis> (just press return when
2224 asked for a password):
2229 mkdir dist # delete or choose different name if it already exists
2231 cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
2232 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2237 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2238 version information after export from CVS. This is to make sure that
2239 all release packages, and with them, all future bug reports, are based
2240 on exactly the same code.
2245 Every significant release of Privoxy has included at least one
2246 package that either had incorrect versions of files, missing files,
2247 or incidental leftovers from a previous build process that gave
2248 unknown numbers of users headaches to try to figure out what was
2249 wrong. PLEASE, make sure you are using pristene sources, and are
2250 following the prescribed process!
2255 Please find additional instructions for the source tarball and the
2256 individual platform dependent binary packages below. And details
2257 on the Sourceforge release process below that.
2260 <sect3 id="pack-guidelines">
2261 <title>Note on Privoxy Packaging</title>
2263 Please keep these general guidelines in mind when putting together
2264 your package. These apply to <emphasis>all</emphasis> platforms!
2270 <application>Privoxy</application> <emphasis>requires</emphasis>
2271 write access to: all <filename>*.action</filename> files, all
2272 logfiles, and the <filename>trust</filename> file. You will
2273 need to determine the best way to do this for your platform.
2278 Please include up to date documentation. At a bare minimum:
2282 <filename>LICENSE</filename> (top-level directory)
2287 <filename>README</filename> (top-level directory)
2292 <filename>AUTHORS</filename> (top-level directory)
2297 <filename>man page</filename> (top-level directory, Unix-like
2303 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2308 <filename>FAQ</filename> (doc/webserver/faq/)
2312 Also suggested: <filename>Developer Manual</filename>
2313 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2314 (top-level directory). <filename>FAQ</filename> and the manuals are
2315 HTML docs. There are also text versions in
2316 <filename>doc/text/</filename> which could conceivably also be
2320 The documentation has been designed such that the manuals are linked
2321 to each other from parallel directories, and should be packaged
2322 that way. <filename>privoxy-index.html</filename> can also be
2323 included and can serve as a focal point for docs and other links of
2324 interest (and possibly renamed to <filename>index.html</filename>).
2325 This should be one level up from the manuals. There is a link also
2326 on this page to an HTMLized version of the man page. To avoid 404 for
2327 this, it is in CVS as
2328 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2329 and should be included along with the manuals. There is also a
2330 css stylesheets that can be included for better presentation:
2331 <filename>p_doc.css</filename>. This should be in the same directory
2332 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2333 the manual directories).
2338 <filename>user.action</filename> and <filename>user.filter</filename>
2339 are designed for local preferences. Make sure these do not get overwritten!
2340 <filename>config</filename> should not be overwritten either. This
2341 has especially important configuration data in it.
2342 <filename>trust</filename> should be left in tact as well.
2347 Other configuration files (<filename>default.action</filename> and
2348 <filename>default.filter</filename>) should be installed as the new
2349 defaults, but all previously installed configuration files should be
2350 preserved as backups. This is just good manners :-) These files are
2351 likely to change between releases and contain important new features
2357 Please check platform specific notes in this doc, if you haven't
2358 done <quote>Privoxy</quote> packaging before for other platform
2359 specific issues. Conversely, please add any notes that you know
2360 are important for your platform (or contact one of the doc
2361 maintainers to do this if you can't).
2366 Packagers should do a <quote>clean</quote> install of their
2367 package after building it. So any previous installs should be
2368 removed first to ensure the integrity of the newly built package.
2369 Then run the package for a while to make sure there are no
2370 obvious problems, before uploading.
2379 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2381 First, <emphasis>make sure that you have freshly exported the right
2382 version into an empty directory</emphasis>. (See "Building and releasing
2383 packages" above). Then run:
2388 autoheader && autoconf && ./configure
2400 To upload the package to Sourceforge, simply issue
2408 Go to the displayed URL and release the file publicly on Sourceforge.
2409 For the change log field, use the relevant section of the
2410 <filename>ChangeLog</filename> file.
2414 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2416 In following text, replace <replaceable class="parameter">dist</replaceable>
2417 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2420 First, <emphasis>make sure that you have freshly exported the right
2421 version into an empty directory</emphasis>. (See "Building and releasing
2425 As the only exception to not changing anything after export from CVS,
2426 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2427 and make sure that the version information and the RPM release number are
2428 correct. The RPM release numbers for each version start at one. Hence it must
2429 be reset to one if this is the first RPM for
2430 <replaceable class="parameter">dist</replaceable> which is built from version
2432 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">file
2433 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2434 release number for that version plus one.
2442 autoheader && autoconf && ./configure
2450 make <replaceable class="parameter">dist</replaceable>-dist
2454 To upload the package to Sourceforge, simply issue
2458 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2462 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2463 RPM release number as determined above.
2464 Go to the displayed URL and release the file publicly on Sourceforge.
2465 Use the release notes and change log from the source tarball package.
2469 <sect3 id="newrelease-os2"><title>OS/2</title>
2471 First, <emphasis>make sure that you have freshly exported the right
2472 version into an empty directory</emphasis>. (See "Building and releasing
2473 packages" above). Then get the OS/2 Setup module:
2477 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
2481 You will need a mix of development tools.
2482 The main compilation takes place with IBM Visual Age C++.
2483 Some ancillary work takes place with GNU tools, available from
2484 various sources like hobbes.nmsu.edu.
2485 Specificially, you will need <filename>autoheader</filename>,
2486 <filename>autoconf</filename> and <filename>sh</filename> tools.
2487 The packaging takes place with WarpIN, available from various sources, including
2488 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2491 Change directory to the <filename>os2setup</filename> directory.
2492 Edit the os2build.cmd file to set the final executable filename.
2497 installExeName='privoxyos2_setup_X.Y.Z.exe'
2501 Next, edit the <filename>IJB.wis</filename> file so the release number matches
2502 in the <filename>PACKAGEID</filename> section:
2506 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2510 You're now ready to build. Run:
2518 You will find the WarpIN-installable executable in the
2519 <filename>./files</filename> directory. Upload this anonymously to
2520 <filename>uploads.sourceforge.net/incoming</filename>, create a release
2521 for it, and you're done. Use the release notes and Change Log from the
2522 source tarball package.
2526 <sect3 id="newrelease-solaris"><title>Solaris</title>
2528 Login to Sourceforge's compilefarm via ssh:
2532 ssh cf.sourceforge.net
2536 Choose the right operating system (not the Debian one).
2537 When logged in, <emphasis>make sure that you have freshly exported the right
2538 version into an empty directory</emphasis>. (See "Building and releasing
2539 packages" above). Then run:
2544 autoheader && autoconf && ./configure
2556 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2557 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2558 to manually upload the archive to Sourceforge's ftp server and release
2559 the file publicly. Use the release notes and Change Log from the
2560 source tarball package.
2564 <sect3 id="newrelease-windows"><title>Windows</title>
2566 Use the <ulink url="http://www.fruitbat.org/Cygwin/index.html#cygwincirca">
2567 Cygwin Time Machine</ulink> to install the last 1.5 version of Cygwin.
2568 Run the following commands from within the Cygwin 1.5 bash shell.
2571 First, <emphasis>make sure that you have freshly exported the right
2572 version into an empty directory</emphasis>. (See "Building and releasing
2573 packages" above). Then get the Windows setup module:
2577 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
2581 Then you can build the package. This is fully automated, and is
2582 controlled by <filename>winsetup/GNUmakefile</filename>.
2583 All you need to do is:
2592 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2593 <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
2594 SourceForge. When releasing the package on SourceForge, use the release notes
2595 and Change Log from the source tarball package.
2599 <sect3 id="newrelease-debian"><title>Debian</title>
2601 First, <emphasis>make sure that you have freshly exported the
2602 right version into an empty directory</emphasis>. (See
2603 "Building and releasing packages" above). Then add a log
2604 entry to <filename>debian/changelog</filename>, if it is not
2605 already there, for example by running:
2609 debchange -v &p-version;-&p-status;-1 "New upstream version"
2617 dpkg-buildpackage -rfakeroot -us -uc -b
2622 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2623 which can be uploaded. To upload the package to Sourceforge, simply
2633 <sect3 id="newrelease-macosx"><title>Mac OS X</title>
2635 First, <emphasis>make sure that you have freshly exported the right
2636 version into an empty directory</emphasis>. (See "Building and releasing
2640 There are three modules available in the CVS repository for use on Mac
2641 OS X, though technically only two of them generate a release (the other
2642 can be used to install from source).
2644 <sect4 id="OS-X-OSXPackageBuilder-module">
2645 <title>OSXPackageBuilder module</title>
2647 The OSXPackageBuilder module generates OS X installer packages
2648 supporting all Macs running OS X 10.4 and above. Obtain it from CVS as
2649 follows into a folder parallel to the exported privoxy source:
2651 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
2655 The module contains complete instructions on its usage in the file
2656 <filename>OS X Package Builder HOWTO.txt</filename>.
2659 Once the package(s) have been generated, you can then upload them
2660 directly to the Files section of the Sourceforge project in the
2661 Macintosh (OS X) folder. Each new version release of Privoxy should
2662 have a new subfolder created in which to store its files. Please
2663 ensure that the folder contains a readme file that makes it clear
2664 which package is for whichversion of OS X.
2667 <sect4 id="OS-X-osxsetup-module">
2668 <title>osxsetup module (DEPRECATED)</title>
2670 <emphasis>This module is deprecated since the installer it generates
2671 places all Privoxy files in one folder in a non-standard location, and
2672 supports only Intel Macs running OS X 10.6 or higher.</emphasis>
2675 Check out the module from CVS as follows into a folder parallel to the
2676 exported privoxy source:
2678 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
2691 This will run <filename>autoheader</filename>, <filename>autoconf</filename>
2692 and <filename>configure</filename> as well as <filename>make</filename>.
2693 Finally, it will copy over the necessary files to the ./osxsetup/files
2694 directory for further processing by <filename>PackageMaker</filename>.
2697 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
2698 modify the package name to match the release, and hit the "Create
2699 package" button. If you specify ./Privoxy.pkg as the output package
2700 name, you can then create the distributable zip file with the command:
2704 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2708 You can then upload this file directly to the Files section of the
2709 Sourceforge project in the Macintosh (OS X) folder. Each new version
2710 release of Privoxy should have a new subfolder created in which to
2712 Please ensure that the folder contains a readme file that makes it
2713 clear which version(s) of OS X the package supports.
2716 <sect4 id="OS-X-macsetup-module">
2717 <title>macsetup module</title>
2719 The macsetup module is ideal if you wish to build and install Privoxy
2720 from source on a single machine.
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 macsetup
2730 The module contains complete instructions on its usage in its
2731 <filename>README</filename> file. The end result will be the
2732 exported version of Privoxy installed on the build machine.
2737 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2739 Update the www/privoxy port and submit a diff upstream.
2740 For details see the <ulink url="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/">FreeBSD Porter's Handbook</ulink>.
2744 <sect3 id="newrelease-aix"><title>AIX</title>
2746 Login to Sourceforge's compilefarm via ssh:
2750 ssh cf.sourceforge.net
2754 Choose the right operating system.
2755 When logged in, <emphasis>make sure that you have freshly exported the right
2756 version into an empty directory</emphasis>. (See "Building and releasing
2757 packages" above). Then run:
2762 autoheader && autoconf && ./configure
2774 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2775 aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
2776 to manually upload the archive to Sourceforge's ftp server and release
2777 the file publicly. Use the release notes and Change Log from the
2778 source tarball package.
2783 <sect2 id="releasing">
2784 <title>Uploading and Releasing Your Package</title>
2786 After the package is ready, it is time to upload it
2787 to SourceForge, and go through the release steps. The upload
2794 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2799 user: <literal>anonymous</literal>
2804 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2810 Or use the <command>make</command> targets as described above.
2813 Once this done go to <ulink
2814 url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
2815 >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
2816 making sure you are logged in. Find your target platform in the
2817 second column, and click <literal>Add Release</literal>. You will
2818 then need to create a new release for your package, using the format
2819 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2823 Now just follow the prompts. Be sure to add any appropriate Release
2824 notes. You should see your freshly uploaded packages in
2825 <quote>Step 2. Add Files To This Release</quote>. Check the
2826 appropriate box(es). Remember at each step to hit the
2827 <quote>Refresh/Submit</quote> buttons! You should now see your
2828 file(s) listed in Step 3. Fill out the forms with the appropriate
2829 information for your platform, being sure to hit <quote>Update</quote>
2830 for each file. If anyone is monitoring your platform, check the
2831 <quote>email</quote> box at the very bottom to notify them of
2832 the new package. This should do it!
2835 If you have made errors, or need to make changes, you can go through
2836 essentially the same steps, but select <literal>Edit Release</literal>,
2837 instead of <literal>Add Release</literal>.
2841 <sect2 id="afterrelease">
2842 <title>After the Release</title>
2844 When all (or: most of the) packages have been uploaded and made available,
2845 send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
2846 mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2848 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
2849 location</ulink>, the release notes and the Changelog. Also, post an
2850 updated News item on the project page Sourceforge, and update the Home
2851 page and docs linked from the Home page (see below). Other news sites
2852 and release oriented sites, such as Freshmeat, should also be notified.
2858 <!-- ~~~~~ New section ~~~~~ -->
2859 <sect1 id="webserver-update"><title>Update the Webserver</title>
2861 The webserver should be updated at least with each stable release. When
2862 updating, please follow these steps to make sure that no broken links,
2863 inconsistent contents or permission problems will occur (as it has many
2864 times in the past!):
2867 If you have changed anything in the stable-branch documentation source
2876 That will generate <filename>doc/webserver/user-manual</filename>,
2877 <filename>doc/webserver/developer-manual</filename>,
2878 <filename>doc/webserver/faq</filename>,
2879 <filename>doc/webserver/index.html</filename> automatically.
2882 If you changed the manual page sources, generate
2883 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2884 by running <quote><command>make man</command></quote>. (This is
2885 a separate target due to dependencies on some obscure perl scripts
2886 [now in CVS, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
2889 If you want to add new files to the webserver, create them locally in
2890 the <filename>doc/webserver/*</filename> directory (or
2891 create new directories under <filename>doc/webserver</filename>).
2894 Next, commit any changes from the above steps to CVS. All set?
2895 If these are docs in the stable branch, then do:
2903 This will do the upload to <ulink url="http://www.privoxy.org/">the
2904 webserver</ulink> (www.privoxy.org) and ensure all files and directories
2905 there are group writable.
2908 Please do <emphasis>NOT</emphasis> use any other means of transferring
2909 files to the webserver to avoid permission problems. Also, please do not
2910 upload docs from development branches or versions. The publicly posted
2911 docs should be in sync with the last official release.
2917 This program is free software; you can redistribute it
2918 and/or modify it under the terms of the GNU General
2919 Public License as published by the Free Software
2920 Foundation; either version 2 of the License, or (at
2921 your option) any later version.
2923 This program is distributed in the hope that it will
2924 be useful, but WITHOUT ANY WARRANTY; without even the
2925 implied warranty of MERCHANTABILITY or FITNESS FOR A
2926 PARTICULAR PURPOSE. See the GNU General Public
2927 License for more details.
2929 The GNU General Public License should be included with
2930 this file. If not, you can view it at
2931 http://www.gnu.org/copyleft/gpl.html
2932 or write to the Free Software Foundation, Inc., 59
2933 Temple Place - Suite 330, Boston, MA 02111-1307, USA.