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.29">
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 : doc/source/developer-manual.sgml
20 Purpose : developer manual
22 Copyright (C) 2001-2020 Privoxy Developers https://www.privoxy.org/
25 ========================================================================
26 NOTE: Please read developer-manual/documentation.html before touching
27 anything in this, or other Privoxy documentation. You have been warned!
28 Failure to abide by this rule will result in the revocation of your license
29 to live a peaceful existence!
30 ========================================================================
36 <title>Privoxy Developer Manual</title>
39 <!-- Completely the wrong markup, but very little is allowed -->
40 <!-- in this part of an article. FIXME -->
41 <ulink url="https://www.privoxy.org/user-manual/copyright.html">Copyright</ulink>
42 &my-copy; 2001-2020 by
43 <ulink url="https://www.privoxy.org/">Privoxy Developers</ulink>
49 Note: this should generate a separate page, and a live link to it.
50 But it doesn't for some mysterious reason. Please leave commented
51 unless it can be fixed proper. For the time being, the copyright
52 statement will be in copyright.smgl.
56 <legalnotice id="legalnotice">
58 text goes here ........
69 This is here to keep vim syntax file from breaking :/
70 If I knew enough to fix it, I would.
71 PLEASE DO NOT REMOVE! HB: hal@foobox.net
76 The developer manual provides guidance on coding, testing, packaging, documentation
77 and other issues of importance to those involved with
78 <application>Privoxy</application> development. It is mandatory (and helpful!) reading
79 for anyone who wants to join the team. Note that it's currently out of date
80 and may not be entirely correct. As always, patches are welcome.
83 <!-- Include privoxy.sgml boilerplate text: -->
85 <!-- &p-intro; Someone interested enough in the project to contribute
86 will already know at this point what Privoxy is. -->
88 <!-- end boilerplate -->
91 Please note that this document is constantly evolving. This copy represents
92 the state at the release of version &p-version;.
93 You can find the latest version of the this manual at <ulink
94 url="https://www.privoxy.org/developer-manual/">https://www.privoxy.org/developer-manual/</ulink>.
95 Please have a look at the
96 <ulink url="https://www.privoxy.org/user-manual/contact.html">contact section in the user manual</ulink>
97 if you are interested in contacting the developers.
104 <!-- ~~~~~ New section ~~~~~ -->
105 <sect1 id="introduction"><title>Introduction</title>
108 I don't like seeing blank space :) So added *something* here.
112 <application>Privoxy</application>, as an heir to
113 <application>Junkbuster</application>, is a Free Software project
114 and the code is licensed under the GNU General Public License version 2.
115 As such, <application>Privoxy</application> development is potentially open
116 to anyone who has the time, knowledge, and desire to contribute
117 in any capacity. Our goals are simply to continue the mission,
118 to improve <application>Privoxy</application>, and
119 to make it available to as wide an audience as possible.
122 One does not have to be a programmer to contribute. Packaging, testing,
123 documenting and porting, are all important jobs as well.
126 <!-- ~~~~~ New section ~~~~~ -->
127 <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
129 The first step is to join the <ulink
130 url="https://lists.privoxy.org/mailman/listinfo/privoxy-devel">privoxy-devel mailing list</ulink>.
131 You can submit your ideas or, even better, patches. Patches are best
132 submitted to the Sourceforge tracker set up for this purpose, but
133 can be sent to the list for review too.
136 You will also need to have a git package installed,
137 in order to access the git repository.
138 Having the GNU build tools is also going to be important (particularly,
142 For the time being (read, this section is under construction), you can
143 also refer to the extensive comments in the source code. In fact,
144 reading the code is recommended in any case.
149 <!-- ~~~~~ New section ~~~~~ -->
150 <sect1 id="git"><title>The Git Repository</title>
152 If you become part of the active development team, you will eventually
153 need write access to our holy grail, the Git repository. One of the
154 team members will need to set this up for you. Please read
155 this chapter completely before accessing via Git.
158 <sect2 id="gitaccess"><title>Access to Git</title>
160 The project's Git repository is hosted at the
161 <ulink url="https://privoxy.org/">Privoxy website</ulink>.
162 For Privoxy team members with push privileges the Git repository URL is
163 <literal>ssh://git@git.privoxy.org:23/git/privoxy.git</literal>.
166 Contributors without push privileges can
167 <quote>git clone https://www.privoxy.org/git/privoxy.git</quote>.
170 The central repository is called <literal>privoxy</literal>, and the
171 source branch is called <literal>master</literal>. Subfolders exist
172 within the project for target-dependent build and packaging tools, each
173 including the name of the target operating system in their name (e.g.
174 Windows, OSXPackageBuilder, debian). There is a webview of the Git
176 <ulink url="https://www.privoxy.org/gitweb/?p=privoxy.git;a=tree">
177 https://www.privoxy.org/gitweb/?p=privoxy.git;a=tree</ulink>,
178 which might help with visualizing how these pieces fit together.
182 <sect2 id="gitbranches">
183 <title>Branches</title>
185 Whilst the central repository contains only the master branch, developers
186 are of course free to create branches in their local repositories as they
187 develop features, fixes, or update the target-dependent tools. Only once
188 such changes are fully tested ought they be pushed back to the central
189 repository master branch.
193 Branches are used to fork a sub-development path from the main trunk.
194 Within the <literal>current</literal> module where the sources are, there
195 is always at least one <quote>branch</quote> from the main trunk
196 devoted to a stable release series. The main trunk is where active
197 development takes place for the next stable series (e.g. 3.2.x).
198 So just prior to each stable series (e.g. 3.0.x), a branch is created
199 just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
200 Once the initial stable release of any stable branch has taken place,
201 this branch is <emphasis>only used for bugfixes</emphasis>, which have
202 had prior testing before being committed to Git. (See <link
203 linkend="versionnumbers">Version Numbers</link> below for details on
208 At one time there were two distinct branches: stable and unstable. The
209 more drastic changes were to be in the unstable branch. These branches
210 have now been merged to minimize time and effort of maintaining two
215 This will result in at least two active branches, which means there may
216 be occasions that require the same (or similar) item to be
217 checked into to two different places (assuming its a bugfix and needs
218 fixing in both the stable and unstable trees). This also means that in
219 order to have access to both trees, both will have to be checked out
220 separately. Use the <literal>cvs -r</literal> flag to check out a
221 branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
226 <sect2 id="gitcommit"><title>Git Commit Guidelines</title>
228 The source tree is the heart of every software project. Every effort must
229 be made to ensure that it is readable, compilable and consistent at all
230 times. <!-- There are differing guidelines for the stable branch and the
231 main development trunk, and --> We expect anyone with Git access to strictly
232 adhere to the following guidelines:
236 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 Git, 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.
276 Stable branches are handled with more care, especially after the
277 initial *.*.0 release, and we are just in bugfix mode. In addition to
278 the above, the below applies only to the stable branch (currently the
279 <literal>v_3_0_branch</literal> branch):
286 Do not commit <emphasis>anything</emphasis> unless your proposed
287 changes have been well tested first, preferably by other members of the
288 project, or have prior approval of the project leaders or consensus
294 Where possible, bugfixes and changes should be tested in the main
295 development trunk first. There may be occasions where this is not
301 Alternately, proposed changes can be submitted as patches output by
302 <literal>git format-patch</literal> to the privoxy-devel mailing list
303 or alternatively to the patch tracker on Sourceforge:
304 <ulink url="https://sourceforge.net/tracker/?group_id=11118&atid=311118">
305 https://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
306 Then ask for peer review.
311 Do not even think about anything except bugfixes. No new features!
322 <!-- ~~~~~ New section ~~~~~ -->
323 <sect1 id="documentation"><title>Documentation Guidelines</title>
325 All formal documents are maintained in Docbook SGML and located in the
326 <computeroutput>doc/source/*</computeroutput> directory. You will need
327 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
328 DTD's and the Docbook modular stylesheets (or comparable alternatives),
329 and either <application>jade</application> or
330 <application>openjade</application> (recommended) installed in order to
331 build docs from source. Currently there is <ulink
332 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
333 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
334 course this, the <citetitle>developer-manual</citetitle> in this format.
335 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
336 <citetitle>INSTALL</citetitle>,
337 <citetitle>privoxy.1</citetitle> (man page), and
338 <citetitle>config</citetitle> files are also now maintained as Docbook
339 SGML. These files, when built, in the top-level source directory are
340 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
341 variation on this file, <filename>privoxy-index.html</filename>,
342 meant for inclusion with doc packages), are maintained as SGML as well.
343 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
344 contact someone involved in the documentation.
347 <filename>config</filename> requires some special handling. The reason it
348 is maintained this way is so that the extensive comments in the file
349 mirror those in <citetitle>user-manual</citetitle>. But the conversion
350 process requires going from SGML to HTML to text to special formatting
351 required for the embedded comments. Some of this does not survive so
352 well. Especially some of the examples that are longer than 80 characters.
353 The build process for this file outputs to <filename>config.new</filename>,
354 which should be reviewed for errors and mis-formatting. Once satisfied
355 that it is correct, then it should be hand copied to
356 <filename>config</filename>.
359 Other, less formal documents (e.g. <filename>LICENSE</filename>) are
360 maintained as plain text files in the top-level source directory.
363 Packagers are encouraged to include this documentation. For those without
364 the ability to build the docs locally, text versions of each are kept in
365 Git. HTML versions are also being kept in Git under
366 <filename>doc/webserver/*</filename>.
369 Formal documents are built with the Makefile targets of
370 <computeroutput>make dok</computeroutput>.
371 The build process uses the document SGML sources in
372 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
373 <computeroutput>doc/text/</computeroutput> and to update all HTML
374 documents in <computeroutput>doc/webserver/</computeroutput>.
377 Documentation writers should please make sure documents build
378 successfully before committing to Git, if possible.
381 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.
397 Finished docs should be occasionally submitted to Git
398 (<filename>doc/webserver/*/*.html</filename>) so that those without
399 the ability to build them locally, have access to them if needed.
400 This is especially important just prior to a new release! Please
401 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
402 other release specific data in <filename>configure.in</filename> has been
403 updated (this is done just prior to a new release).
406 <!-- ~~~~~ New section ~~~~~ -->
408 <title>Quickstart to Docbook and SGML</title>
410 If you are not familiar with SGML, it is a markup language similar to HTML.
411 Actually, not a mark up language per se, but a language used to define
412 markup languages. In fact, HTML is an SGML application. Both will use
413 <quote>tags</quote> to format text and other content. SGML tags can be much
414 more varied, and flexible, but do much of the same kinds of things. The tags,
415 or <quote>elements</quote>, are definable in SGML. There is no set
416 <quote>standards</quote>. Since we are using
417 <application>Docbook</application>, our tags are those that are defined by
418 <application>Docbook</application>. Much of how the finish document is
419 rendered is determined by the <quote>stylesheets</quote>.
420 The stylesheets determine how each tag gets translated to HTML, or other
425 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
426 will likely generate errors. Example: <literal><title>My
427 Title</title></literal>. They are also case-insensitive, but we
428 strongly suggest using all lower case. This keeps compatibility with
429 [Docbook] <application>XML</application>.
433 Our documents use <quote>sections</quote> for the most part. Sections
434 will be processed into HTML headers (e.g. <literal>h1</literal> for
435 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
436 will use these to also generate the Table of Contents for each doc. Our
437 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
438 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
439 entries, but <literal>sect4</literal> will not. Each section requires
440 a <literal><title></literal> element, and at least one
441 <literal><para></literal>. There is a limit of five section
442 levels in Docbook, but generally three should be sufficient for our
447 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.
489 Look at any of the existing docs for examples of all these and more.
494 <!-- <quote><ulink url="http://opensource.bureau-cornavin.com/crash-course/index.html">
495 domain no longer exists so link to the wayback archive -->
496 <quote><ulink url="https://web.archive.org/web/20160315230758/http://opensource.bureau-cornavin.com/crash-course/index.html">
497 Writing Documentation Using DocBook - A Crash Course</ulink></quote> useful.
501 <!-- ~~~~~ New section ~~~~~ -->
502 <sect2 id="docstyle">
503 <title><application>Privoxy</application> Documentation Style</title>
505 It will be easier if everyone follows a similar writing style. This
506 just makes it easier to read what someone else has written if it
507 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:
529 Tags marking individual words, or few words, should be in-line:
532 Just to <emphasis>emphasize</emphasis>, some text goes here.
537 Tags should be nested and step indented for block text like: (except
545 Some text goes here in our list example.
548 </itemizedlist>
552 This makes it easier to find the text amongst the tags ;-)
557 Use white space to separate logical divisions within a document,
558 like between sections. Running everything together consistently
559 makes it harder to read and work on.
564 Do not hesitate to make comments. Comments can either use the
565 <comment> element, or the <!-- --> style comment
566 familiar from HTML. (Note in Docbook v4.x <comment> is
567 replaced by <remark>.)
572 We have an international audience. Refrain from slang, or English
573 idiosyncrasies (too many to list :). Humor also does not translate
579 Try to keep overall line lengths in source files to 80 characters or less
580 for obvious reasons. This is not always possible, with lengthy URLs for
586 Our documents are available in differing formats. Right now, they
587 are just plain text and/or HTML, but others are always a
588 future possibility. Be careful with URLs (<ulink>), and avoid
592 My favorite site is <ulink url="http://example.com">here</ulink>.
595 This will render as <quote>My favorite site is here</quote>, which is
596 not real helpful in a text doc. Better like this:
599 My favorite site is <ulink url="http://example.com">example.com</ulink>.
604 All documents should be spell checked occasionally.
605 <application>aspell</application> can check SGML with the
606 <literal>-H</literal> option. (<application>ispell</application> I think
616 <!-- ~~~~~ New section ~~~~~ -->
618 <sect2><title>Privoxy Custom Entities</title>
620 <application>Privoxy</application> documentation is using
621 a number of customized <quote>entities</quote> to facilitate
622 documentation maintenance.
625 We are using a set of <quote>boilerplate</quote> files with generic text,
626 that is used by multiple docs. This way we can write something once, and use
627 it repeatedly without having to re-write the same content over and over again.
628 If editing such a file, keep in mind that it should be
629 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
630 contexts without additional modifications.
633 We are also using what <application>Docbook</application> calls
634 <quote>internal entities</quote>. These are like variables in
635 programming. Well, sort of. For instance, we have the
636 <literal>p-version</literal> entity that contains the current
637 <application>Privoxy</application> version string. You are strongly
638 encouraged to use these where possible. Some of these obviously
639 require re-setting with each release (done by the Makefile). A sampling of
640 custom entities are listed below. See any of the main docs for examples.
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.
663 Commonly used <quote>internal entities</quote>:
667 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
668 version string, e.g. <quote>&p-version;</quote>.
671 <emphasis>p-status</emphasis>: the project status, either
672 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
675 <emphasis>p-not-stable</emphasis>: use to conditionally include
676 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
679 <emphasis>p-stable</emphasis>: just the opposite.
682 <emphasis>p-text</emphasis>: this doc is only generated as text.
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>
955 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>
980 int loadsomefile(struct client_state *csp)
981 int loadSomeFile(struct client_state *csp)
988 <sect3 id="s12"><title>Header file prototypes</title>
990 <para><emphasis>Explanation:</emphasis></para>
992 <para>Use a descriptive parameter name in the function prototype
993 in header files. Use the same parameter name in the header file
994 that you use in the c file.</para>
996 <para><emphasis>Example:</emphasis></para>
998 (.h) extern int load_aclfile(struct client_state *csp);
999 (.c) int load_aclfile(struct client_state *csp)</programlisting>
1001 <para><emphasis>Instead of:</emphasis></para>
1003 (.h) extern int load_aclfile(struct client_state *); or
1004 (.h) extern int load_aclfile();
1005 (.c) int load_aclfile(struct client_state *csp)
1012 <sect3 id="s13"><title>Enumerations, and #defines</title>
1014 <para><emphasis>Explanation:</emphasis></para>
1016 <para>Use all capital letters, with underscores between words. Do
1017 not start an identifier with an underscore. (ANSI C reserves
1018 these for use by the compiler and system headers.)</para>
1020 <para><emphasis>Example:</emphasis></para>
1022 (enumeration) : enum Boolean {FALSE, TRUE};
1023 (#define) : #define DEFAULT_SIZE 100;</programlisting>
1025 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
1026 that toggle a feature in the preprocessor: FEATURE_>, where
1027 > is a short (preferably 1 or 2 word) description.</para>
1029 <para><emphasis>Example:</emphasis></para>
1031 #define FEATURE_FORCE 1
1033 #ifdef FEATURE_FORCE
1034 #define FORCE_PREFIX blah
1035 #endif /* def FEATURE_FORCE */
1040 <sect3 id="s14"><title>Constants</title>
1042 <para><emphasis>Explanation:</emphasis></para>
1044 <para>Spell common words out entirely (do not remove vowels).</para>
1046 <para>Use only widely-known domain acronyms and abbreviations.
1047 Capitalize all letters of an acronym.</para>
1049 <para>Use underscore (_) to separate adjacent acronyms and
1050 abbreviations. Never terminate a name with an underscore.</para>
1052 <para><emphasis>Example:</emphasis></para>
1054 #define USE_IMAGE_LIST 1</programlisting>
1056 <para><emphasis>Instead of:</emphasis></para>
1059 #define USE_IMG_LST 1 or
1060 #define _USE_IMAGE_LIST 1 or
1061 #define USE_IMAGE_LIST_ 1 or
1062 #define use_image_list 1 or
1063 #define UseImageList 1
1072 <sect2 id="s15"><title>Using Space</title>
1076 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1078 <para><emphasis>Explanation:</emphasis></para>
1080 <para>The brace needs to be on a line all by itself, not at the
1081 end of the statement. Curly braces should line up with the
1082 construct that they're associated with. This practice makes it
1083 easier to identify the opening and closing braces for a
1086 <para><emphasis>Example:</emphasis></para>
1093 <para><emphasis>Instead of:</emphasis></para>
1095 <para>if (this == that) { ... }</para>
1099 <para>if (this == that) { ... }</para>
1101 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1102 inside a loop, and it is trivial, i.e. it tests for a
1103 condition that is obvious from the purpose of the block,
1104 one-liners as above may optically preserve the loop structure
1105 and make it easier to read.</para>
1107 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1109 <para><emphasis>Example exception:</emphasis></para>
1111 while (more lines are read)
1113 /* Please document what is/is not a comment line here */
1114 if (it's a comment) continue;
1122 <sect3 id="s17"><title>ALL control statements should have a
1125 <para><emphasis>Explanation:</emphasis></para>
1127 <para>Using braces to make a block will make your code more
1128 readable and less prone to error. All control statements should
1129 have a block defined.</para>
1131 <para><emphasis>Example:</emphasis></para>
1136 do_something_else();
1139 <para><emphasis>Instead of:</emphasis></para>
1141 <para>if (this == that) do_something(); do_something_else();</para>
1145 <para>if (this == that) do_something();</para>
1147 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1148 in a manner other than that which the developer desired (per
1149 indentation). Using code braces would have prevented this
1150 "feature". The "explanation" and "exception" from the point
1151 above also applies.</para>
1157 <sect3 id="s18"><title>Do not belabor/blow-up boolean
1160 <para><emphasis>Example:</emphasis></para>
1162 structure->flag = (condition);</programlisting>
1164 <para><emphasis>Instead of:</emphasis></para>
1166 <para>if (condition) { structure->flag = 1; } else {
1167 structure->flag = 0; }</para>
1169 <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1170 is wordy and inefficient. Please assume that any developer new
1171 to the project has at least a "good" knowledge of C/C++. (Hope
1172 I do not offend by that last comment ... 8-)</para>
1178 <sect3 id="s19"><title>Use white space freely because it is
1181 <para><emphasis>Explanation:</emphasis></para>
1183 <para>Make it readable. The notable exception to using white space
1184 freely is listed in the next guideline.</para>
1186 <para><emphasis>Example:</emphasis></para>
1188 int first_value = 0;
1190 int another_value = 0;
1191 int this_variable = 0;
1196 <sect3 id="s20"><title>Don't use white space around structure
1199 <para><emphasis>Explanation:</emphasis></para>
1201 <para>- structure pointer operator ( "->" ) - member operator (
1202 "." ) - functions and parentheses</para>
1204 <para>It is a general coding practice to put pointers, references,
1205 and function parentheses next to names. With spaces, the
1206 connection between the object and variable/function name is not
1209 <para><emphasis>Example:</emphasis></para>
1213 function_name();</programlisting>
1215 <para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
1216 function_name ();</para>
1222 <sect3 id="s21"><title>Make the last brace of a function stand
1225 <para><emphasis>Example:</emphasis></para>
1227 int function1( ... )
1232 } /* -END- function1 */
1235 int function2( ... )
1237 } /* -END- function2 */
1240 <para><emphasis>Instead of:</emphasis></para>
1242 <para>int function1( ... ) { ...code... return(ret_code); } int
1243 function2( ... ) { }</para>
1245 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1246 lines afterward. This makes the end of function standout to
1247 the most casual viewer. Although function comments help
1248 separate functions, this is still a good coding practice. In
1249 fact, I follow these rules when using blocks in "for", "while",
1250 "do" loops, and long if {} statements too. After all whitespace
1253 <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1254 lines. Enforced is the end of function comments.</para>
1260 <sect3 id="s22"><title>Use 3 character indentions</title>
1262 <para><emphasis>Explanation:</emphasis></para>
1264 <para>If some use 8 character TABs and some use 3 character TABs,
1265 the code can look *very* ragged. So use 3 character indentions
1266 only. If you like to use TABs, pass your code through a filter
1267 such as "expand -t3" before checking in your code.</para>
1269 <para><emphasis>Example:</emphasis></para>
1271 static const char * const url_code_map[256] =
1277 int function1( ... )
1285 return HOW_DID_YOU_GET_HERE;
1288 return NEVER_GETS_HERE;
1297 <sect2 id="s23"><title>Initializing</title>
1301 <sect3 id="s24"><title>Initialize all variables</title>
1303 <para><emphasis>Explanation:</emphasis></para>
1305 <para>Do not assume that the variables declared will not be used
1306 until after they have been assigned a value somewhere else in
1307 the code. Remove the chance of accidentally using an unassigned
1310 <para><emphasis>Example:</emphasis></para>
1314 struct *ptr = NULL;</programlisting>
1316 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1317 message says you are trying to access memory address 00000000
1318 and not 129FA012; or array_ptr[20] causes a SIGSEV vs.
1319 array_ptr[0].</para>
1321 <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1322 variable is assigned a value "shortly after" declaration.</para>
1328 <sect2 id="s25"><title>Functions</title>
1332 <sect3 id="s26"><title>Name functions that return a boolean as a
1335 <para><emphasis>Explanation:</emphasis></para>
1337 <para>Value should be phrased as a question that would logically
1338 be answered as a true or false statement</para>
1340 <para><emphasis>Example:</emphasis></para>
1342 should_we_block_this();
1343 contains_an_image();
1344 is_web_page_blank();
1349 <sect3 id="s27"><title>Always specify a return type for a
1352 <para><emphasis>Explanation:</emphasis></para>
1354 <para>The default return for a function is an int. To avoid
1355 ambiguity, create a return for a function when the return has a
1356 purpose, and create a void return type if the function does not
1357 need to return anything.</para>
1363 <sect3 id="s28"><title>Minimize function calls when iterating by
1364 using variables</title>
1366 <para><emphasis>Explanation:</emphasis></para>
1368 <para>It is easy to write the following code, and a clear argument
1369 can be made that the code is easy to understand:</para>
1371 <para><emphasis>Example:</emphasis></para>
1373 for (size_t cnt = 0; cnt < block_list_length(); cnt++)
1378 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1379 each and every iteration. This increases the overhead in the
1380 program, because the compiler has to look up the function each
1381 time, call it, and return a value. Depending on what occurs in
1382 the block_list_length() call, it might even be creating and
1383 destroying structures with each iteration, even though in each
1384 case it is comparing "cnt" to the same value, over and over.
1385 Remember too - even a call to block_list_length() is a function
1386 call, with the same overhead.</para>
1388 <para>Instead of using a function call during the iterations,
1389 assign the value to a variable, and evaluate using the
1392 <para><emphasis>Example:</emphasis></para>
1394 size_t len = block_list_length();
1396 for (size_t cnt = 0; cnt < len; cnt++)
1401 <para><emphasis>Exceptions:</emphasis> if the value of block_list_length()
1402 *may* change or could *potentially* change, then you must code the
1403 function call in the for/while loop.</para>
1409 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1411 <para><emphasis>Explanation:</emphasis></para>
1413 <para>This allows a developer to define a const pointer and call
1414 your function. If your function does not have the const
1415 keyword, we may not be able to use your function. Consider
1416 strcmp, if it were defined as: extern int strcmp(char *s1,
1419 <para>I could then not use it to compare argv's in main: int
1420 main(int argc, const char *argv[]) { strcmp(argv[0], "privoxy");
1423 <para>Both these pointers are *const*! If the c runtime library
1424 maintainers do it, we should too.</para>
1430 <sect3 id="s30"><title>Pass and Return by Value</title>
1432 <para><emphasis>Explanation:</emphasis></para>
1434 <para>Most structures cannot fit onto a normal stack entry (i.e.
1435 they are not 4 bytes or less). Aka, a function declaration
1436 like: int load_aclfile(struct client_state csp)</para>
1438 <para>would not work. So, to be consistent, we should declare all
1439 prototypes with "pass by value": int load_aclfile(struct
1440 client_state *csp)</para>
1446 <sect3 id="s31"><title>Names of include files</title>
1448 <para><emphasis>Explanation:</emphasis></para>
1450 <para>Your include statements should contain the file name without
1451 a path. The path should be listed in the Makefile, using -I as
1452 processor directive to search the indicated paths. An exception
1453 to this would be for some proprietary software that utilizes a
1454 partial path to distinguish their header files from system or
1455 other header files.</para>
1457 <para><emphasis>Example:</emphasis></para>
1459 #include <iostream.h> /* This is not a local include */
1460 #include "config.h" /* This IS a local include */
1463 <para><emphasis>Exception:</emphasis></para>
1466 /* This is not a local include, but requires a path element. */
1467 #include <sys/fileName.h>
1470 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1471 without a _very_ good reason. This duplicates the #include
1472 "file.h" behavior.</para>
1478 <sect3 id="s32"><title>Provide multiple inclusion
1481 <para><emphasis>Explanation:</emphasis></para>
1483 <para>Prevents compiler and linker errors resulting from
1484 redefinition of items.</para>
1486 <para>Wrap each header file with the following syntax to prevent
1487 multiple inclusions of the file. Of course, replace PROJECT_H
1488 with your file name, with "." Changed to "_", and make it
1491 <para><emphasis>Example:</emphasis></para>
1493 #ifndef PROJECT_H_INCLUDED
1494 #define PROJECT_H_INCLUDED
1496 #endif /* ndef PROJECT_H_INCLUDED */
1501 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1503 <para><emphasis>Explanation:</emphasis></para>
1505 <para>If our headers are included from C++, they must declare our
1506 functions as `extern "C"`. This has no cost in C, but increases
1507 the potential re-usability of our code.</para>
1509 <para><emphasis>Example:</emphasis></para>
1514 #endif /* def __cplusplus */
1516 ... function definitions here ...
1520 #endif /* def __cplusplus */
1525 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1526 Declaration Instead of Includes</title>
1528 <para><emphasis>Explanation:</emphasis></para>
1530 <para>Useful in headers that include pointers to other struct's.
1531 Modifications to excess header files may cause needless
1534 <para><emphasis>Example:</emphasis></para>
1536 /*********************************************************************
1537 * We're avoiding an include statement here!
1538 *********************************************************************/
1540 extern file_list *xyz;</programlisting>
1542 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1543 pointer), then including the proper header file is necessary.
1544 If you only want to prototype a pointer, however, the header
1545 file is unnecessary.</para>
1547 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1553 <sect2 id="s35"><title>General Coding Practices</title>
1557 <sect3 id="s36"><title>Turn on warnings</title>
1559 <para><emphasis>Explanation</emphasis></para>
1561 <para>Compiler warnings are meant to help you find bugs. You
1562 should turn on as many as possible. With GCC, the switch is
1563 "-Wall". Try and fix as many warnings as possible.</para>
1569 <sect3 id="s37"><title>Provide a default case for all switch
1572 <para><emphasis>Explanation:</emphasis></para>
1574 <para>What you think is guaranteed is never really guaranteed. The
1575 value that you don't think you need to check is the one that
1576 someday will be passed. So, to protect yourself from the
1577 unknown, always have a default step in a switch statement.</para>
1579 <para><emphasis>Example:</emphasis></para>
1581 switch (hash_string(cmd))
1583 case hash_actions_file:
1593 ... anomaly code goes here ...
1594 continue; / break; / exit( 1 ); / etc ...
1596 } /* end switch (hash_string(cmd)) */</programlisting>
1598 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1599 are obviously exempt from this point. Of note, most of the
1600 WIN32 code calls `DefWindowProc' after the switch statement.
1601 This API call *should* be included in a default statement.</para>
1603 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1604 as a robust programming issue. The "anomaly code goes here" may
1605 be no more than a print to the STDERR stream (as in
1606 load_config). Or it may really be an abort condition.</para>
1608 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1614 <sect3 id="s38"><title>Try to avoid falling through cases in a
1615 switch statement.</title>
1617 <para><emphasis>Explanation:</emphasis></para>
1619 <para>In general, you will want to have a 'break' statement within
1620 each 'case' of a switch statement. This allows for the code to
1621 be more readable and understandable, and furthermore can
1622 prevent unwanted surprises if someone else later gets creative
1623 and moves the code around.</para>
1625 <para>The language allows you to plan the fall through from one
1626 case statement to another simply by omitting the break
1627 statement within the case statement. This feature does have
1628 benefits, but should only be used in rare cases. In general,
1629 use a break statement for each case statement.</para>
1631 <para>If you choose to allow fall through, you should comment both
1632 the fact of the fall through and reason why you felt it was
1639 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1641 <para><emphasis>Explanation:</emphasis></para>
1643 <para>The type of size_t varies across platforms. Do not make
1644 assumptions about whether it is signed or unsigned, or about
1645 how long it is. Do not compare a size_t against another
1646 variable of a different type (or even against a constant)
1647 without casting one of the values.</para>
1653 <sect3 id="s41"><title>Declare each variable and struct on its
1656 <para><emphasis>Explanation:</emphasis></para>
1658 <para>It can be tempting to declare a series of variables all on
1659 one line. Don't.</para>
1661 <para><emphasis>Example:</emphasis></para>
1665 long c = 0;</programlisting>
1667 <para><emphasis>Instead of:</emphasis></para>
1669 <para>long a, b, c;</para>
1671 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1672 individual variables - easier to add new variables without
1673 messing up the original ones - when searching on a variable to
1674 find its type, there is less clutter to "visually"
1677 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1678 variables or other trivial variables; feel free to declare them
1679 on one line. You should, although, provide a good comment on
1680 their functions.</para>
1682 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1688 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1690 <para><emphasis>Explanation:</emphasis></para>
1692 <para>Create a local struct (on the stack) if the variable will
1693 live and die within the context of one function call.</para>
1695 <para>Only "malloc" a struct (on the heap) if the variable's life
1696 will extend beyond the context of one function call.</para>
1698 <para><emphasis>Example:</emphasis></para>
1700 If a function creates a struct and stores a pointer to it in a
1701 list, then it should definitely be allocated via `malloc'.
1706 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1707 Responsible for Ensuring 'free'</title>
1709 <para><emphasis>Explanation:</emphasis></para>
1711 <para>If you have to "malloc" an instance, you are responsible for
1712 insuring that the instance is `free'd, even if the deallocation
1713 event falls within some other programmer's code. You are also
1714 responsible for ensuring that deletion is timely (i.e. not too
1715 soon, not too late). This is known as "low-coupling" and is a
1716 "good thing (tm)". You may need to offer a
1717 free/unload/destructor type function to accommodate this.</para>
1719 <para><emphasis>Example:</emphasis></para>
1721 int load_re_filterfile(struct client_state *csp) { ... }
1722 static void unload_re_filterfile(void *f) { ... }</programlisting>
1724 <para><emphasis>Exceptions:</emphasis></para>
1726 <para>The developer cannot be expected to provide `free'ing
1727 functions for C run-time library functions ... such as
1730 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1731 standard is for allocating and freeing data structures (complex
1738 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1739 and in order</title>
1741 <para><emphasis>Explanation:</emphasis></para>
1743 <para>I have ordered all of the "blocker" file code to be in alpha
1744 order. It is easier to add/read new blockers when you expect a
1745 certain order.</para>
1747 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1748 places by POPUP tests coming before PCRS tests. But since
1749 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1750 it should come first.</para>
1756 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1757 existing code, use XXX</title>
1759 <para><emphasis>Explanation:</emphasis></para>
1761 <para>If you have enough confidence in new code or confidence in
1762 your changes, but are not *quite* sure of the repercussions,
1765 <para>/* XXX: this code has a logic error on platform XYZ, *
1766 attempting to fix */ #ifdef PLATFORM ...changed code here...
1771 <para>/* XXX: I think the original author really meant this...
1772 */ ...changed code here...</para>
1776 <para>/* XXX: new code that *may* break something else... */
1777 ...new code here...</para>
1779 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1780 be a "good thing (tm)", it will be easier to identify and
1781 include in the project (or conversely exclude from the
1789 <sect2 id="s46"><title>Addendum: Template for files and function
1790 comment blocks:</title>
1792 <para><emphasis>Example for file comments:</emphasis></para>
1794 /*********************************************************************
1798 * Purpose : (Fill me in with a good description!)
1800 * Copyright : Written by and Copyright (C) 2001-2009
1801 * the Privoxy team. https://www.privoxy.org/
1803 * This program is free software; you can redistribute it
1804 * and/or modify it under the terms of the GNU General
1805 * Public License as published by the Free Software
1806 * Foundation; either version 2 of the License, or (at
1807 * your option) any later version.
1809 * This program is distributed in the hope that it will
1810 * be useful, but WITHOUT ANY WARRANTY; without even the
1811 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1812 * PARTICULAR PURPOSE. See the GNU General Public
1813 * License for more details.
1815 * The GNU General Public License should be included with
1816 * this file. If not, you can view it at
1817 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1818 * or write to the Free Software Foundation, Inc.,
1819 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1822 *********************************************************************/
1827 ...necessary include files for us to do our work...
1829 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1832 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1833 added to the "show-version" page. If this is a brand new
1834 creation by you, you are free to change the "Copyright" section
1835 to represent the rights you wish to maintain.</para>
1837 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1838 after the comment flower box is handy for (X|GNU)Emacs users to
1839 skip the verbiage and get to the heart of the code (via
1840 `forward-page' and `backward-page'). Please include it if you
1843 <para><emphasis>Example for file header comments:</emphasis></para>
1847 /*********************************************************************
1851 * Purpose : (Fill me in with a good description!)
1853 * Copyright : Written by and Copyright (C) 2001-2009
1854 * the Privoxy team. https://www.privoxy.org/
1856 * This program is free software; you can redistribute it
1857 * and/or modify it under the terms of the GNU General
1858 * Public License as published by the Free Software
1859 * Foundation; either version 2 of the License, or (at
1860 * your option) any later version.
1862 * This program is distributed in the hope that it will
1863 * be useful, but WITHOUT ANY WARRANTY; without even the
1864 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1865 * PARTICULAR PURPOSE. See the GNU General Public
1866 * License for more details.
1868 * The GNU General Public License should be included with
1869 * this file. If not, you can view it at
1870 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1871 * or write to the Free Software Foundation, Inc.,
1872 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1875 *********************************************************************/
1878 #include "project.h"
1884 ... function headers here ...
1887 /* Revision control strings from this header and associated .c file */
1888 extern const char FILENAME_rcs[];
1889 extern const char FILENAME_h_rcs[];
1896 #endif /* ndef _FILENAME_H */
1905 <para><emphasis>Example for function comments:</emphasis></para>
1907 /*********************************************************************
1909 * Function : FUNCTION_NAME
1911 * Description : (Fill me in with a good description!)
1914 * 1 : param1 = pointer to an important thing
1915 * 2 : x = pointer to something else
1917 * Returns : 0 => Ok, everything else is an error.
1919 *********************************************************************/
1920 int FUNCTION_NAME(void *param1, const char *x)
1928 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1929 able to parse our code to create a "self-documenting" web
1936 <!-- ~~~~~ New section ~~~~~ -->
1937 <sect1 id="testing"><title>Testing Guidelines</title>
1941 <!-- ~~~~~ New section ~~~~~ -->
1942 <sect2 id="testing-plan"><title>Testplan for releases</title>
1944 Explain release numbers. major, minor. developer releases. etc.
1946 <orderedlist numeration="arabic">
1948 Remove any existing rpm with rpm -e
1951 Remove any file that was left over. This includes (but is not limited to)
1954 <listitem><para>/var/log/privoxy</para></listitem>
1955 <listitem><para>/etc/privoxy</para></listitem>
1956 <listitem><para>/usr/sbin/privoxy</para></listitem>
1957 <listitem><para>/etc/init.d/privoxy</para></listitem>
1958 <listitem><para>/usr/doc/privoxy*</para></listitem>
1962 Install the rpm. Any error messages?
1964 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1965 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1966 autostart work?</para></listitem>
1967 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1968 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1971 <!-- XXX: Document how to write test reports and where to send them -->
1973 <!-- ~~~~~ New section ~~~~~ -->
1974 <sect2 id="fuzzing"><title>Fuzzing Privoxy</title>
1976 To make fuzzing more convenient, Privoxy can be configured
1977 with --enable-fuzz which will result in the --fuzz option
1981 Example (tested on ElectroBSD):
1984 # Compile Privoxy with instrumentation for afl
1985 $ export CC=afl-clang
1986 $ export CFLAGS="-fsanitize=address -ggdb"
1987 $ export CPPFLAGS=-I/usr/local/include/
1988 $ export LDFLAGS="-fsanitize=address -L/usr/local/lib"
1989 $ export AFL_USE_ASAN=1
1990 $ export AFL_HARDEN=1
1991 $ ./configure --with-debug --enable-extended-host-patterns --enable-accept-filter --enable-no-gifs --enable-compression --enable-strptime-sanity-checks --enable-external-filters --enable-fuzz
1994 Privoxy version 3.0.24 (http://www.privoxy.org/)
1995 Usage: ./privoxy [--config-test] [--chroot] [--help] [--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] [--version] [configfile]
1996 ./privoxy --fuzz fuzz-mode ./path/to/fuzzed/input [--stfu]
1998 Supported fuzz modes and the expected input:
1999 action: Text to parse as action file.
2000 client-request: Client request to parse. Currently incomplete
2001 client-header: Client header to parse.
2002 chunked-transfer-encoding: Chunk-encoded data to dechunk.
2003 deflate: deflate-compressed data to decompress.
2004 filter: Text to parse as filter file.
2005 gif: gif to deanimate.
2006 gzip: gzip-compressed data to decompress.
2007 pcrs-substitute: A pcrs-substitute to compile. Not a whole pcrs job! Example: Bla $1 bla C $3 blah.
2008 server-header: Server header to parse.
2009 server-response: Server response to parse.
2011 The following fuzz modes read data from stdin if the 'file' is '-'
2014 chunked-transfer-encoding
2024 $ export ASAN_OPTIONS='abort_on_error=1'
2025 $ mkdir input output
2026 $ echo '$1 bla fasel $2' > input/pcrs
2027 $ afl-fuzz -i input -o output -m none ~/git/privoxy/privoxy --fuzz pcrs-substitute - --stfu
2029 $ cat >input/pcrs.txt
2031 s@(.{1})[432](\d+)@$1$2$hostname@UgisT
2033 $ afl-fuzz -i input/ -o output/ -f bla.filter -m none privoxy --fuzz filter bla.filter --stfu
2038 <!-- ~~~~~ New section ~~~~~ -->
2039 <sect1 id="newrelease"><title>Releasing a New Version</title>
2041 When we release versions of <application>Privoxy</application>,
2042 our work leaves our cozy secret lab and has to work in the cold
2043 RealWorld[tm]. Once it is released, there is no way to call it
2044 back, so it is very important that great care is taken to ensure
2045 that everything runs fine, and not to introduce problems in the
2049 So when releasing a new version, please adhere exactly to the
2050 procedure outlined in this chapter.
2054 The following programs are required to follow this process:
2055 <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
2056 <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
2059 <sect2 id="versionnumbers">
2060 <title>Version numbers</title>
2063 First you need to determine which version number the release will have.
2064 <application>Privoxy</application> version numbers consist of three numbers,
2065 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
2070 X, the version major, is rarely ever changed. It is increased by one if
2071 turning a development branch into stable substantially changes the functionality,
2072 user interface or configuration syntax. Majors 1 and 2 were
2073 <application>Junkbuster</application>, and 3 will be the first stable
2074 <application>Privoxy</application> release.
2079 <!-- FIXME this is not the way it works anymore -->
2080 Y, the version minor, represents the branch within the major version.
2081 At any point in time, there are two branches being maintained:
2082 The stable branch, with an even minor, say, 2N, in which no functionality is
2083 being added and only bug-fixes are made, and 2N+1, the development branch, in
2084 which the further development of <application>Privoxy</application> takes
2086 This enables us to turn the code upside down and inside out, while at the same time
2087 providing and maintaining a stable version.
2088 The minor is reset to zero (and one) when the major is incremented. When a development
2089 branch has matured to the point where it can be turned into stable, the old stable branch
2090 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2091 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2096 Z, the point or sub version, represents a release of the software within a branch.
2097 It is therefore incremented immediately after each software release.
2098 <!-- FIXME this is not the way it works any more
2099 In development branches, only the even point versions correspond to actual releases,
2100 while the odd ones denote the evolving state of the sources on Git in between.
2101 It follows that Z is odd on Git in development branches most of the time. There, it gets
2102 increased to an even number immediately before a code freeze, and is increased to an odd
2103 number again immediately thereafter.
2104 This ensures that builds from Git snapshots are easily distinguished from released versions.
2105 didn't Fabian get rid of the even=stable, odd=dev convention for release numbering? -->
2106 The point version is reset to zero when the minor changes.
2109 Stable branches work a little differently, since there should be
2110 little to no development happening in such branches. Remember,
2111 only bugfixes, which presumably should have had some testing
2112 before being committed. Stable branches will then have their
2113 version reported as <literal>0.0.0</literal>, during that period
2114 between releases when changes are being added. This is to denote
2115 that this code is <emphasis>not for release</emphasis>. Then
2116 as the release nears, the version is bumped according: e.g.
2117 <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
2122 In summary, the main Git trunk is the development branch where new
2123 features are being worked on for the next stable series. This should
2124 almost always be where the most activity takes place. There is always at
2125 least one stable branch from the trunk, e.g now it is
2126 <literal>3.0</literal>, which is only used to release stable versions.
2127 Once the initial *.0 release of the stable branch has been done, then as a
2128 rule, only bugfixes that have had prior testing should be committed to
2129 the stable branch. Once there are enough bugfixes to justify a new
2130 release, the version of this branch is again incremented Example: 3.0.0
2131 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
2132 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
2133 taking place. If any questions, please post to the devel list
2134 <emphasis>before</emphasis> committing to a stable branch!
2137 Developers should remember too that if they commit a bugfix to the stable
2138 branch, this will more than likely require a separate submission to the
2139 main trunk, since these are separate development trees within Git. If you
2140 are working on both, then this would require at least two separate check
2141 outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
2142 which is <literal>v_3_0_branch</literal> at the moment).
2147 <sect2 id="beforerelease">
2148 <title>Before the Release</title>
2150 The following <emphasis>must be done by one of the
2151 developers</emphasis> prior to each new release.
2156 Make sure that everybody who has worked on the code in the last
2157 couple of days has had a chance to yell <quote>no!</quote> in case
2158 they have pending changes/fixes in their pipelines. Announce the
2159 freeze so that nobody will interfere with last minute changes.
2164 Update the code status (CODE_STATUS="xxx") in configure.in to one of
2165 "alpha", "beta" or "stable".
2170 Rebuild configure and GNUMakefile to make sure the updated values are being used.
2174 $ autoheader && autoconf # rebuild configure
2175 $ ./configure # rebuild GNUmakefile
2180 <command>make dok-release</command> to update the sgml documentation source files.
2185 If action file processing has changed and is not backward-compatible,
2186 make sure the "for-privoxy-version=x.y.z" minimum version number in
2187 default.action.master has been updated:
2191 #############################################################################
2192 #MASTER# COMMENT: The minimum Privoxy version:
2193 for-privoxy-version=3.0.11
2198 Create the change log:
2203 $ git log [last release tag]..HEAD > /tmp/log
2204 # get the commit log since the last release
2205 $ utils/makeChangeLog /tmp/log > /tmp/change.log
2206 # reformat the commit log
2209 Edit <filename>/tmp/change.log</filename> to remove trivial
2210 changes and group the changes under general headings like:
2214 - Action file improvements:
2215 - Filter file improvements:
2216 - General improvements:
2217 - Documentation improvements:
2218 - Build system improvements:
2220 - Privoxy-Log-Parser:
2221 - Privoxy-Regression-Test:
2224 Add the contents of <filename>/tmp/change.log</filename> to the
2225 start of <filename>ChangeLog</filename> and re-create
2226 <filename>doc/source/changelog.sgml</filename>:
2229 $ utils/changelog2doc.pl /tmp/change.log >| doc/source/changelog.sgml
2234 All developers should look at the <filename>ChangeLog</filename> and
2235 make sure noteworthy changes are referenced.
2240 All documentation should be rebuilt:
2248 Finished docs should be then be committed to Git (for those
2249 without the ability to build these). Some docs may require
2250 rather obscure processing tools. <filename>config</filename>,
2251 the man page (and the html version of the man page)
2252 fall in this category. README, the man page, AUTHORS, and config
2253 should all also be committed to Git for other packagers. The
2254 formal docs should be uploaded to the webserver. See the section
2255 <ulink url="webserver-update.html">"Updating the webserver"</ulink>
2256 in this manual for details.
2261 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2266 The <citetitle>User Manual</citetitle> is also used for context
2267 sensitive help for the CGI editor. This is version sensitive, so that
2268 the user will get appropriate help for his/her release. So with
2269 each release a fresh version should be uploaded to the webserver
2270 (this is in addition to the main <citetitle>User Manual</citetitle>
2271 link from the main page since we need to keep manuals for various
2272 versions available). The CGI pages will link to something like
2273 <literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. This
2274 will need to be updated for each new release. There is no Makefile
2275 target for this at this time!!! It needs to be done manually.
2280 Tag all files in Git with the version number with
2281 <quote><command>git tag v_X_Y_Z</command></quote>.
2282 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2287 On the webserver, copy the user manual to a new top-level directory
2288 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2289 pages, which have the version as a prefix, will go into the right version of the manual.
2290 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2291 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2292 <filename>.</filename> (i.e. dot).
2298 <sect2 id="therelease">
2299 <title>Building and Releasing the Packages</title>
2301 Now the individual packages can be built and released. Note that for
2302 GPL reasons the first package to be released is always the source tarball.
2306 For <emphasis>all</emphasis> types of packages, including the source tarball,
2307 <emphasis>you must make sure that you build from clean sources by exporting
2308 the right version from Git into an empty directory</emphasis> (just press return when
2309 asked for a password):
2313 mkdir dist # delete or choose different name if it already exists
2315 git clone https://www.privoxy.org/git/privoxy.git
2317 git checkout v_X_Y_Z
2321 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2322 version information after export from Git. This is to make sure that
2323 all release packages, and with them, all future bug reports, are based
2324 on exactly the same code.
2329 Every significant release of Privoxy has included at least one
2330 package that either had incorrect versions of files, missing files,
2331 or incidental leftovers from a previous build process that gave
2332 unknown numbers of users headaches to try to figure out what was
2333 wrong. PLEASE, make sure you are using pristene sources, and are
2334 following the prescribed process!
2339 Please find additional instructions for the source tarball and the
2340 individual platform dependent binary packages below. And details
2341 on the Sourceforge release process below that.
2344 <sect3 id="pack-guidelines">
2345 <title>Note on Privoxy Packaging</title>
2347 Please keep these general guidelines in mind when putting together
2348 your package. These apply to <emphasis>all</emphasis> platforms!
2353 <application>Privoxy</application> <emphasis>requires</emphasis>
2354 write access to: all <filename>*.action</filename> files, all
2355 logfiles, and the <filename>trust</filename> file. You will
2356 need to determine the best way to do this for your platform.
2361 Please include up to date documentation. At a bare minimum:
2365 <filename>LICENSE</filename> (top-level directory)
2370 <filename>README</filename> (top-level directory)
2375 <filename>AUTHORS</filename> (top-level directory)
2380 <filename>man page</filename> (top-level directory, Unix-like
2386 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2391 <filename>FAQ</filename> (doc/webserver/faq/)
2395 Also suggested: <filename>Developer Manual</filename>
2396 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2397 (top-level directory). <filename>FAQ</filename> and the manuals are
2398 HTML docs. There are also text versions in
2399 <filename>doc/text/</filename> which could conceivably also be
2403 The documentation has been designed such that the manuals are linked
2404 to each other from parallel directories, and should be packaged
2405 that way. <filename>privoxy-index.html</filename> can also be
2406 included and can serve as a focal point for docs and other links of
2407 interest (and possibly renamed to <filename>index.html</filename>).
2408 This should be one level up from the manuals. There is a link also
2409 on this page to an HTMLized version of the man page. To avoid 404 for
2410 this, it is in Git as
2411 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2412 and should be included along with the manuals. There is also a
2413 css stylesheets that can be included for better presentation:
2414 <filename>p_doc.css</filename>. This should be in the same directory
2415 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2416 the manual directories).
2421 <filename>user.action</filename> and <filename>user.filter</filename>
2422 are designed for local preferences. Make sure these do not get overwritten!
2423 <filename>config</filename> should not be overwritten either. This
2424 has especially important configuration data in it.
2425 <filename>trust</filename> should be left in tact as well.
2430 Other configuration files (<filename>default.action</filename> and
2431 <filename>default.filter</filename>) should be installed as the new
2432 defaults, but all previously installed configuration files should be
2433 preserved as backups. This is just good manners :-) These files are
2434 likely to change between releases and contain important new features
2440 Please check platform specific notes in this doc, if you haven't
2441 done <quote>Privoxy</quote> packaging before for other platform
2442 specific issues. Conversely, please add any notes that you know
2443 are important for your platform (or contact one of the doc
2444 maintainers to do this if you can't).
2449 Packagers should do a <quote>clean</quote> install of their
2450 package after building it. So any previous installs should be
2451 removed first to ensure the integrity of the newly built package.
2452 Then run the package for a while to make sure there are no
2453 obvious problems, before uploading.
2461 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2463 First, <emphasis>make sure that you have freshly exported the right
2464 version into an empty directory</emphasis>. (See "Building and releasing
2465 packages" above). Then run:
2469 autoheader && autoconf && ./configure
2478 To upload the package to Sourceforge, simply issue
2484 Go to the displayed URL and release the file publicly on Sourceforge.
2485 For the change log field, use the relevant section of the
2486 <filename>ChangeLog</filename> file.
2490 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2492 In following text, replace <replaceable class="parameter">dist</replaceable>
2493 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2496 First, <emphasis>make sure that you have freshly exported the right
2497 version into an empty directory</emphasis>. (See "Building and releasing
2501 As the only exception to not changing anything after export from Git,
2502 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2503 and make sure that the version information and the RPM release number are
2504 correct. The RPM release numbers for each version start at one. Hence it must
2505 be reset to one if this is the first RPM for
2506 <replaceable class="parameter">dist</replaceable> which is built from version
2508 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">file
2509 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2510 release number for that version plus one.
2517 autoheader && autoconf && ./configure
2523 make <replaceable class="parameter">dist</replaceable>-dist
2526 To upload the package to Sourceforge, simply issue
2529 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2532 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2533 RPM release number as determined above.
2534 Go to the displayed URL and release the file publicly on Sourceforge.
2535 Use the release notes and change log from the source tarball package.
2539 <sect3 id="newrelease-solaris"><title>Solaris</title>
2541 Login to Sourceforge's compilefarm via ssh:
2544 ssh cf.sourceforge.net
2547 Choose the right operating system (not the Debian one).
2548 When logged in, <emphasis>make sure that you have freshly exported the right
2549 version into an empty directory</emphasis>. (See "Building and releasing
2550 packages" above). Then run:
2554 autoheader && autoconf && ./configure
2563 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2564 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2565 to manually upload the archive to Sourceforge's ftp server and release
2566 the file publicly. Use the release notes and Change Log from the
2567 source tarball package.
2571 <sect3 id="NEWRELEASE-WINDOWS"><title>Windows</title>
2572 <!-- so annoying: docbook generated ids are UPPERCASE so
2573 links to "whatever.html#idtag" DO NOT WORK!!
2574 They have to be "whatever.html#IDTAG".
2575 So be consistent and use uppercase on the definition.
2578 Note that the docbook generated files might need some hand editing,
2579 so the Windows build makefile does not rebuild the docs.
2583 First, <emphasis>make sure that you have freshly exported the right
2584 version into an empty directory</emphasis>. (See "Building and releasing
2586 <!-- XXX ??? are we still basing releases off a tarball???
2590 Then you can build the package. This is fully automated, and is
2591 controlled by <filename>windows/GNUmakefile</filename>.
2592 All you need to do is:
2599 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2600 <filename>privoxy_setup_X.Y.Z.exe</filename>, and the <filename>build</filename>
2601 directory to <filename>privoxy_X.Y.Z</filename>.
2602 Create a .zip file of the newly renamed <filename>privoxy_X.Y.Z</filename> directory,
2603 GPG sign the installer and zip file,
2606 $ gpg --armor --detach --sign <filename>privoxy_setup_X.Y.Z.exe</filename>
2607 $ gpg --armor --detach --sign <filename>privoxy_X.Y.Z.zip</filename>
2610 and upload the files to SourceForge.
2614 When releasing the package on SourceForge, use the release notes
2615 and Change Log from the source tarball package.
2619 <sect3 id="newrelease-debian"><title>Debian</title>
2621 First, <emphasis>make sure that you have freshly exported the
2622 right version into an empty directory</emphasis>. (See
2623 "Building and releasing packages" above). Then add a log
2624 entry to <filename>debian/changelog</filename>, if it is not
2625 already there, for example by running:
2628 debchange -v &p-version;-&p-status;-1 "New upstream version"
2634 dpkg-buildpackage -rfakeroot -us -uc -b
2638 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2639 which can be uploaded. To upload the package to Sourceforge, simply
2647 <sect3 id="newrelease-macosx"><title>Mac OS X</title>
2649 First, <emphasis>make sure that you have freshly exported the right
2650 version into an empty directory</emphasis>. (See "Building and releasing
2654 There are three modules available in the Git repository for use on Mac
2655 OS X, though technically only two of them generate a release (the other
2656 can be used to install from source).
2658 <sect4 id="OS-X-OSXPackageBuilder-module">
2659 <title>OSXPackageBuilder module</title>
2661 The OSXPackageBuilder module generates OS X installer packages
2662 supporting all Macs running OS X 10.4 and above. Obtain it from Git as
2663 follows into a folder parallel to the exported privoxy source:
2666 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
2669 The module contains complete instructions on its usage in the file
2670 <filename>OS X Package Builder HOWTO.txt</filename>.
2673 Once the package(s) have been generated, you can then upload them
2674 directly to the Files section of the Sourceforge project in the
2675 Macintosh (OS X) folder. Each new version release of Privoxy should
2676 have a new subfolder created in which to store its files. Please
2677 ensure that the folder contains a readme file that makes it clear
2678 which package is for whichversion of OS X.
2681 <sect4 id="OS-X-osxsetup-module">
2682 <title>osxsetup module (DEPRECATED)</title>
2684 <emphasis>This module is deprecated since the installer it generates
2685 places all Privoxy files in one folder in a non-standard location, and
2686 supports only Intel Macs running OS X 10.6 or higher.</emphasis>
2689 Check out the module from Git as follows into a folder parallel to the
2690 exported privoxy source:
2693 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
2703 This will run <filename>autoheader</filename>, <filename>autoconf</filename>
2704 and <filename>configure</filename> as well as <filename>make</filename>.
2705 Finally, it will copy over the necessary files to the ./osxsetup/files
2706 directory for further processing by <filename>PackageMaker</filename>.
2709 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
2710 modify the package name to match the release, and hit the "Create
2711 package" button. If you specify ./Privoxy.pkg as the output package
2712 name, you can then create the distributable zip file with the command:
2715 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2718 You can then upload this file directly to the Files section of the
2719 Sourceforge project in the Macintosh (OS X) folder. Each new version
2720 release of Privoxy should have a new subfolder created in which to
2722 Please ensure that the folder contains a readme file that makes it
2723 clear which version(s) of OS X the package supports.
2726 <sect4 id="OS-X-macsetup-module">
2727 <title>macsetup module</title>
2729 The macsetup module is ideal if you wish to build and install Privoxy
2730 from source on a single machine.
2733 Check out the module from Git as follows into a folder parallel to the
2734 exported privoxy source:
2737 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
2740 The module contains complete instructions on its usage in its
2741 <filename>README</filename> file. The end result will be the
2742 exported version of Privoxy installed on the build machine.
2747 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2749 Update the www/privoxy port and submit a diff upstream.
2750 For details see the <ulink url="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/">FreeBSD Porter's Handbook</ulink>.
2755 <sect2 id="releasing">
2756 <title>Uploading and Releasing Your Package</title>
2758 After the package is ready, it is time to upload it
2759 to SourceForge, and go through the release steps. The upload
2765 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2770 user: <literal>anonymous</literal>
2775 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2780 Or use the <command>make</command> targets as described above.
2783 Once this done go to
2784 <ulink url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118">
2785 https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
2786 making sure you are logged in. Find your target platform in the
2787 second column, and click <literal>Add Release</literal>. You will
2788 then need to create a new release for your package, using the format
2789 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2793 Now just follow the prompts. Be sure to add any appropriate Release
2794 notes. You should see your freshly uploaded packages in
2795 <quote>Step 2. Add Files To This Release</quote>. Check the
2796 appropriate box(es). Remember at each step to hit the
2797 <quote>Refresh/Submit</quote> buttons! You should now see your
2798 file(s) listed in Step 3. Fill out the forms with the appropriate
2799 information for your platform, being sure to hit <quote>Update</quote>
2800 for each file. If anyone is monitoring your platform, check the
2801 <quote>email</quote> box at the very bottom to notify them of
2802 the new package. This should do it!
2805 If you have made errors, or need to make changes, you can go through
2806 essentially the same steps, but select <literal>Edit Release</literal>,
2807 instead of <literal>Add Release</literal>.
2811 <sect2 id="afterrelease">
2812 <title>After the Release</title>
2814 When all (or: most of the) packages have been uploaded and made available,
2815 send an email to the
2816 <ulink url="mailto:privoxy-announce@lists.privoxy.org">announce mailing
2817 list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2819 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">
2820 download location</ulink>, the release notes and the Changelog. Also, post an
2821 updated News item on the project page Sourceforge, and update the Home
2822 page and docs linked from the Home page (see below). Other news sites
2823 and release oriented sites, such as Freshmeat, should also be notified.
2826 Then update the source code for the next version to be released:
2831 Increment the version number and change the code status to "UNRELEASED"
2832 in <filename>configure.in</filename>
2837 Rebuild configure (<quote><command>autoheader && autoconf</command></quote>)
2838 and GNUMakefile (<quote><command>./configure</command></quote>)
2843 <quote><command>make dok-release</command></quote> to update the sgml documentation source files.
2848 Commit all your changes.
2857 <!-- ~~~~~ New section ~~~~~ -->
2858 <sect1 id="webserver-update"><title>Update the Webserver</title>
2860 The webserver should be updated at least with each stable release. When
2861 updating, please follow these steps to make sure that no broken links,
2862 inconsistent contents or permission problems will occur (as it has many
2863 times in the past!):
2866 If you have changed anything in the stable-branch documentation source
2873 That will generate <filename>doc/webserver/user-manual</filename>,
2874 <filename>doc/webserver/developer-manual</filename>,
2875 <filename>doc/webserver/faq</filename>,
2876 <filename>doc/webserver/index.html</filename> automatically.
2879 If you changed the manual page sources, generate
2880 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2881 by running <quote><command>make man</command></quote>. (This is
2882 a separate target due to dependencies on some obscure perl scripts
2883 [now in Git, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
2886 If you want to add new files to the webserver, create them locally in
2887 the <filename>doc/webserver/*</filename> directory (or
2888 create new directories under <filename>doc/webserver</filename>).
2891 Next, commit any changes from the above steps to Git. All set?
2892 If these are docs in the stable branch, then do:
2898 This will do the upload to <ulink url="https://www.privoxy.org/">the
2899 webserver</ulink> (www.privoxy.org) and ensure all files and directories
2900 there are group writable.
2903 Please do <emphasis>NOT</emphasis> use any other means of transferring
2904 files to the webserver to avoid permission problems. Also, please do not
2905 upload docs from development branches or versions. The publicly posted
2906 docs should be in sync with the last official release.
2912 This program is free software; you can redistribute it
2913 and/or modify it under the terms of the GNU General
2914 Public License as published by the Free Software
2915 Foundation; either version 2 of the License, or (at
2916 your option) any later version.
2918 This program is distributed in the hope that it will
2919 be useful, but WITHOUT ANY WARRANTY; without even the
2920 implied warranty of MERCHANTABILITY or FITNESS FOR A
2921 PARTICULAR PURPOSE. See the GNU General Public
2922 License for more details.
2924 The GNU General Public License should be included with
2925 this file. If not, you can view it at
2926 http://www.gnu.org/copyleft/gpl.html
2927 or write to the Free Software Foundation, Inc., 59
2928 Temple Place - Suite 330, Boston, MA 02111-1307, USA.